Merge pull request #58 from kurone-kito/add-the-commitlint-configuration

v0.8.2: Added the commitlint configuration and maintenance updates

.commitlintrc.yml

@@ -1,2 +1,2 @@
 extends:
-  - '@commitlint/config-conventional'
+  - '@kurone-kito/commitlint-config'

.github/workflows/push-feature.yml

@@ -27,10 +27,14 @@ jobs:
       - name: Prepare the Node.js version ${{ matrix.node-version }} environment
         uses: actions/setup-node@v4
         with:
-          cache: ${{ !env.ACT && 'yarn' || '' }}
           node-version: ${{ matrix.node-version }}
       - name: Enable the corepack because of the Yarn berry
         run: corepack enable
+      - name: Prepare the Node.js version ${{ matrix.node-version }} environment
+        uses: actions/setup-node@v4
+        with:
+          cache: ${{ !env.ACT && 'yarn' || '' }}
+          node-version: ${{ matrix.node-version }}
       - env:
           HUSKY: 0
         name: Install the dependencies

.github/workflows/release.yml

@@ -16,10 +16,14 @@ jobs:
       - name: Prepare the Node.js environment
         uses: actions/setup-node@v4
         with:
-          cache: ${{ !env.ACT && 'yarn' || '' }}
           node-version-file: .node-version
       - name: Enable the corepack because of the Yarn berry
         run: corepack enable
+      - name: Prepare the Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          cache: ${{ !env.ACT && 'yarn' || '' }}
+          node-version-file: .node-version
       - env:
           HUSKY: 0
         name: Install the dependencies

.gitignore

@@ -310,6 +310,7 @@ $RECYCLE.BIN/
 
 ### Node ###
 # Built files
+packages/commitlint-config/.commitlintrc.json
 packages/cspell-config/cspell.config.json
 packages/eslint-config-*/.eslintrc.json
 packages/lint-staged-config/lint-staged.config.json

.node-version

@@ -1 +1 @@
-18.18.2
+18.19.0

.nvmrc

@@ -1,3 +1,3 @@
-18.18.2
+18.19.0
 lts/hydrogen
 node

.tool-versions

@@ -1 +1 @@
-nodejs 18.18.2 ref:v18.18.2 lts-hydrogen lts latest system
+nodejs 18.19.0 ref:v18.19.0 lts-hydrogen lts latest system

