kurone-kito/add-markdownlint-configurationからプルリクエスト#65をマージする

v0.9.0: Added the MarkdownLint configuration

.coderabbit.yaml

@@ -0,0 +1,9 @@
+chat:
+  auto_reply: true
+early_access: true
+language: en
+reviews:
+  auto_review:
+    enabled: true
+  path_filters:
+    - '!.yarn/**/*'

.gitattributes

@@ -3,4 +3,4 @@
 .github/** export-ignore
 .gitattributes export-ignore
 .husky/** export-ignore
-reviewpad.yml export-ignore
+.coderabbit.yaml export-ignore

.github/CONTRIBUTING.md

@@ -4,10 +4,15 @@ Language: **🇬🇧** | [🇯🇵](./CONTRIBUTING.ja.md) | [🇨🇳](./CONTRIB
 
 ---
 
-When contributing to this repository, please first discuss the change you wish to make via [Issues](https://github.com/kurone-kito/lints-config/issues) or any other method with the owners of this repository before making a change.
+When contributing to this repository, please first discuss the change you
+wish to make via [Issues](https://github.com/kurone-kito/lints-config/issues)
+or any other method with the owners of this repository before making a change.
 
-Please note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+Please note we have a [code of conduct](./CODE_OF_CONDUCT.md),
+please follow it in all your interactions with the project.
 
-If your idea can be shown with a minor fix, please use directly the [pull request](https://github.com/kurone-kito/lints-config/pulls).
+If your idea can be shown with a minor fix, please use directly the
+[pull request](https://github.com/kurone-kito/lints-config/pulls).
 
-In this repository, discussion [in English or Japanese](https://translate.google.com/) is recommended.
+In this repository, discussion
+[in English or Japanese](https://translate.google.com/) is recommended.

.github/workflows/push-main.yml

@@ -20,6 +20,6 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/release-drafter@v6
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -314,6 +314,7 @@ packages/commitlint-config/.commitlintrc.json
 packages/cspell-config/cspell.config.json
 packages/eslint-config-*/.eslintrc.json
 packages/lint-staged-config/lint-staged.config.json
+packages/markdownlint-config/.markdownlint.json
 packages/prettier-config/.prettierrc.json
 
 ### Text ###

.markdownlint-cli2.yaml

@@ -0,0 +1,4 @@
+ignores:
+  - .github/CODE_OF_CONDUCT*
+  - .yarn
+  - node_modules

.markdownlint.yml

@@ -0,0 +1 @@
+extends: './packages/markdownlint-config/.markdownlint.yml'

.yarn/sdks/eslint/package.json

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

.yarn/sdks/typescript/package.json

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

README.md

@@ -1,24 +1,31 @@
-<!-- markdownlint-disable MD041 -->
+# ⚙️ lints-config
+
 <!-- markdownlint-disable MD045 -->
 
 ![](logo.png)
 
-<!-- markdownlint-enable MD041 -->
 <!-- markdownlint-enable MD045 -->
 
-# ⚙️ lints-config
-
 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.
