如何写出一个优秀的开源库

Transcript

1. ⻁⽛ 2020-11-27 如何写出⼀个优秀的开源库 $ npx create-nice-lib
2. # 优秀？
3. 完整、严谨、规范、⾃动化 优秀 - 标准 优秀 = 信任
4. 优秀 - 徽章 优秀 = 信任 = 点亮徽章
5. # 初始化
6. 初始化 - init & npm init
7. 初始化 - license
8. 初始化 - license React BSD Lisence ⻛波
9. 初始化 - license DEF License 检查
10. 初始化 - eslint $ npm i eslint --save-dev $ npx eslint --init "scripts": { "eslint": "eslint src/** --fix" }
11. 初始化 - scripts https://docs.npmjs.com/cli/v6/using-npm/scripts https://www.ruanyifeng.com/blog/2016/10/npm_scripts.html
12. # 构建
13. 构建 - 产物 • lib: commonjs => mai n • esm: esmodule => modul e • dist: umd? => browser? https://unpkg.alibaba-inc.com/browse/5minutes2weekend@3.0.1/dist/index.umd.js
14. 构建 - ⼯具 • lib: commonjs => babe l • esm: esmodule => babe l • dist: umd => rollup/webpack https://www.rollupjs.com/guide/tools/#babel
15. # 测试
16. 测试 - ⼯具 https://medium.com/@ollelauribostr/start-measuring-coverage-with-jest-travis-ci-and-coveralls-1867928aca42 https://efe.baidu.com/blog/front-end-continuous-integration-tools/
17. 测试 - 测试⽤例 import add from '../src/add' ; test('add: 1 + 2 = 3',() => { expect(add(1, 2)).toBe(3) ; }) ; https://jestjs.io/docs/zh-Hans/getting-started
18. 测试 - 覆盖率
19. 测试 - 持续集成 https://travis-ci.com/
20. 测试 - 覆盖率 https://coveralls.io/
21. # 提交
22. 提交 - 规范 https://www.conventionalcommits.org/zh-hans/v1.0.0-beta.4/ conventionalcommits
23. 提交 - 校验 https://www.npmjs.com/package/@commitlint/cli @commitlint/cli
24. 提交 - ⼯具 https://www.npmjs.com/package/commitizen commitizen
25. # 发布
26. 发布 - changelog & version standard-version https://www.npmjs.com/package/standard-version
27. 发布 - github release https://www.npmjs.com/package/conventional-github-releaser conventional-github-releaser
28. 发布 - npm beta
29. 发布 - 徽章 https://shields.io/
30. 发布 - readme/demo/site https://d.umijs.org/zh-CN
31. The End. $ npx create-nice-lib