conventional-commit-types

What is conventional-commit-types?

The conventional-commit-types npm package provides a standardized set of commit types for use in conventional commits. This helps in maintaining a consistent commit history, which is useful for automated versioning and changelog generation.

What are conventional-commit-types's main functionalities?

List Commit Types

This feature allows you to list all the conventional commit types available in the package. The code sample demonstrates how to import the package and log the available commit types.

const commitTypes = require('conventional-commit-types');
console.log(commitTypes.types);

Get Commit Type Description

This feature allows you to get the description of a specific commit type. The code sample shows how to retrieve the description for the 'feat' commit type.

const commitTypes = require('conventional-commit-types');
console.log(commitTypes.types['feat'].description);

Other packages similar to conventional-commit-types

commitizen

Commitizen is a tool that helps you write conventional commits by providing an interactive prompt. It ensures that your commit messages are formatted correctly according to the conventional commit guidelines. Unlike conventional-commit-types, which provides a list of commit types, Commitizen focuses on the commit message creation process.

cz-conventional-changelog

cz-conventional-changelog is an adapter for Commitizen that specifically enforces conventional commit messages. It provides a guided prompt to help you write commit messages that follow the conventional commit format. This package is more focused on the user interaction aspect compared to conventional-commit-types, which is more about providing a list of commit types.

standard-version

standard-version is a tool that automates versioning and changelog generation based on conventional commit messages. It reads your commit history and updates your package version and changelog accordingly. While conventional-commit-types provides the types of commits you can use, standard-version leverages those commit messages to automate versioning and changelog updates.

README

conventional-commit-types

List of conventional commit types.

Spec

Exports an object with a types key whose value is an object whose keys are type names and whose values are objects with key-value pairs such as description as string, optional title as string, etc. See index.json. Any alternatives should follow the same spec.

Etc.

Used by commitizen/cz-conventional-changelog for commitizen/cz-cli.

Can be used with kentcdodds/validate-commit-msg.

Commit types originally from:

• Angular Git Commit Message Conventions
• commitizen/cz-conventional-changelog

Created for AndersDJohnson/conventional-commit-types-cli.