@itcase/config 1.6.46 → 1.6.48

package/README.md

@@ -13,8 +13,9 @@ npm install --save-dev @itcase/config
 Пакет предоставляет следующие конфигурации:
 
 - **Commitlint** — проверка формата сообщений коммитов
-  - `commitlint/indexProject.js` — для разработки
-  - `commitlint/indexRelease.js` — для релизных веток
+  - `createCommitlintProjectConfig(SCOPES)` — для разработки
+  - `createCommitlintReleaseConfig(SCOPES)` — для релизных веток
+  - `commitlint/commitizenAdapter.js` — адаптер Commitizen (type → scope → subScope → subject)
 
 - **Husky** — husky-hooks
 
@@ -35,3 +36,52 @@ npm install --save-dev @itcase/config
 - **SVGR** — преобразование SVG в React компоненты
   - `svgr/index.js` — базовая конфигурация
   - `svgr/webpack.js` — интеграция с Webpack
+
+## Подключение Commitlint
+
+1. Установите зависимости в проекте:
+
+```bash
+npm install --save-dev @itcase/config @commitlint/cli @commitlint/config-conventional conventional-changelog-conventionalcommits
+```
+
+2. Создайте в корне проекта файл `commitlint.config.mjs`:
+
+```js
+import {
+  createCommitlintProjectConfig,
+  createCommitlintReleaseConfig,
+} from '@itcase/config/commitlint/index.js'
+
+const SCOPES = {
+  auth: [],
+  common: [],
+  dashboard: [],
+  logbook: ['events', 'filters'],
+  map: ['layers', 'controls', 'markers'],
+  report: ['monitoring', 'analytics', 'export', 'filters'],
+  other: [],
+}
+
+export default process.env.RELEASE_BRANCH === 'true'
+  ? createCommitlintReleaseConfig(SCOPES)
+  : createCommitlintProjectConfig(SCOPES)
+```
+
+3. Подключите проверку в husky (например, в `.husky/commit-msg`):
+
+```bash
+npx commitlint --edit "$1"
+```
+
+4. **(Опционально)** Интерактивное оформление коммитов через Commitizen. Установите:
+
+```bash
+npm install --save-dev commitizen @commitlint/cz-commitlint
+```
+
+Добавьте файл `.cz.json`
+
+```json
+{ "path": "@itcase/config/commitlint/commitizenAdapter.js" }
+```

package/commitlint/commitizenAdapter.js

@@ -1,11 +1,7 @@
-/**
- * Custom Commitizen adapter: type → scope → subScope (optional) → subject.
- * Settings from commitlintProject.js; SCOPES from project commitlint.config.mjs.
- */
-
 import path from 'path'
 import { pathToFileURL } from 'url'
 
+const COMMITLINT_CONFIG_FILE = 'commitlint.config.mjs'
 const SUB_SCOPE_MESSAGE = 'Select sub-scope (optional):'
 const SUBJECT_REQUIRED = 'Subject is required'
 
