techor

Check your commits with Techor's commitlint config

NPM Version NPM Version NPM package ( download / month ) Follow @mastercorg Github release actions


## Getting Started Skip if you have already run `npm install techor`: ``` npm install commitlint-config-techor -D ``` ### Configuration Create a `.commitlintrc.yml` file in your project root and extend `techor`: ```yml extends: techor ``` ### Set up Husky Use Husky to register Git Hooks to automatically check whether it is legal before committing. ``` npx husky install ``` ``` npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}' ``` Check if the `.husky` is successfully generated in the project root: ```diff + └── .husky + ├─── _ + └─── commit-msg ``` From now on, you just need to commit; the check happens after the commit. If everything is legal, there will be no prompts. ### package.json Pre-commit checks via Git Hook are only enabled when other team members clone the project and run `npm install`. Save `commit-check` and `husky install` commands for teamwork and CI: ```json { "scripts": { "install": "husky install", "commit-check": "commitlint --from=HEAD~1 --verbose" } } ``` `pnpm run commit-check`: commit-check ## Continuous Integration Typically, you double-check commits before publishing and on relevant workflows, using GitHub Actions as an example: [Create a workflow](https://docs.github.com/en/actions/quickstart) for commit check `/.github/workflows/commit-check.yml`: ```yml name: Commit Check on: push: branches: - '**' pull_request_target: types: - opened - reopened - edited - synchronize jobs: check: timeout-minutes: 15 runs-on: ubuntu-latest strategy: matrix: node-version: [20] steps: - uses: actions/checkout@v4 with: fetch-depth: 0 - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} cache: 'npm' - run: npm ci - run: pnpm run commit-check ``` ## Commit Header Format The header has a particular format that includes a `Type`, a `Target`, and a `Summary`: ``` Type(Target): Summary ┊ ┊ ┊ └─⫸ Target: Workspace, Package or Role ┊ └─⫸ Type: Bump, Feat, New, Perf, Add, Update, Improve, Fix, Deprecate, Drop, Docs, Upgrade, Revert, Example, Test, Refactor, Chore, Misc ``` For the full documentation, check out the [Techor's conventional commits](https://github.com/techor-dev/techor/tree/main/packages/conventional-commits)
NPM Version