/merge-pkgm

把代码风格向pkgm合并

Primary LanguageTypeScriptMIT LicenseMIT

将代码风格向 pkgm 靠拢

安装方法(暂时未发布)

yarn add @bfchain/migrate -g

或者

git clone

git install 

git run build

npm link

不想安装(暂时未发布)

npx migrate

支持的命令

该命令将监听整个项目，动态协助您迁移到pkgm风格，类似ESLint。

该命令通过判断lerna.json来确定是bfsp还是bfsw项目。

migrate doctor

migrate会自动输出新目录，默认文件名为pkgm,您可以在像以下这样自定义文件名

migrate doctor customizeFolder

doctor

当您需要把不匹配规则的文件记录下来的时候，这个命令能让您自定义创建文件名（格式为markdown）

migrate -f <fileName>

指定输出的目录的文件夹名称，不指定也会创建,默认文件夹名称为pkgm

migrate -F [customizeFolder]

判定规则

规则按级别划分为 禁止/警告/建议

  1. 警告：判断是否有*@types.ts 类型文件 : 相对应pkgm的代码风格，就是*.type.ts 属于类型文件

  2. 警告：判断是否有/..+.ts$/（.node.ts|.web.ts）文件: .node.ts 或者 .web.ts类型应该定义为*#node.ts 与*#web.ts

  3. 禁止：判断@type文件是否有 import 这样的语法: @types.ts 这种文件，只用来declare，不可以出现import from

  4. 建议：判断是否有 index.ts 不是入口文件直接写 function

  5. 禁止: import mod from '#mod' 这种以#开头导入的文件为pkgm语法，未迁移的项目不允许出现

  6. 禁止: #开头是pkgm私有导入的写法，所以不允许在旧项目出现文件名带#

  7. 警告：*.test.ts在bfsp中属于测试文件

单元测试

运行以下命令，因为包含一个交互命令，会提示按回车😁

yarn run test