@astral/commitlint-config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Astral.Soft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# @astral/commitlint-config
+
+# Usage
+
+## Installation
+
+### Npm
+```shell
+npm i commitlint @astral/commitlint-config --save-dev 
+```
+
+### Yarn
+```shell
+yarn add commitlint @astral/commitlint-config -D
+```
+
+### Configuration
+```commitlint.config.js```
+```js
+const { createConfig } = require('@astral/commitlint-config');
+
+module.exports = createConfig({
+  scopes: ['ui', 'server'],
+  ticketPrefix: 'UIKIT',
+});
+```
+
+```.huskyrc```
+```json
+{
+  "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 файлы. Можно связать с релизом patch версии
+- story - внесены изменения в storybook.
+- build - внесены изменения в сборке пакетов. Можно связать с релизом patch версии
+- chore - внесены изменения в настройку окружения проекта (линтеры, ci...).
+- revert - удалены ранее внесенные изменения
+- style - написаны или изменены стили проекта
+- test - написаны или изменены тесты проекта
+- major - breaking changes. Полезен для пакетов. Можно связать с релизом major версии
+
+# API
+## createConfig
+```ts
+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);
+```

package/config.js

@@ -0,0 +1,93 @@
+const DEFAULT_TYPE_ENUM = [
+  'feat',
+  'bug',
+  'wip',
+  'refactor',
+  'doc',
+  'build',
+  'chore',
+  'revert',
+  'style',
+  'test',
+  'major',
+  'story',
+];
+
+/**
+ * Создает commitlint config
+ * @param {Object} params - Параметры инициализации конфига.
+ * @param {string[]} [params.scopes=[]] - Список доступных scopes.
+ * @param {string} params.ticketPrefix - Название префикса или список названий префиксов задач, данный префикс будет доступен в scope.
+ * @param {string[]} [params.typeEnum=[]] - Список доступных type.
+ * @example
+ * // createConfig({ scopes: ['server', 'ui'], ticketPrefix: 'UIKIT' })
+ */
+const createConfig = ({
+  scopes = [],
+  ticketPrefix,
+  typeEnum = DEFAULT_TYPE_ENUM,
+}) => ({
+  extends: ['@commitlint/config-conventional'],
+
+  plugins: ['commitlint-plugin-function-rules'],
+
+  rules: {
+    // Тело коммита должно начинаться с пустой строки
+    'body-leading-blank': [2, 'always'],
+
+    // Нижний колонтитул коммита должен начинаться с пустой строки
+    'footer-leading-blank': [2, 'always'],
+
+    // Максимальная длина заголовка
+    'header-max-length': [2, 'always', 120],
+
+    // Описание не может быть пустым
+    'subject-empty': [2, 'never'],
+
+    // Описание не должно заканчиваться '.'
+    'subject-full-stop': [2, 'never', '.'],
+
+    // Описание должно начинаться с большой буквы
+    'subject-case': [2, 'always', 'sentence-case'],
+
+    // Тип всегда только в нижнем регистре
+    'type-case': [2, 'always', 'lower-case'],
+
+    // Тип не может быть пустым
+    'type-empty': [2, 'never'],
+
+    // Перечислим все возможные варианты коммитов
+    'type-enum': [2, 'always', typeEnum],
+
+    // функция вызывается при проверке scopes
+    'function-rules/scope-enum': [
+      2,
+      'always',
+      ({ scope }) => {
+        const ticketPrefixes = Array.isArray(ticketPrefix)
+          ? ticketPrefix
+          : [ticketPrefix];
+
+        const isTicketScope = ticketPrefixes.some((prefix) =>
+          scope?.startsWith(`${prefix}-`),
+        );
+
+        if (!scope || scopes.includes(scope) || isTicketScope) {
+          return [true];
+        }
+
+        const formattedTickets = ticketPrefixes.map(
+          (ticket) => `${ticket}-XXXX`,
+        );
+
+        const scopesEnumsMessage = [...scopes, ...formattedTickets].join(', ');
+
+        return [false, `scope must be one of [${scopesEnumsMessage}]`];
+      },
+    ],
+  },
+});
+
+module.exports = {
+  createConfig,
+};

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@astral/commitlint-config",
+  "main": "./config.js",
+  "dependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "commitlint-plugin-function-rules": "^4.0.1"
+  },
+  "peerDependencies": {
+    "commitlint": ">=16.x.x"
+  },
+  "version": "1.0.0",
+  "author": "Astral.Soft",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://git.astralnalog.ru/frontend.shared/commitlint-config"
+  }
+}