conventional-changelog-config-spec
Advanced tools
a spec describing the config options supported by conventional-config for upstream tooling
The conventional-changelog-config-spec npm package provides a specification for configuring conventional changelog tools. It helps standardize the configuration options for generating changelogs based on conventional commit messages.
Define Configuration Schema
This feature allows you to define a JSON schema for the configuration of conventional changelog tools. The schema includes properties like 'types', which is an array of objects specifying the type of commit, the section it belongs to, and whether it should be hidden.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Conventional Changelog Config",
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": { "type": "string" },
"section": { "type": "string" },
"hidden": { "type": "boolean" }
},
"required": ["type", "section"]
}
}
},
"required": ["types"]
}Validate Configuration
This feature allows you to validate a configuration object against the defined schema using a JSON schema validator like Ajv. It ensures that the configuration adheres to the specified structure and required fields.
const Ajv = require('ajv');
const ajv = new Ajv();
const schema = require('conventional-changelog-config-spec');
const validate = ajv.compile(schema);
const config = {
types: [
{ type: 'feat', section: 'Features' },
{ type: 'fix', section: 'Bug Fixes' }
]
};
const valid = validate(config);
if (!valid) console.log(validate.errors);The conventional-changelog package generates a changelog from git metadata following the Conventional Commits specification. It is more focused on the actual generation of changelogs rather than defining a configuration schema.
The standard-version package automates versioning and changelog generation based on conventional commit messages. It provides a higher-level abstraction that includes version bumping, changelog generation, and git tagging.
Commitizen helps you write commit messages that follow the Conventional Commits specification. It provides a command-line interface for crafting commit messages, ensuring they adhere to the defined standards.
FAQs
a spec describing the config options supported by conventional-config for upstream tooling
The npm package conventional-changelog-config-spec receives a total of 442,144 weekly downloads. As such, conventional-changelog-config-spec popularity was classified as popular.
We found that conventional-changelog-config-spec demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.