@astral/commitlint-config

@astral/commitlint-config

Usage

Installation

Npm

npm i commitlint @astral/commitlint-config --save-dev 

Yarn

yarn add commitlint @astral/commitlint-config -D

Configuration

commitlint.config.js

const { createConfig } = require('@astral/commitlint-config');

module.exports = createConfig({
  scopes: ['ui', 'server'],
  ticketPrefix: 'UIKIT',
});

.huskyrc

{
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}

Message example

Valid

feat(UIKIT-222,ui): Title feat: Title feat(UIKIT-222): Title

Invalid

feat(UIKIT222): Title feat(unknown): Title

Format

${ENUM}(SCOPE|TASK): Description

Default ENUM:

• feat - добавлена новая фича. Можно связать с релизом minor версии
• bug - исправлена ошибка. Можно связать с релизом patch версии
• wip (work in progress) - промежуточные изменения
• refactor - произведен рефакторинг. Можно связать с релизом patch версии
• doc - внесены изменения в .md файлы или storybook.
• build - внесены изменения в сборке пакетов. Можно связать с релизом patch версии
• chore - внесены изменения в настройку окружения проекта (линтеры, ci...).
• revert - удалены ранее внесенные изменения
• style - написаны или изменены стили проекта
• test - написаны или изменены тесты проекта
• major - breaking changes. Полезен для пакетов. Можно связать с релизом major версии

API

createConfig

const { createConfig } = require('@astral/commitlint-config');

type Params = {
  /**
   * Список доступных scopes.
   * @example
   * // createConfig({ scopes: ['server', 'ui'], ticketPrefix: 'UIKIT' })
   */
  scopes?: string[];
  /**
   * Название префикса задач, данный префикс будет доступен в scope.
   * @example
   * // createConfig({ ticketPrefix: 'UIKIT' })
   */
  ticketPrefix: string;
  /**
   * Список доступных type. Дефолтное значение указано в разделе Format
   * @example
   * // createConfig({ typeEnum: ['feat', 'ci'], ticketPrefix: 'UIKIT',  })
   */
  typeEnum?: string[];
};
  
createConfig(params: Params);