.yarn/sdks/eslint/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint",
-  "version": "8.53.0-sdk",
+  "version": "8.55.0-sdk",
   "main": "./lib/api.js",
   "type": "commonjs",
   "bin": {

.yarn/sdks/prettier/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier",
-  "version": "3.0.3-sdk",
+  "version": "3.1.0-sdk",
   "main": "./index.cjs",
   "type": "commonjs",
   "bin": "./bin/prettier.cjs"

.yarn/sdks/typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript",
-  "version": "5.2.2-sdk",
+  "version": "5.3.2-sdk",
   "main": "./lib/typescript.js",
   "type": "commonjs",
   "bin": {

README.md

@@ -12,6 +12,7 @@ My configuration for the ESLint / Prettier / TypeScript
 
 ## Structure of the monorepo
 
+- [`packages/commitlint-config`](packages/commitlint-config/README.md): My commitlint configuration for general projects.
 - [`packages/cspell-config`](packages/cspell-config/README.md): My CSpell configuration for general projects.
 - [`packages/eslint-config-base`](packages/eslint-config-base/README.md): My ESLint configuration for general projects.
 - [`packages/eslint-config-react`](packages/eslint-config-base/README.md): My ESLint configuration for React projects.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/lints-config",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "private": true,
   "description": "My configuration for the ESLint / Prettier / TypeScript",
   "keywords": [
@@ -27,7 +27,7 @@
   "scripts": {
     "build": "yarn run sub run build",
     "clean": "conc \"yarn:clean:*\"",
-    "clean:root": "rimraf -g \".eslintcache\" \"*.tgz\" \"*.tsbuildinfo\" \"undefined\"",
+    "clean:root": "rimraf -g .eslintcache \"*.tgz\" \"*.tsbuildinfo\"",
     "clean:sub": "yarn run sub run clean",
     "commit": "aicommits -t conventional",
     "postinstall": "husky install",
@@ -46,25 +46,26 @@
   },
   "prettier": "@kurone-kito/prettier-config",
   "devDependencies": {
-    "@commitlint/cli": "^18.4.1",
-    "@commitlint/config-conventional": "^18.4.0",
-    "@cspell/cspell-types": "^8.0.0",
-    "@cspell/eslint-plugin": "^8.0.0",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "@cspell/cspell-types": "^8.1.0",
+    "@cspell/eslint-plugin": "^8.1.0",
+    "@kurone-kito/commitlint-config": "workspace:*",
     "@kurone-kito/cspell-config": "workspace:*",
     "@kurone-kito/eslint-config-base": "workspace:*",
     "@kurone-kito/eslint-config-react": "workspace:*",
     "@kurone-kito/lint-staged-config": "workspace:*",
     "@kurone-kito/prettier-config": "workspace:*",
     "@kurone-kito/typescript-config": "workspace:*",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
-    "@yarnpkg/sdks": "^3.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
+    "@yarnpkg/sdks": "^3.1.0",
     "aicommits": "^1.11.0",
     "concurrently": "^8.2.2",
-    "cspell": "^8.0.0",
-    "eslint": "^8.53.0",
+    "cspell": "^8.1.0",
+    "eslint": "^8.55.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-formatter-codeframe": "^7.32.1",
     "eslint-import-resolver-node": "^0.3.9",
     "eslint-import-resolver-typescript": "^3.6.1",
@@ -79,12 +80,12 @@
     "eslint-plugin-yaml": "^0.5.0",
     "husky": "^8.0.3",
     "lint-staged": "^15.1.0",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.0",
     "rimraf": "^5.0.5",
-    "typescript": "~5.2.2",
+    "typescript": "~5.3.2",
     "typescript-eslint-language-service": "^5.0.5"
   },
-  "packageManager": "[email protected].1",
+  "packageManager": "[email protected].2",
   "engines": {
     "node": ">=18"
   },

packages/commitlint-config/.commitlintrc.yml

@@ -0,0 +1,23 @@
+extends:
+  - '@commitlint/config-conventional'
+rules:
+  # Permission to capitalize the first letter of the body text is granted
+  # with a warning; the default rule for Conventional Commits prohibits it.
+  # In English commits, it is common for the subject to be a verb, as in
+  # `added the ...` in Japanese commits, however, nouns are commonly used
+  # as the subject, and prohibiting this may result in unnatural commit
+  # messages in Japanese.
+  body-case:
+    - 1
+    - always
+    - lower-case
+  # Permits capitalization of the first letter of the main text with a
+  # warning; the default rule for Conventional Commits prohibits it. In
+  # English commits, it is common for the subject to be a verb, as in
+  # `added the ...` In Japanese commits, however, nouns are commonly used
+  # as the subject, and prohibiting this may result in unnatural commit
+  # messages in Japanese.
+  subject-case:
+    - 1
+    - always
+    - lower-case

packages/commitlint-config/README.md

@@ -0,0 +1,24 @@
+# `@kurone-kito/commitlint-config`
+
+My commitlint configuration for general Node.js projects.
+
+## Usage
+
+First, install this package and its peer dependencies:
+
+```sh
+npm install --save-dev \
+  @commitlint/config-conventional \
+  @kurone-kito/commitlint-config
+```
+
+Then, create a `.commitlintrc.yml` file. If exists, merge the following configuration into it:
+
+```yaml
+extends:
+  - '@kurone-kito/commitlint-config'
+```
+
+## License
+
+MIT

packages/commitlint-config/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@kurone-kito/commitlint-config",
+  "version": "0.8.2",
+  "description": "My commitlint configuration for general projects",
+  "keywords": [
+    "commitlint",
+    "config"
+  ],
+  "homepage": "https://github.com/kurone-kito/lints-config#readme",
+  "bugs": "https://github.com/kurone-kito/lints-config/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kurone-kito/lints-config.git",
+    "directory": "packages/commitlint-config"
+  },
+  "license": "MIT",
+  "author": "kurone-kito <[email protected]> (https://kit.black/)",
+  "type": "module",
+  "exports": {
+    ".": "./.commitlintrc.json",
+    "./.commitlintrc.json": "./.commitlintrc.json",
+    "./.commitlintrc.yml": "./.commitlintrc.yml"
+  },
+  "main": ".commitlintrc.json",
+  "module": ".commitlintrc.json",
+  "files": [
+    ".commitlintrc.*"
+  ],
+  "scripts": {
+    "build": "conc \"yarn:build:*\"",
+    "build:json": "js-yaml .commitlintrc.yml > .commitlintrc.json",
+    "build:license": "cpy \"../../LICENSE\" \"cspell-config/LICENSE\"",
+    "clean": "rimraf -g LICENSE .commitlintrc.json \"*.tgz\"",
+    "prepack": "conc -m 1 \"yarn:clean\" \"yarn:build\""
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^18.4.3",
+    "concurrently": "^8.2.2",
+    "cpy-cli": "^5.0.0",
+    "js-yaml": "^4.1.0",
+    "rimraf": "^5.0.5"
+  },
+  "peerDependenciesMeta": {
+    "@commitlint/config-conventional": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/cspell-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/cspell-config",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "My CSpell configuration for general projects",
   "keywords": [
     "config",
@@ -37,14 +37,14 @@
     "build": "conc \"yarn:build:*\"",
     "build:json": "js-yaml cspell.config.yml > cspell.config.json",
     "build:license": "cpy \"../../LICENSE\" \"cspell-config/LICENSE\"",
-    "clean": "rimraf -g \"cspell.config.json\" \"*.tgz\" \"undefined\"",
+    "clean": "rimraf -g LICENSE cspell.config.json \"*.tgz\"",
     "prepack": "conc -m 1 \"yarn:clean\" \"yarn:build\""
   },
   "devDependencies": {
-    "@cspell/cspell-types": "^8.0.0",
+    "@cspell/cspell-types": "^8.1.0",
     "concurrently": "^8.2.2",
     "cpy-cli": "^5.0.0",
-    "cspell": "^8.0.0",
+    "cspell": "^8.1.0",
     "js-yaml": "^4.1.0",
     "rimraf": "^5.0.5"
   },

packages/eslint-config-base/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/eslint-config-base",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "My ESLint configuration for general Node.js projects",
   "keywords": [
     "config",
@@ -32,20 +32,20 @@
     "build": "conc \"yarn:build:*\"",
     "build:json": "js-yaml .eslintrc.yml > .eslintrc.json",
     "build:license": "cpy \"../../LICENSE\" \"eslint-config-base/LICENSE\"",
-    "clean": "rimraf -g \".eslintcache\" \".eslintrc.json\" \"*.tgz\" \"*.tsbuildinfo\" \"undefined\"",
+    "clean": "rimraf -g .eslintcache .eslintrc.json LICENSE \"*.tgz\" \"*.tsbuildinfo\"",
     "prepack": "conc -m 1 \"yarn:clean\" \"yarn:build\""
   },
   "prettier": "@kurone-kito/prettier-config",
   "devDependencies": {
-    "@cspell/eslint-plugin": "^8.0.0",
+    "@cspell/eslint-plugin": "^8.1.0",
     "@kurone-kito/prettier-config": "workspace:*",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
     "concurrently": "^8.2.2",
     "cpy-cli": "^5.0.0",
-    "eslint": "^8.53.0",
+    "eslint": "^8.55.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-formatter-codeframe": "^7.32.1",
     "eslint-import-resolver-node": "^0.3.9",
     "eslint-import-resolver-typescript": "^3.6.1",
@@ -58,9 +58,9 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-yaml": "^0.5.0",
     "js-yaml": "^4.1.0",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.0",
     "rimraf": "^5.0.5",
-    "typescript": "~5.2.2"
+    "typescript": "~5.3.2"
   },
   "peerDependencies": {
     "@cspell/eslint-plugin": ">=6.x.x",

packages/eslint-config-react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/eslint-config-react",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "My ESLint configuration for React projects",
   "keywords": [
     "config",
@@ -33,23 +33,23 @@
     "build": "conc \"yarn:build:*\"",
     "build:json": "js-yaml .eslintrc.yml > .eslintrc.json",
     "build:license": "cpy \"../../LICENSE\" \"eslint-config-react/LICENSE\"",
-    "clean": "rimraf -g \".eslintcache\" \".eslintrc.json\" \"*.tgz\" \"*.tsbuildinfo\" \"undefined\"",
+    "clean": "rimraf -g .eslintcache .eslintrc.json LICENSE \"*.tgz\" \"*.tsbuildinfo\"",
     "prepack": "conc -m 1 \"yarn:clean\" \"yarn:build\""
   },
   "prettier": "@kurone-kito/prettier-config",
   "dependencies": {
     "@kurone-kito/eslint-config-base": "workspace:*"
   },
   "devDependencies": {
-    "@cspell/eslint-plugin": "^8.0.0",
+    "@cspell/eslint-plugin": "^8.1.0",
     "@kurone-kito/prettier-config": "workspace:*",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/parser": "^6.13.1",
     "concurrently": "^8.2.2",
     "cpy-cli": "^5.0.0",
-    "eslint": "^8.53.0",
+    "eslint": "^8.55.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-formatter-codeframe": "^7.32.1",
     "eslint-import-resolver-node": "^0.3.9",
     "eslint-import-resolver-typescript": "^3.6.1",
@@ -66,9 +66,9 @@
     "eslint-plugin-storybook": "^0.6.15",
     "eslint-plugin-yaml": "^0.5.0",
     "js-yaml": "^4.1.0",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.0",
     "rimraf": "^5.0.5",
-    "typescript": "~5.2.2"
+    "typescript": "~5.3.2"
   },
   "peerDependencies": {
     "@cspell/eslint-plugin": ">=6.x.x",