sn-taro-utils

简体中文 | English

针对 Taro 开发的一套 JS|TS 第三方库

⭐ 特性

• 支持ES6+或TypeScript编写源码，编译生成生产代码
• 集成 babel-runtime (默认关闭)
• 第三方依赖自动注入（自动剔除第三方依赖无用代码tree shaking）
• 多环境支持（支持浏览器原生，支持AMD，CMD，支持Webpack，Rollup，fis等，支持Node）
• 集成代码风格校验(eslint|tslint)
• 集成单元测试环境（mocha）
• 集成测试覆盖率（istanbul）
• 集成可持续构建工具travis-ci
• 支持自定义banner
• 支持一键重命名
• 支持sideEffects
• 集成ISSUE_TEMPLATE

注意: 如果不同时使用 export 与 export default 可打开 legacy模式，legacy模式 下的模块系统可以兼容 ie6-8，见rollup配置文件

💊 兼容性

单元测试保证支持如下环境：

IE	CH	FF	SF	OP	IOS	Android	Node
6+	29+	55+	9+	50+	9+	4+	4+

注意：编译代码依赖ES5环境，对于ie6-8需要引入es5-shim才可以兼容，可以查看demo/demo-global.html中的例子

🚀 使用者指南

通过npm下载安装代码

$ npm install --save sn-taro-utils

如果你是node环境

const snJsUtils = require('../dist/index.js');

如果你是webpack等环境

import { DateUtil } from 'sn-taro-utils';

如果你是requirejs环境

requirejs(['node_modules/sn-taro-utils/dist/index.aio.js'], function (snJsUtils) {
    console.log(snJsUtils.DateUtil.formatDate(new Date(), 'yyyy-MM-dd'));
})

📑 文档

API

😘 贡献者指南

首次运行需要先安装依赖

$ npm install

一键打包生成生产代码

$ npm run build

运行单元测试:

$ npm test

修改 package.json 中的版本号，修改 README.md 中的版本号，修改 CHANGELOG.md，然后发布新版

$ npm run release

将新版本发布到npm

$ npm publish

贡献者列表

contributors

⚙️ 更新日志

CHANGELOG.md

✈️ 计划列表

TODO.md

💡 谁在使用