Skip to content

zhouhuafei/npm-publish-ts

Repository files navigation

分支说明

  • build-ts-use-ttypescript:使用ttsc生成类型声明文件,使用ttsc生成js。
    • 此乃最初的默认分支,其他分支皆基于此分支修改而来。
    • ts官方建议用tsc生成类型声明文件,用babel生成js。
  • build-ts-use-babel:使用ttsc生成类型声明文件,使用babel生成js。
    • 遵从官方建议,使用babel生成js。
    • 但是babel仅能用来处理ts和js类型的文件,无法用来处理其他类型的文件。
    • 为了寻求更多的可能性,我引入了gulp。
  • build-ts-use-gulp-typescript:使用ttsc生成类型声明文件,使用gulp-typescript生成js。
    • 使用gulp-typescript生成js的速度太慢了。
    • 所以我把gulp-typescript更换成了gulp-babel。
  • build-ts-use-gulp-babel:使用ttsc生成类型声明文件,使用gulp-babel生成js。
    • 此乃现在的默认分支。
    • 此分支后续会继续维护,其他分支,停止维护。

把ts打包成js

  • 把ts打包成js需要使用gulp命令。
  • 使用gulp命令需要gulp-cli包和gulp包和gulp-babel包和@babel/preset-env包(含@babel/core包和@babel/plugin-transform-modules-commonjs包)和@babel/plugin-transform-typescript包和gulpfile.ts配置文件。

配置alias

  • 配置alias需要babel-plugin-module-resolver包和typescript-transform-paths包。

使用ts写jest

  • 使用ts写jest需要ts-jest包和jest.config.ts配置文件。
  • jest命令识别alias需要在jest.config.ts中配置moduleNameMapper

删除dist目录

  • 删除dist目录需要del包。

直接运行ts

  • 直接运行ts需要ts-node包。
  • ts-node命令识别alias需要tsconfig-paths包。

限制git commit格式

  • 限制git commit格式需要husky包和@commitlint/config-conventional包和commitlint.config.js配置文件和commit-msg脚本文件。

使用git cz取代git commit

  • 使用git cz取代git commit只需npm i -g git-cz即可。

使用eslint检测ts

  • 使用eslint检测ts需要eslint包和@typescript-eslint/eslint-plugin包和.eslintrc.js配置文件。
  • 使用standard规范需要eslint-config-standard包。

对暂存区的git文件进行fix

  • 对暂存区的git文件进行fix需要husky包和lint-staged包和lint-staged.config.js配置文件和pre-commit脚本文件。

使用conventional-changelog命令生成CHANGELOG.md文件

  • 使用conventional-changelog命令生成CHANGELOG.md文件需要conventional-changelog-cli包。

初始化内容:npx conventional-changelog -p angular -i CHANGELOG.md -s -r 0

  • 不仅可在git打tag之后使用(会生成全部tag的feat和fix)。
    • 操作时需要先对package.json的version字段进行自增,然后打tag,最后运行上述命令。
  • 也可以在git打tag之前使用(会生成自上次tag后的feat和fix)。
    • 操作时需要先对package.json的version字段进行自增,然后运行上述命令,最后打tag。

追加新内容:npx conventional-changelog -p angular -i CHANGELOG.md -s

  • 只可以在git打tag之前使用(会生成自上次tag后的feat和fix)。
    • 操作时需要先对package.json的version字段进行自增,然后运行上述命令,最后打tag。

注意事项:git的tag需要是v开头的格式。

  • 例:git tag v2.0.0 -m "标签的注释"

最佳实践:保持版本号的一致性。

  • 例:如果package.json的version字段是2.0.0,那么git打tag时就要打成v2.0.0

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published