@itcase/config 1.6.45 → 1.6.47

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

@@ -0,0 +1,123 @@
+/**
+ * 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 SUB_SCOPE_MESSAGE = 'Select sub-scope (optional):'
+const SUBJECT_REQUIRED = 'Subject is required'
+
+function buildScope(scope, subScope) {
+  if (!scope) return ''
+  if (!subScope) return scope
+  return `${scope} / ${subScope}`
+}
+
+function toChoices(values) {
+  return values.map((value) => ({ name: value, value }))
+}
+
+function buildTypeChoices(types, typeEnum) {
+  return types.map((value) => {
+    const meta = typeEnum?.[value]
+    const name = meta
+      ? [meta.emoji, value, meta.description].filter(Boolean).join(': ')
+      : value
+    return { name, value }
+  })
+}
+
+async function loadConfig() {
+  const [{ default: load }, { commitlintProject }] = await Promise.all([
+    import('@commitlint/load'),
+    import('./commitlintProject.js'),
+  ])
+
+  const { prompt: promptOverrides, rules } = await load()
+
+  const configPath = path.resolve(process.cwd(), 'commitlint.config.mjs')
+  const configModule = await import(pathToFileURL(configPath).href)
+  const SCOPES = configModule.default?.SCOPES || {}
+
+  return { commitlintProject, promptOverrides, rules, SCOPES }
+}
+
+function prompter(inquirer, commit) {
+  ;(async () => {
+    try {
+      const { commitlintProject, promptOverrides, rules, SCOPES } =
+        await loadConfig()
+
+      const q = commitlintProject.prompt.questions
+      const over = promptOverrides?.questions
+
+      const scopeEnum = rules['scope-enum']?.[2]
+      const types =
+        rules['type-enum']?.[2] ?? commitlintProject.rules['type-enum'][2]
+      const typeEnum = over?.type?.enum ?? q.type.enum
+      const typeChoices = buildTypeChoices(types, typeEnum)
+
+      const baseScopes = Array.isArray(scopeEnum)
+        ? scopeEnum.filter((s) => !s.includes(' / '))
+        : Object.keys(SCOPES)
+      const scopeList = baseScopes.length > 0 ? baseScopes : Object.keys(SCOPES)
+
+      const messages = {
+        type: over?.type?.description ?? q.type.description,
+        scope: over?.scope?.description ?? q.scope.description,
+        subject: over?.subject?.description ?? q.subject.description,
+      }
+
+      const answers = await inquirer.prompt([
+        {
+          type: 'list',
+          name: 'type',
+          message: messages.type,
+          choices: typeChoices,
+        },
+        {
+          type: 'list',
+          name: 'scope',
+          message: messages.scope,
+          choices: toChoices(scopeList),
+        },
+        {
+          type: 'list',
+          name: 'subScope',
+          message: SUB_SCOPE_MESSAGE,
+          choices: function (answers) {
+            const subs = SCOPES[answers.scope] || []
+            return [
+              ...toChoices(subs),
+              new inquirer.Separator(),
+              { name: 'None', value: '' },
+            ]
+          },
+          when: function (answers) {
+            const subs = SCOPES[answers.scope]
+            return answers.scope && subs?.length > 0
+          },
+        },
+        {
+          type: 'input',
+          name: 'subject',
+          message: messages.subject,
+          validate: (input) => (input?.trim() ? true : SUBJECT_REQUIRED),
+        },
+      ])
+
+      const scope = buildScope(answers.scope, answers.subScope)
+      const header = scope
+        ? `${answers.type}(${scope}): ${answers.subject.trim()}`
+        : `${answers.type}: ${answers.subject.trim()}`
+      commit(header)
+    } catch (err) {
+      console.error(err)
+      process.exit(1)
+    }
+  })()
+}
+
+export { prompter }

package/commitlint/commitlintCommon.js

@@ -0,0 +1,34 @@
+/**
+ * Shared commitlint config: rules and prompt texts used by commitlintProject and commitlintRelease.
+ */
+
+export const parserPreset = 'conventional-changelog-conventionalcommits'
+
+export const defaultIgnores = true
+
+export const commonRules = {
+  'body-empty': [1, 'always'],
+  'footer-empty': [1, 'always'],
+  'scope-empty': [2, 'never'],
+  'subject-case': [2, 'always', ['lower-case', 'sentence-case', 'start-case']],
+  'subject-empty': [2, 'never'],
+  'type-empty': [2, 'never'],
+}
+
+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
+ * @returns {string[]}
+ */
+export function buildScopeEnum(scopeSubscopes) {
+  const base = Object.keys(scopeSubscopes)
+  return [
+    ...base,
+    ...base.flatMap((scope) =>
+      (scopeSubscopes[scope] || []).map((sub) => `${scope} / ${sub}`),
+    ),
+  ]
+}

