fm-utils

Followme 前端团队通用 JavaScript 工具库

安装

$ yarn add @fmfe/fm-utils

使用

文档地址：https://fmfe.github.io/fm-utils/

自动化脚本

命令	描述信息
npm run lint	eslint 检查
npm run lint:fix	eslint 修复
npm run doc	更新本地文档
npm run doc:server	启动本地文档服务器
npm run test	运行单元测试
npm run test:coverage	查看测试覆盖率报告
npm run changelog	更新 CHANGELOG 文件
npm run release	发布 npm 模块

发布 npm 模块

递增版本号：

npm version patch   发布补丁
npm version minor   发布小版本
npm version major   发布主版本

发布组织模块：

$ npm publish --access public

贡献指南

代码规范

• 代码风格遵循该规范：fmfe/eslint-config-fmfe-nodejs
• 新增内容需要提供完善的文档（关于 jsdoc）
• 新增内容需要编写单元测试，并且测试覆盖率至少达到 90% 以上

提交规范

• git commit message 必须符合 AngularJS Git Commit Message Conventions 规范
• 安装 Commitizen 工具：npm install -g commitizen
• 提交代码时使用 git cz 替代 git commit

License

This repo is released under the MIT License.