voxmachina-commitlint-config

Overview

This repository serves a Node.js Package that extends the base @commitlint/config-conventional commitlint configuration to customize it with a set of Vox Machina rules. It can be used standalone, through the commitlint CLI, or as part of a git pre-commit hook through the use of voxmachina-pre-commit-hooks

Standalone Usage

# Test Full Conventional Commit Header w/ Breaking Change Indicator
echo 'feat(scope)!: commit message text' | commitlint -g ./index.js

# Test Single JIRA ID + Full Conventional Commit Header
echo 'VM-111 | feat(scope): commit message text' | commitlint -g ./index.js

# Test Multiple JIRA IDs + Full Conventional Commit Header
echo 'VM-111, VM-222 | feat(scope): commit message text' | commitlint -g ./index.js

Vox Machina Pre-Commit Hooks Usage

# .pre-commit-config.yaml

default_install_hook_types: [pre-commit, commit-msg]
default_stages: [commit, manual]
repos:
  - repo: [e-mail]:voxmachinaio/voxmachina-pre-commit-hooks.git
    rev: v1.4.0
    hooks:
      - id: use-voxmachina-commits
        stages: [commit-msg]