package/commitlint/commitlintCreateConfig.js

@@ -0,0 +1,40 @@
+/**
+ * Factory: commitlint config with scope-enum from SCOPES.
+ */
+
+import { buildScopeEnum } from './commitlintCommon.js'
+import { commitlintProject } from './commitlintProject.js'
+import { commitlintRelease } from './commitlintRelease.js'
+
+/**
+ * @param {object} baseConfig
+ * @param {Record<string, string[]>} scopes
+ * @returns {object}
+ */
+function createConfig(baseConfig, scopes) {
+  const scopeEnum = buildScopeEnum(scopes)
+  return {
+    ...baseConfig,
+    rules: {
+      ...baseConfig.rules,
+      'scope-enum': [2, 'always', scopeEnum],
+    },
+    SCOPES: scopes,
+  }
+}
+
+/**
+ * @param {Record<string, string[]>} scopes
+ * @returns {object}
+ */
+export function createCommitlintProjectConfig(scopes) {
+  return createConfig(commitlintProject, scopes)
+}
+
+/**
+ * @param {Record<string, string[]>} scopes
+ * @returns {object}
+ */
+export function createCommitlintReleaseConfig(scopes) {
+  return createConfig(commitlintRelease, scopes)
+}

package/commitlint/commitlintProject.js

@@ -1,14 +1,21 @@
 /* eslint-disable perfectionist/sort-objects */
 