-- [`packages/lint-staged-config`](packages/lint-staged-config/README.md): My lint-staged configuration for general projects.
-- [`packages/prettier-config`](packages/prettier-config/README.md): My Prettier configuration for general projects.
-- [`packages/typescript-config`](packages/typescript-config/README.md): My TypeScript configuration for general projects.
+- [`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.
+- [`packages/lint-staged-config`](packages/lint-staged-config/README.md):
+  My lint-staged configuration for general projects.
+- [`packages/markdownlint-config`](packages/markdownlint-config/README.md):
+  My Markdownlint configuration for general projects.
+- [`packages/prettier-config`](packages/prettier-config/README.md):
+  My Prettier configuration for general projects.
+- [`packages/typescript-config`](packages/typescript-config/README.md):
+  My TypeScript configuration for general projects.
 
 ## System Requirements
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/lints-config",
-  "version": "0.8.4",
+  "version": "0.9.0",
   "private": true,
   "description": "My configuration for the ESLint / Prettier / TypeScript",
   "keywords": [
@@ -9,6 +9,7 @@
     "eslint",
     "eslintconfig",
     "lint-staged",
+    "markdownlint",
     "prettier",
     "typescript"
   ],
@@ -29,13 +30,14 @@
     "clean": "conc \"yarn:clean:*\"",
     "clean:root": "rimraf -g .eslintcache \"*.tgz\" \"*.tsbuildinfo\"",
     "clean:sub": "yarn run sub run clean",
-    "commit": "aicommits -t conventional",
     "postinstall": "husky",
     "lint": "conc -m 1 \"yarn:lint:*:check\"",
     "lint:cspell:check": "cspell lint --no-progress --show-suggestions -u \"./**/*\"",
     "lint:eslint:check": "eslint --cache --cache-strategy=content -f codeframe \"./**/*\"",
     "lint:eslint:fix": "yarn run lint:eslint:check --fix",
     "lint:fix": "conc -m 1 \"yarn:lint:cspell:check\" \"yarn:lint:*:fix\"",
+    "lint:markdown:check": "markdownlint-cli2 \"**/*.md\"",
+    "lint:markdown:fix": "markdownlint-cli2 --fix \"**/*.md\"",
     "lint:prettier:check": "yarn run prettier -cu",
     "lint:prettier:fix": "yarn run prettier -uw",
     "prettier": "prettier --cache --log-level=warn \"$@\" \"./**/*\"",
@@ -47,45 +49,47 @@
   "prettier": "@kurone-kito/prettier-config",
   "devDependencies": {
     "@commitlint/cli": "^18.6.1",
-    "@commitlint/config-conventional": "^18.6.2",
-    "@cspell/cspell-types": "^8.4.1",
-    "@cspell/eslint-plugin": "^8.4.1",
+    "@commitlint/config-conventional": "^18.6.3",
+    "@cspell/cspell-types": "^8.6.0",
+    "@cspell/eslint-plugin": "^8.6.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/markdownlint-config": "workspace:*",
     "@kurone-kito/prettier-config": "workspace:*",
     "@kurone-kito/typescript-config": "workspace:*",
-    "@typescript-eslint/eslint-plugin": "^7.0.2",
-    "@typescript-eslint/parser": "^7.0.2",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
     "@yarnpkg/sdks": "^3.1.0",
-    "aicommits": "^1.11.0",
     "concurrently": "^8.2.2",
-    "cspell": "^8.4.1",
-    "eslint": "^8.56.0",
-    "eslint-config-airbnb-typescript": "^17.1.0",
+    "cspell": "^8.6.0",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-typescript": "^18.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",
     "eslint-plugin-editorconfig": "^4.0.3",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.1.0",
+    "eslint-plugin-jsdoc": "^48.2.1",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-lodash": "^7.4.0",
-    "eslint-plugin-markdown": "^3.0.1",
+    "eslint-plugin-markdown": "^4.0.1",
+    "eslint-plugin-markdownlint": "^0.5.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react": "^7.34.0",
     "eslint-plugin-yaml": "^0.5.0",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.2",
+    "markdownlint-cli2": "^0.12.1",
     "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
-    "typescript": "~5.3.3",
+    "typescript": "~5.4.2",
     "typescript-eslint-language-service": "^5.0.5"
   },
-  "packageManager": "yarn@4.1.0",
+  "packageManager": "yarn@4.1.1",
   "engines": {
     "node": ">=18"
   },

packages/commitlint-config/README.md

@@ -12,7 +12,8 @@ npm install --save-dev \
   @kurone-kito/commitlint-config
 ```
 
-Then, create a `.commitlintrc.yml` file. If exists, merge the following configuration into it:
+Then, create a `.commitlintrc.yml` file.
+If exists, merge the following configuration into it:
 
 ```yaml
 extends:

packages/commitlint-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/commitlint-config",
-  "version": "0.8.4",
+  "version": "0.9.0",
   "description": "My commitlint configuration for general projects",
   "keywords": [
     "commitlint",
@@ -34,7 +34,7 @@
     "prepack": "conc -m 1 \"yarn:clean\" \"yarn:build\""
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^18.6.2",
+    "@commitlint/config-conventional": "^19.1.0",
     "concurrently": "^8.2.2",
     "cpy-cli": "^5.0.0",
     "js-yaml": "^4.1.0",

packages/cspell-config/README.md

@@ -13,7 +13,8 @@ npm install --save-dev \
   cspell
 ```
 
-Then, create a `cspell.config.yml` file. If exists, merge the following configuration into it:
+Then, create a `cspell.config.yml` file.
+If exists, merge the following configuration into it:
 
 ```yaml
 import:

packages/cspell-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/cspell-config",
-  "version": "0.8.4",
+  "version": "0.9.0",
   "description": "My CSpell configuration for general projects",
   "keywords": [
     "config",
@@ -41,10 +41,10 @@
     "prepack": "conc -m 1 \"yarn:clean\" \"yarn:build\""
   },
   "devDependencies": {
-    "@cspell/cspell-types": "^8.4.1",
+    "@cspell/cspell-types": "^8.6.0",
     "concurrently": "^8.2.2",
     "cpy-cli": "^5.0.0",
-    "cspell": "^8.4.1",
+    "cspell": "^8.6.0",
     "js-yaml": "^4.1.0",
     "rimraf": "^5.0.5"
   },

packages/eslint-config-base/.eslintrc.yml

@@ -1,8 +1,9 @@
 env:
-  es2022: true
+  es2024: true
   node: true
 extends:
-  - plugin:markdown/recommended
+  # see: https://github.com/eslint/eslint-plugin-markdown/issues/243
+  - plugin:markdown/recommended-legacy
   - plugin:yaml/recommended
   - plugin:json/recommended
   - plugin:editorconfig/noconflict
@@ -43,10 +44,13 @@ overrides:
       # scope of transpiling, such as in various configuration files,
       # making the `import` syntax challenging to use.
       '@typescript-eslint/explicit-module-boundary-types': 'off'
+  - extends:
+      - plugin:markdownlint/recommended
+    files:
+      - '*.md'
 parserOptions:
   ecmaFeatures:
     impliedStrict: true
-  ecmaVersion: 2022
   extraFileExtensions:
     - .json
   project:

packages/eslint-config-base/README.md

@@ -28,7 +28,8 @@ npm install --save-dev \
   eslint-plugin-yaml
 ```
 
-Then, create a `.eslintrc.yml` file. If exists, merge the following configuration into it:
+Then, create a `.eslintrc.yml` file.
+If exists, merge the following configuration into it:
 
 ```yaml
 extends:

packages/eslint-config-base/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kurone-kito/eslint-config-base",
-  "version": "0.8.4",
+  "version": "0.9.0",
   "description": "My ESLint configuration for general Node.js projects",
   "keywords": [
     "config",
@@ -37,30 +37,31 @@
   },
   "prettier": "@kurone-kito/prettier-config",
   "devDependencies": {
-    "@cspell/eslint-plugin": "^8.4.1",
+    "@cspell/eslint-plugin": "^8.6.0",
     "@kurone-kito/prettier-config": "workspace:*",
-    "@typescript-eslint/eslint-plugin": "^7.0.2",
-    "@typescript-eslint/parser": "^7.0.2",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
     "concurrently": "^8.2.2",
     "cpy-cli": "^5.0.0",
-    "eslint": "^8.56.0",
-    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-typescript": "^18.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",
     "eslint-plugin-editorconfig": "^4.0.3",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.1.0",
+    "eslint-plugin-jsdoc": "^48.2.1",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-lodash": "^7.4.0",
-    "eslint-plugin-markdown": "^3.0.1",
+    "eslint-plugin-markdown": "^4.0.1",
+    "eslint-plugin-markdownlint": "^0.5.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-yaml": "^0.5.0",
     "js-yaml": "^4.1.0",
     "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
-    "typescript": "~5.3.3"
+    "typescript": "~5.4.2"
   },
   "peerDependencies": {
     "@cspell/eslint-plugin": ">=6.x.x",
@@ -78,6 +79,7 @@
     "eslint-plugin-json": ">=3.x.x",
     "eslint-plugin-lodash": ">=7.x.x",
     "eslint-plugin-markdown": ">=3.x.x",
+    "eslint-plugin-markdownlint": ">=0.5.x",
     "eslint-plugin-node": ">=11.x.x",
     "eslint-plugin-yaml": ">=0.5.x"
   },
@@ -127,6 +129,9 @@
     "eslint-plugin-markdown": {
       "optional": true
     },
+    "eslint-plugin-markdownlint": {
+      "optional": true
+    },
     "eslint-plugin-node": {
       "optional": true
     },

packages/eslint-config-react/README.md

@@ -31,7 +31,8 @@ npm install --save-dev \
   eslint-plugin-yaml
 ```
 
-Then, create a `.eslintrc.yml` file. If exists, merge the following configuration into it:
+Then, create a `.eslintrc.yml` file.
+If exists, merge the following configuration into it:
 
 ```yaml
 extends: