@coinagerie/ cli (英语)

保存您代码库使用的词汇表 .

npm install --save-dev @coinagerie/cli

npx @coinagerie/cli

使用量

coinagerie 列出一个代码库所用的单词——每个标识符,对象密钥, enum 成员、文件夹名称和文件名称, 拆分成小写字—— 并保留 与代码同步的缩放词汇表.

coinagerie                       # print the glossary block, write nothing
coinagerie --check               # exit 1 naming missing and stale words
coinagerie --write               # rewrite every glossary, keeping definitions
coinagerie --config path/to/coinagerie.config.ts --check

无 --config页:1 coinagerie.config.ts 在工作目录中使用 如果有,则适用默认。 文件夹 配置文件是运行扫描的根 :

export default {
  exclude: { paths: ["**/*.test.ts"] },
  include: ["src/**"],
  outputs: [
    { description: "Words this project uses.", path: "README.md", type: "markdown" },
  ],
};

每个 .gitignore 荣誉是荣耀, 和档案运行写 从来没有扫描。 无法完整解析的词汇块永远不会被写入 .

开始

nx run coinagerie-cli:start

测试

nx run coinagerie-cli:vitest

* 调和

这个项目源于 巢js - 命令 - 项目 符合模板.