conventional-commits-filter

What is conventional-commits-filter?

The conventional-commits-filter npm package is used to filter out commit messages that do not follow the Conventional Commits specification. This is useful in projects that enforce a specific commit message format for better readability, automation, and tooling.

What are conventional-commits-filter's main functionalities?

Filtering valid commits

This feature allows you to filter out commits that do not follow the Conventional Commits specification. In the example, only the commits with headers 'feat: add new feature' and 'fix: fix bug' will be considered valid.

const filter = require('conventional-commits-filter');
const commits = [
  { header: 'feat: add new feature' },
  { header: 'fix: fix bug' },
  { header: 'invalid commit message' }
];
const validCommits = filter(commits);
console.log(validCommits);

Filtering invalid commits

This feature allows you to filter out valid commits and only keep the invalid ones. In the example, only the commit with the header 'invalid commit message' will be considered invalid.

const filter = require('conventional-commits-filter');
const commits = [
  { header: 'feat: add new feature' },
  { header: 'fix: fix bug' },
  { header: 'invalid commit message' }
];
const invalidCommits = filter(commits, { ignore: true });
console.log(invalidCommits);

Other packages similar to conventional-commits-filter

commitlint

commitlint checks if your commit messages meet the Conventional Commits format. It is more comprehensive than conventional-commits-filter as it provides linting capabilities and can be integrated into CI/CD pipelines.

conventional-changelog

conventional-changelog is used to generate changelogs based on commit messages that follow the Conventional Commits specification. While it does not filter commits, it complements conventional-commits-filter by providing a way to generate meaningful changelogs.

validate-commit-msg

validate-commit-msg is a tool to validate commit messages against a set of rules, including the Conventional Commits specification. It is similar to conventional-commits-filter but focuses more on validation rather than filtering.

README

conventional-commits-filter

Filter out reverted commits parsed by conventional-commits-parser

Install

$ npm install --save conventional-commits-filter

Usage

var conventionalCommitsFilter = require('conventional-commits-filter');

var commits = [{
  type: 'revert',
  scope: null,
  subject: 'feat(): amazing new module',
  header: 'revert: feat(): amazing new module\n',
  body: 'This reverts commit 56185b7356766d2b30cfa2406b257080272e0b7a.\n',
  footer: null,
  notes: [],
  references: [],
  revert: {
    header: 'feat(): amazing new module',
    hash: '56185b7356766d2b30cfa2406b257080272e0b7a'
  },
  hash: '789d898b5f8422d7f65cc25135af2c1a95a125ac\n'
}, {
  type: 'feat',
  scope: null,
  subject: 'amazing new module',
  header: 'feat(): amazing new module\n',
  body: null,
  footer: 'BREAKING CHANGE: Not backward compatible.\n',
  notes: [],
  references: [],
  revert: null,
  hash: '56185b7356766d2b30cfa2406b257080272e0b7a\n'
}, {
  type: 'feat',
  scope: null,
  subject: 'new feature',
  header: 'feat(): new feature\n',
  body: null,
  footer: null,
  notes: [],
  references: [],
  revert: null,
  hash: '815a3f0717bf1dfce007bd076420c609504edcf3\n'
}, {
  type: 'chore',
  scope: null,
  subject: 'first commit',
  header: 'chore: first commit\n',
  body: null,
  footer: null,
  notes: [],
  references: [],
  revert: null,
  hash: '74a3e4d6d25dee2c0d6483a0a3887417728cbe0a\n'
}];

commits = conventionalCommitsFilter(commits);
console.log(commits);
/*=>
[{
  type: 'feat',
  scope: null,
  subject: 'new feature',
  header: 'feat(): new feature\n',
  body: null,
  footer: null,
  notes: [],
  references: [],
  revert: null,
  hash: '815a3f0717bf1dfce007bd076420c609504edcf3\n'
}, {
  type: 'chore',
  scope: null,
  subject: 'first commit',
  header: 'chore: first commit\n',
  body: null,
  footer: null,
  notes: [],
  references: [],
  revert: null,
  hash: '74a3e4d6d25dee2c0d6483a0a3887417728cbe0a\n'
}]
*/

License

MIT © Steve Mao