@commitlint/resolve-extends

What is @commitlint/resolve-extends?

@commitlint/resolve-extends is a utility package used to resolve and load shareable configurations for commitlint. Commitlint is a tool that helps enforce consistent commit message conventions. This package helps in resolving the 'extends' key in commitlint configuration files, allowing users to extend from predefined or custom configurations.

What are @commitlint/resolve-extends's main functionalities?

Resolve Shareable Configurations

This feature allows you to resolve and load shareable configurations specified in the 'extends' key of your commitlint configuration file. The code sample demonstrates how to resolve the '@commitlint/config-conventional' configuration.

const resolveExtends = require('@commitlint/resolve-extends');

async function resolveConfig() {
  const config = await resolveExtends(['@commitlint/config-conventional']);
  console.log(config);
}

resolveConfig();

Custom Configuration Resolution

This feature allows you to resolve custom configurations by specifying the path to the custom configuration file. The code sample demonstrates how to resolve a custom configuration located at './path/to/custom-config'.

const resolveExtends = require('@commitlint/resolve-extends');

async function resolveCustomConfig() {
  const config = await resolveExtends(['./path/to/custom-config']);
  console.log(config);
}

resolveCustomConfig();

Other packages similar to @commitlint/resolve-extends

eslint

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It can be extended with shareable configurations similar to commitlint. ESLint's 'extends' key allows users to extend from predefined or custom configurations, making it comparable to @commitlint/resolve-extends.

stylelint

Stylelint is a linter for CSS and other style sheet languages. It also supports shareable configurations through the 'extends' key in its configuration file. This makes it similar to @commitlint/resolve-extends in terms of resolving and loading shareable configurations.

babel

Babel is a JavaScript compiler that allows you to use next-generation JavaScript, today. Babel configurations can be extended using the 'extends' key, similar to how commitlint configurations can be extended. This makes Babel's configuration resolution mechanism comparable to @commitlint/resolve-extends.

README

The README file is missing

Changelog

11.0.0 (2020-09-05)

Bug Fixes

• cli: remove default value from edit option #2065 (3d4116d)

• rules: ignore comments in signed-off-by (#2098) (b610bcd)

• update dependency @types/fs-extra to ^9.0.1 (#2088) (cb1028e)

• refactor!: drop support for lerna v2 (59667b3)

BREAKING CHANGES

• remove lerna v2 support and tests