UBIC Commitlint Config

Стандартная конфигурация Commitlint для проектов.

Покрывает все стандартные правила Commitlint.

Установка

yarn add -D @ubic/commitlint-config
# или
npm install -D @ubic/commitlint-config

Требования

• @commitlint/cli@12.0.0 и выше

yarn add -D @commitlint/cli

Примеры конфигурации

В отдельном файле commitlint.config.js:

export default {
  extends: '@ubic/commitlint-config',
};

В файле package.json:

{
  // ...
  "commitlint": {
    "extends": "@ubic/commitlint-config"
  }
  // ...
};

Для расширения своими правилами:

export default {
  extends: '@ubic/commitlint-config',
  rules: {
    'body-leading-blank': [2, 'never'],
  },
};

Использование

Как правило текст коммита удобно проверять в гит-хуке commit-msg.

Пример с husky

# .husky/commit-msg
yarn commitlint --edit $1

Разработка

Процесс разработки подробно описан в CONTRIBUTING.md