wangtron-lint-commit

1.1.3 verified Fri May 01 auth: no javascript

A simple commit message linter that enforces conventional commit format. v1.1.3 is the latest stable release. It checks commit messages against a configurable pattern, with custom error messages. Minimal dependencies, zero-config setup. Uses local git hooks via husky or lint-staged.

Common errors

error SyntaxError: Cannot use import statement outside a module ↓

cause Husky script not using ES modules

fix

Set "type": "module" in package.json or use .mjs extension.

Warnings

gotcha Default config only enforces 'type(scope): description' format. Custom regex required for advanced rules. ↓

fix Provide custom regex option.

Install

npm install wangtron-lint-commit

yarn add wangtron-lint-commit

pnpm add wangtron-lint-commit

Imports

lintCommit

wrong

const lintCommit = require('wangtron-lint-commit')

correct

import { lintCommit } from 'wangtron-lint-commit'

Package is ESM-only since v1.1.0.

Quickstart

Shows how to use lintCommit in a Husky commit-msg hook to validate commit messages.

// .husky/commit-msg
import { lintCommit } from 'wangtron-lint-commit';
import { readFileSync } from 'fs';
const message = readFileSync(process.argv[2], 'utf8');
const { valid, error } = lintCommit(message);
if (!valid) {
  console.error(error);
  process.exit(1);
}