+import {
+  commonRules,
+  defaultIgnores,
+  parserPreset,
+  promptSubjectDescription,
+} from './commitlintCommon.js'
+
 const commitlintProject = {
-  parserPreset: 'conventional-changelog-conventionalcommits',
+  parserPreset,
   ignores: [
     (commit) => /^Merge branch/.test(commit),
     (commit) => /^Merge pull request/.test(commit),
   ],
   rules: {
+    ...commonRules,
     'type-case': [2, 'always', 'lower-case'],
-    'type-empty': [2, 'never'],
     'type-enum': [
       2,
       'always',
@@ -24,18 +31,9 @@ const commitlintProject = {
         'other',
       ],
     ],
-    'body-empty': [1, 'always'],
-    'subject-case': [
-      2,
-      'always',
-      ['lower-case', 'sentence-case', 'start-case'],
-    ],
-    'subject-empty': [2, 'never'],
-    'footer-empty': [1, 'always'],
-    'scope-empty': [2, 'never'],
     'scope-enum': [2, 'always', ['PLEASE', 'SET', 'SCOPE-ENUM']],
   },
-  defaultIgnores: true,
+  defaultIgnores,
   prompt: {
     settings: {
       enableMultipleScopes: true,
@@ -96,8 +94,7 @@ const commitlintProject = {
         description: 'What is the scope of this change',
       },
       subject: {
-        description:
-          'Write a short, imperative tense description of the change',
+        description: promptSubjectDescription,
       },
     },
   },

package/commitlint/commitlintRelease.js

@@ -1,23 +1,21 @@
 /* eslint-disable perfectionist/sort-objects */
 
+import {
+  commonRules,
+  defaultIgnores,
+  parserPreset,
+  promptSubjectDescription,
+} from './commitlintCommon.js'
+
 const commitlintRelease = {
-  parserPreset: 'conventional-changelog-conventionalcommits',
+  parserPreset,
   extends: ['@commitlint/config-conventional'],
   rules: {
+    ...commonRules,
     'type-case': [0],
-    'body-empty': [1, 'always'],
-    'subject-empty': [2, 'never'],
-    'subject-case': [
-      2,
-      'always',
-      ['lower-case', 'sentence-case', 'start-case'],
-    ],
-    'type-empty': [2, 'never'],
-    'scope-empty': [2, 'never'],
-    'footer-empty': [1, 'always'],
     'type-enum': [2, 'always', ['patch', 'minor', 'major']],
   },
-  defaultIgnores: true,
+  defaultIgnores,
   prompt: {
     settings: {},
     questions: {
@@ -43,8 +41,7 @@ const commitlintRelease = {
         },
       },
       subject: {
-        description:
-          'Write a short, imperative tense description of the change',
+        description: promptSubjectDescription,
       },
     },
   },

package/commitlint/index.js

@@ -1,4 +1,15 @@
-import { commitlintProject } from './commitlintProject.js'
-import { commitlintRelease } from './commitlintRelease.js'
+export {
+  buildScopeEnum,
+  commonRules,
+  defaultIgnores,
+  parserPreset,
+  promptSubjectDescription,
+} from './commitlintCommon.js'
 
-export { commitlintProject, commitlintRelease }
+export {
+  createCommitlintProjectConfig,
+  createCommitlintReleaseConfig,
+} from './commitlintCreateConfig.js'
+
+export { commitlintProject } from './commitlintProject.js'
+export { commitlintRelease } from './commitlintRelease.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itcase/config",
-  "version": "1.6.45",
+  "version": "1.6.47",
   "author": "ITCase",
   "description": "ITCase Config",
   "engines": {
@@ -36,17 +36,17 @@
     "@lerna-lite/list": "^4.11.0",
     "@lerna-lite/run": "^4.11.1",
     "@lerna-lite/watch": "^4.11.0",
-    "semantic-release-lerna": "^2.16.5",
+    "semantic-release-lerna": "^2.17.0",
     "chokidar-cli": "^3.0.0",
-    "@commitlint/cli": "^20.3.1",
-    "@commitlint/config-conventional": "^20.3.1",
-    "@commitlint/cz-commitlint": "^20.3.1",
+    "@commitlint/cli": "^20.4.1",
+    "@commitlint/config-conventional": "^20.4.1",
+    "@commitlint/cz-commitlint": "^20.4.1",
     "@lehoczky/postcss-fluid": "^1.0.3",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/release-notes-generator": "14.1.0",
     "@svgr/webpack": "^8.1.0",
-    "autoprefixer": "^10.4.23",
+    "autoprefixer": "^10.4.24",
     "commitizen": "^4.3.1",
     "conventional-changelog-conventionalcommits": "^9.1.0",
     "cssnano": "^7.1.2",
@@ -76,7 +76,7 @@
     "postcss-nested-ancestors": "^3.0.0",
     "postcss-normalize": "^13.0.1",
     "postcss-prepend-imports": "^1.0.1",
-    "postcss-preset-env": "^11.1.2",
+    "postcss-preset-env": "^11.1.3",
     "postcss-pxtorem": "^6.1.0",
     "postcss-sort-media-queries": "^5.2.0",
     "postcss-unit": "^0.0.3",
@@ -99,13 +99,13 @@
     "postcss-urlrewrite": "^0.3.0"
   },
   "devDependencies": {
-    "@itcase/lint": "^1.1.94",
+    "@itcase/lint": "^1.1.95",
     "eslint": "^9.39.2",
     "husky": "^9.1.7",
     "inquirer": "^13.2.2",
     "lint-staged": "^16.2.7",
     "prettier": "^3.8.1",
-    "stylelint": "^17.0.0",
+    "stylelint": "^17.1.1",
     "typescript": "^5.9.3"
   }
 }