Skip to content

winjs-dev/cloud-utils

Repository files navigation

license Build Status npm NPM downloads Coverage Status Percentage of issues still open

常用的 Javascript 工具类方法集合

目录介绍

.
├── example 使用example
├── dist 编译产出代码
├── docs 项目文档
├── src 源代码目录
├── test 单元测试
├── CHANGELOG.md 变更日志

如何使用

通过 npm 下载安装代码

$ npm install --save @winner-fed/cloud-utils

如果你是 node 环境

var { formatDate } = require('@winner-fed/dist/cloud-utils.common');

如果你是 webpack 等环境

import { formatDate } from '@winner-fed/dist/cloud-utils.esm';

如果你是 requirejs 环境

requirejs(['node_modules/@winner-fed/cloud-utils/dist/cloud-utils.js'], function (utils) {
    var formatDate = utils.formatDate;
})

如果你是浏览器环境

<script src="node_modules/@winner-fed/cloud-utils/dist/cloud-utils.min.js"></script>

<script>
    var utils = window['cloud-utils'];
</script>

文档

API

贡献指南

首次运行需要先安装依赖

$ npm install

开发调试(利用 rollup-watch ,自动监测源码变更,生成 dist/cloud-utils.js) ,在 src/core 添加相应的 **.js 文件,然后在 src/main.js 引用

$ npm run dev

添加测试用例

src/test 添加相应的测试用例文件, 命名遵循于 **.spec.js 规范

一键打包生成生产代码

$ npm run build

运行单元测试,浏览器环境需要手动测试,位于test/browser

$ npm test

修改 package.json 中的版本号,然后发布新版

$ npm run release