@commitlint/format
Advanced tools
Package description
@commitlint/format is a package used to format commit messages according to specified rules. It is part of the commitlint suite, which helps enforce consistent commit message conventions.
Format Commit Messages
This feature allows you to format the results of commit message linting. The `format` function takes an object with a `results` array and returns a formatted string that can be logged or displayed.
const { format } = require('@commitlint/format');
const results = [
{ valid: true, errors: [], warnings: [] },
{ valid: false, errors: [{ message: 'type may not be empty' }], warnings: [] }
];
const output = format({ results });
console.log(output);Commitizen is a tool that helps you write consistent commit messages by providing an interactive prompt. Unlike @commitlint/format, which focuses on formatting and linting commit messages, Commitizen guides you through the process of writing them.
Conventional Changelog is a tool that generates changelogs based on commit messages that follow a specific convention. While @commitlint/format is used for formatting commit messages, Conventional Changelog focuses on generating changelogs from those messages.
Semantic Release automates the versioning and package publishing process based on commit messages. It uses commit message conventions to determine the type of release. Unlike @commitlint/format, which is used for formatting commit messages, Semantic Release automates the release process.
Changelog
Readme
Format commitlint reports
npm install --save @commitlint/format
const format = require('@commitlint/format');
format({
warnings: [
{
level: 0,
name: 'some-hint',
message: 'This will not show up as it has level 0'
},
{
level: 1,
name: 'some-warning',
message: 'This will show up yellow as it has level 1'
}
],
errors: [
{
level: 2,
name: 'some-error',
message: 'This will show up red as it has level 2'
}
]
}, {
color: false
});
/* => [
'✖ This will show up red as it has level 2 [some-error]',
' This will not show up as it has level 0 [some-hint]',
'⚠ This will show up yellow as it has level 1 [some-warning]',
'✖ found 1 problems, 2 warnings'
] */
Consult docs/api for comprehensive documentation.
FAQs
Format commitlint reports
The npm package @commitlint/format receives a total of 2,251,927 weekly downloads. As such, @commitlint/format popularity was classified as popular.
We found that @commitlint/format 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.
Security News
Deno's Standard Library has stabilized after four years of development, offering developers a collection of well-maintained tools compatible with Deno, Node.js, Cloudflare Workers, and browsers with bundlers.
Security News
Trivial packages, while convenient, can introduce significant risks such as dependency bloat, security vulnerabilities, and performance issues in modern software projects.
Security News
PyPI has drastically improved its malware response times, resolving 90% of issues in under 24 hours and removing 900 projects since March 2024.