@@ -16,7 +12,7 @@ function buildScope(scope, subScope) {
 }
 
 function toChoices(values) {
-  return values.map((value) => ({ name: value, value }))
+  return values.map((value) => ({ name: value, value: value }))
 }
 
 function buildTypeChoices(types, typeEnum) {
@@ -37,8 +33,9 @@ async function loadConfig() {
 
   const { prompt: promptOverrides, rules } = await load()
 
-  const configPath = path.resolve(process.cwd(), 'commitlint.config.mjs')
-  const configModule = await import(pathToFileURL(configPath).href)
+  const configModule = await import(
+    pathToFileURL(path.resolve(process.cwd(), COMMITLINT_CONFIG_FILE)).href
+  )
   const SCOPES = configModule.default?.SCOPES || {}
 
   return { commitlintProject, promptOverrides, rules, SCOPES }
@@ -59,10 +56,12 @@ function prompter(inquirer, commit) {
       const typeEnum = over?.type?.enum ?? q.type.enum
       const typeChoices = buildTypeChoices(types, typeEnum)
 
+      const isScopesArray = Array.isArray(SCOPES)
+      const scopesFromConfig = isScopesArray ? SCOPES : Object.keys(SCOPES)
       const baseScopes = Array.isArray(scopeEnum)
         ? scopeEnum.filter((s) => !s.includes(' / '))
-        : Object.keys(SCOPES)
-      const scopeList = baseScopes.length > 0 ? baseScopes : Object.keys(SCOPES)
+        : scopesFromConfig
+      const scopeList = baseScopes.length > 0 ? baseScopes : scopesFromConfig
 
       const messages = {
         type: over?.type?.description ?? q.type.description,
@@ -88,14 +87,15 @@ function prompter(inquirer, commit) {
           name: 'subScope',
           message: SUB_SCOPE_MESSAGE,
           choices: function (answers) {
-            const subs = SCOPES[answers.scope] || []
+            const subs = isScopesArray ? [] : SCOPES[answers.scope] || []
             return [
               ...toChoices(subs),
               new inquirer.Separator(),
-              { name: 'None', value: '' },
+              { name: 'none', value: '' },
             ]
           },
           when: function (answers) {
+            if (isScopesArray) return false
             const subs = SCOPES[answers.scope]
             return answers.scope && subs?.length > 0
           },

package/commitlint/commitlintCommon.js

@@ -19,11 +19,16 @@ export const promptSubjectDescription =
   'Write a short, imperative tense description of the change'
 
 /**
- * Builds flat scope-enum list from SCOPES: base scopes + "scope / subScope".
- * @param {Record<string, string[]>} scopeSubscopes
+ * Builds flat scope-enum list from SCOPES.
+ * - If SCOPES is string[]: returns it as-is (no sub-scopes).
+ * - If SCOPES is Record<string, string[]>: base scopes + "scope / subScope".
+ * @param {string[] | Record<string, string[]>} scopeSubscopes
  * @returns {string[]}
  */
 export function buildScopeEnum(scopeSubscopes) {
+  if (Array.isArray(scopeSubscopes)) {
+    return [...scopeSubscopes]
+  }
   const base = Object.keys(scopeSubscopes)
   return [
     ...base,

package/commitlint/commitlintCreateConfig.js

@@ -8,7 +8,7 @@ import { commitlintRelease } from './commitlintRelease.js'
 
 /**
  * @param {object} baseConfig
- * @param {Record<string, string[]>} scopes
+ * @param {string[] | Record<string, string[]>} scopes
  * @returns {object}
  */
 function createConfig(baseConfig, scopes) {
@@ -24,7 +24,7 @@ function createConfig(baseConfig, scopes) {
 }
 
 /**
- * @param {Record<string, string[]>} scopes
+ * @param {string[] | Record<string, string[]>} scopes
  * @returns {object}
  */
 export function createCommitlintProjectConfig(scopes) {
@@ -32,7 +32,7 @@ export function createCommitlintProjectConfig(scopes) {
 }
 
 /**
- * @param {Record<string, string[]>} scopes
+ * @param {string[] | Record<string, string[]>} scopes
  * @returns {object}
  */
 export function createCommitlintReleaseConfig(scopes) {

package/commitlint/commitlintProject.js

@@ -8,7 +8,7 @@ import {
 } from './commitlintCommon.js'
 
 const commitlintProject = {
-  parserPreset,
+  parserPreset: parserPreset,
   ignores: [
     (commit) => /^Merge branch/.test(commit),
     (commit) => /^Merge pull request/.test(commit),
@@ -33,7 +33,7 @@ const commitlintProject = {
     ],
     'scope-enum': [2, 'always', ['PLEASE', 'SET', 'SCOPE-ENUM']],
   },
-  defaultIgnores,
+  defaultIgnores: defaultIgnores,
   prompt: {
     settings: {
       enableMultipleScopes: true,

package/commitlint/commitlintRelease.js

@@ -8,14 +8,14 @@ import {
 } from './commitlintCommon.js'
 
 const commitlintRelease = {
-  parserPreset,
+  parserPreset: parserPreset,
   extends: ['@commitlint/config-conventional'],
   rules: {
     ...commonRules,
     'type-case': [0],
     'type-enum': [2, 'always', ['patch', 'minor', 'major']],
   },
-  defaultIgnores,
+  defaultIgnores: defaultIgnores,
   prompt: {
     settings: {},
     questions: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itcase/config",
-  "version": "1.6.46",
+  "version": "1.6.48",
   "author": "ITCase",
   "description": "ITCase Config",
   "engines": {