Sign In

@deepracticex/commitlint-config

Package Overview
Dependencies
Maintainers
2
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@deepracticex/commitlint-config

Shared commitlint configuration for Deepractice projects

latest
Source
npmnpm
Version
0.0.1
Version published
Weekly downloads
4
Maintainers
2
Weekly downloads
 
Created
Source

@deepracticex/commitlint-config

Shared commitlint configuration for Deepractice projects following Conventional Commits.

Installation

pnpm add -D @deepracticex/commitlint-config @commitlint/cli

Usage

Create commitlint.config.js in your project root:

export default {
  extends: ["@deepracticex/commitlint-config"],
};

Commit Message Format

<type>(<scope>): <subject>

<body>

<footer>

Type

Must be one of:

  • feat - New feature
  • fix - Bug fix
  • docs - Documentation changes
  • style - Code style changes (formatting, missing semicolons, etc)
  • refactor - Code refactoring (neither fixes a bug nor adds a feature)
  • perf - Performance improvements
  • test - Adding or updating tests
  • build - Build system or external dependencies (webpack, npm, etc)
  • ci - CI/CD changes (GitHub Actions, etc)
  • chore - Other changes that don't modify src or test files
  • revert - Revert a previous commit

Scope (Optional)

The scope should be the name of the package or area affected:

  • error-handling
  • logger
  • eslint-config
  • typescript-config
  • etc.

Subject

  • Use imperative, present tense: "change" not "changed" nor "changes"
  • Don't capitalize first letter
  • No period (.) at the end
  • Max 100 characters

Body (Optional)

  • Use imperative, present tense
  • Include motivation for the change and contrast with previous behavior
  • Max 200 characters per line
  • Reference issues: Fixes #123, Closes #456
  • Breaking changes: BREAKING CHANGE: <description>
  • Max 200 characters per line

Examples

Simple commit

feat: add user authentication

With scope

fix(logger): resolve file rotation issue

With body

refactor(error-handling): simplify error factory API

Remove redundant error creation methods and consolidate into a single
factory function for better maintainability.

With breaking change

feat(eslint-config): upgrade to ESLint 9

BREAKING CHANGE: Requires ESLint 9.0.0 or higher. Update your ESLint
dependency before upgrading this package.

With issue reference

fix(logger): prevent memory leak in file transport

Fixes #42

Integration with Lefthook

Add to your lefthook.yml:

commit-msg:
  commands:
    commitlint:
      run: npx commitlint --edit {1}

Integration with Changesets

Commitlint works seamlessly with changesets. After your commit passes validation, run:

pnpm changeset

Rules

This config extends @commitlint/config-conventional with the following customizations:

  • Subject case: Flexible (allows any case)
  • Subject max length: 100 characters
  • Body max line length: 200 characters
  • Footer max line length: 200 characters

License

MIT

Keywords

commitlint

FAQs

Package last updated on 09 Oct 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts