@commitlint/is-ignored
Advanced tools
Package description
The @commitlint/is-ignored npm package is designed to check if a given commit message should be ignored based on the rules defined in commitlint. This is particularly useful in automating the process of commit message validation, allowing developers to filter out commit messages that do not require validation according to the specified criteria.
Check if a commit message is ignored
This feature allows you to check if a specific commit message should be ignored based on the commitlint configuration. It's useful for integrating with tools that automate commit message validation, enabling you to skip certain types of commits, such as those starting with 'chore:', 'docs:', or any other patterns you define in your commitlint configuration.
const isIgnored = require('@commitlint/is-ignored').default;
const commitMessage = 'chore: update dependencies';
const shouldIgnore = isIgnored(commitMessage);
console.log(shouldIgnore); // Output: true or false depending on the rulescommitlint is a broader package that includes the functionality of @commitlint/is-ignored as part of its suite for linting commit messages. It provides a CLI and configurable rules for validating commit messages, whereas @commitlint/is-ignored focuses solely on determining if a commit message should be ignored.
conventional-changelog is a set of tools for parsing and generating changelogs from git metadata, based on the conventions used in commit messages. While it focuses more on changelog generation from commit messages, it shares the concept of analyzing commit messages, similar to what @commitlint/is-ignored does for determining if a commit should be ignored.
Changelog
18.0.0 (2023-10-20)
drop node v14 and v16 support
chore: remove unused types
docs: prepare node update and new release
chore!: minimum TS version v5
drop TS v4 support
ci: remove node v14/16 checks
chore: adjust node types to minimal supported version
chore!: further major versions of other deps
upgrade conventional-changelog-conventionalcommits, conventional-commits-parser, conventional-changelog-atom,
docs: simplify releases and remove roadmap
FAQs
Lint your commit messages
The npm package @commitlint/is-ignored receives a total of 2,278,267 weekly downloads. As such, @commitlint/is-ignored popularity was classified as popular.
We found that @commitlint/is-ignored demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.