npmpkg-start-react

a React NPM package starter

为了简化老哥们的生产npm包的复杂程度 提供了一个小框架 打包工具使用bili 还有相应的代码规范规则以及代码提交规范

Installation

$ npm i
$ yarn 

用法

1. 修改package.json name，author，main，description，keywords改为你需要写入的信息 main 为打包出来的文件路口

2. 修改bill.config.js 修改input 打包入口文件路径 src/xxxx.jsx 为你的文件名字，假如你的组件叫Websocket则改为src/Websocket.jsx
   修改moduleName 模块名字 xxxx 为你的文件模块名字 例如：moduleName: 'Websocket'
extractCSS 为打包出来的js文件是否要包含css也就是不单独派生出css文件
   babel 这边默认已经配置了jsx语法 如果有自己的需求可以打开 babelrc: true, 自己添加.babelrc文件编写自己的所需

3. README.md文件写入自己的组件介绍以及LICENSE文件替换

4. 书写规范的.editorconfig 代码规范的.prettierrc以及.eslintrc文件可以根据自己的项目需要自己修改 这些都需要vs code或者你使用的编辑器下载相关的插件才会生效

5. yarn build 执行代码编译打包生成dist文件夹以及代码源文件

6. 代码编写完git上传时commit 填写规则type(path): xxxx type 必须为其中之一[build, chore, ci, docs, feat, fix, improvement, perf, refactor, revert, style, test] path为修改文件的路径例如src，package之类 xxxx 为本次修改提交

7. 默认你已经注册过npm账号 在发布前最好去npm里输入自己要发布的包名检查下是否已有相同的包 npm的包名都是唯一的 在终端执行npm publish命令即可推送npm包(注意package.json的version 版本号)
   大部分的publish失败都是包名重复
   小修改小补丁已经bugfix可以使用npm version patch && npm publish或相应脚本的代码npm run release:patch
   小升级使用npm version minor && npm publish或npm run release:minor
   大升级使用npm version major && npm publish或npm run release:major