@commitlint/parse
Advanced tools
Package description
The @commitlint/parse package is used to parse commit messages according to the conventions used by commitlint. It takes a raw commit message string and returns a promise that resolves to an object representing the parsed commit, which includes information such as the header, type, scope, subject, body, footer, and references. This package is typically used in the context of commit message linting to ensure that commit messages follow a certain format.
Parsing commit messages
This feature allows you to parse a commit message and obtain an object with structured information about the commit. The code sample demonstrates how to use the parse function to parse a commit message and log the result.
const parse = require('@commitlint/parse');
const message = 'feat(scope): add new feature';
parse(message).then(commit => {
console.log(commit);
});This package is similar to @commitlint/parse as it provides functionality to parse conventional commit messages. It can be used to extract metadata from commit messages following the Conventional Commits specification. It differs in its API and may offer different customization options.
commit-parser is another package that parses commit messages. It aims to offer a simple and lightweight solution for parsing commit messages into an object with predefined properties. It may have a different set of features and customization capabilities compared to @commitlint/parse.
Changelog
7.5.0 (2019-01-31)
sentence-case allow upper-case characters in first word (#531) (5a6a4a8), closes #211<a name="7.4.0"></a>
Readme
Parse commit messages to structured data
npm install --save @commitlint/parse
const parse = require('@commitlint/parse');
sync of conventional-commits-parserparser
{
commentChar: null, // character indicating comment lines
issuePrefixes: ['#'] // prefix characters for issue references
}
FAQs
Lint your commit messages
The npm package @commitlint/parse receives a total of 1,753,733 weekly downloads. As such, @commitlint/parse popularity was classified as popular.
We found that @commitlint/parse 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
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.