Merge pull request #5 from rambler-digital-solutions/commitlint-confi…

…g [skip-ci

feat(commitlint-config): add config for commitlint

.commitlintrc.json

@@ -1,5 +1,3 @@
 {
-  "extends": [
-    "@commitlint/config-conventional"
-  ]
+  "extends": ["@rambler-tech/commitlint-config/shared"]
 }

README.md

@@ -4,6 +4,7 @@ Rambler team configurations for linters, formatters and tools
 
 ## Tools
 
+* [CommitLint](packages/commitlint-config)
 * [ESLint](packages/eslint-config)
 * [License Lint](packages/licenselint-config)
 * [Prettier](packages/prettier-config)

package.json

@@ -15,8 +15,7 @@
   "license": "MIT",
   "private": true,
   "devDependencies": {
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
+    "@commitlint/cli": "^17",
     "eslint": "^8.49.0",
     "eslint-config-prettier": "^9.0.0",
     "husky": "^8.0.3",

packages/commitlint-config/README.md

@@ -0,0 +1,31 @@
+# Shared [CommitLint](https://commitlint.js.org) config
+
+## Install
+
+```
+npm install -D @commitlint/cli @rambler-tech/commitlint-config
+```
+
+or
+
+```
+yarn add -D @commitlint/cli @rambler-tech/commitlint-config
+```
+
+## Usage
+
+Included configurations:
+
+- `@rambler-tech/commitlint-config` - simple rules
+- `@rambler-tech/commitlint-config/conventional` - for conventional commits
+- `@rambler-tech/commitlint-config/shared` - for shared modules – conventional commits with optional refs
+
+Example `.commitlintrc.json` for conventional commits:
+
+```json
+{
+  "extends": [
+    "@rambler-tech/commitlint-config/conventional"
+  ]
+}
+```

packages/commitlint-config/conventional.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'references-empty': [2, 'never'],
+    'subject-case': [2, 'never', ['start-case', 'pascal-case', 'upper-case']]
+  },
+  parserPreset: {
+    parserOpts: {
+      issuePrefixes: ['#', '[A-Z]{2,10}-']
+    }
+  }
+}

packages/commitlint-config/index.js

@@ -0,0 +1,13 @@
+module.exports = {
+  extends: ['./conventional.js'],
+  rules: {
+    'type-empty': [0]
+  },
+  parserPreset: {
+    parserOpts: {
+      headerPattern: /^(.*)$/,
+      headerCorrespondence: ['subject'],
+      issuePrefixes: ['#', '[A-Z]{2,10}-']
+    }
+  }
+}

packages/commitlint-config/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@rambler-tech/commitlint-config",
+  "version": "0.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@commitlint/config-conventional": "^17"
+  }
+}

packages/commitlint-config/shared.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['./conventional.js'],
+  rules: {
+    'references-empty': [0]
+  }
+}