@coinagerie/cli

Keep a glossary of the words your codebase uses.

npm install --save-dev @coinagerie/cli

npx @coinagerie/cli

Usage

coinagerie lists the words a codebase uses — every identifier, object key, enum member, folder name, and file name, split into lowercase words — and keeps a markdown glossary of them in step with the code.

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

Without --config, a coinagerie.config.ts in the working directory is used when there is one, and defaults apply when there is not. The folder the configuration file sits in is the root the run scans:

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

Every .gitignore git would honor is honored, and the files a run writes are never scanned. A glossary block that cannot be fully parsed is never written.

Start

nx run coinagerie-cli:start

Test

nx run coinagerie-cli:vitest

👔 Conformetry

This project was generated from the nestjs-command-project conformetry template.