Fix wrong auto-config when nesting config with markdown in jsonc/auto rule (#180)

* Fix wrong auto-config when nesting config with markdown in `jsonc/auto` rule

* fix

* Update tests-integrations/fixtures/eslint-plugin-markdown/package.json

Co-authored-by: JounQin <[email protected]>

* add test for json in md in md

* fix lint error

Co-authored-by: JounQin <[email protected]>

Author: ota-meshi

.eslintignore

@@ -10,6 +10,8 @@
 /tests/fixtures/**/*.json
 /tests-integrations/fixtures/eslint-plugin-markdown/test.md
 /tests-integrations/fixtures/vue-eslint-parser-option/test.json
+/tests-integrations/fixtures/eslint-plugin-markdown-nest/test.md
+/tests-integrations/fixtures/eslint-plugin-markdown-nest-for-v6/test.md
 /assets
 /index.d.ts
 !/.github

.gitignore

@@ -106,6 +106,7 @@ dist
 /typings/eslint/lib
 /dist-ts
 /index.d.ts
+/tests-integrations/fixtures/**/package-lock.json
 
 # docs
 /404.html

lib/utils/get-auto-jsonc-rules-config.ts

@@ -1,6 +1,6 @@
 import type { Linter } from "eslint"
 import { existsSync, statSync } from "fs"
-import { dirname, resolve } from "path"
+import { dirname, extname, resolve } from "path"
 import type { RuleModule } from "../types"
 
 let configResolver: (filePath: string) => Linter.Config, ruleNames: Set<string>
@@ -37,7 +37,6 @@ function getConfigResolver(): (filePath: string) => Linter.Config {
                 ),
                 eslintAllPath: require.resolve("../../conf/eslint-all.js"),
             })
-
         return (configResolver = (filePath: string) => {
             const absolutePath = resolve(process.cwd(), filePath)
             return configArrayFactory
@@ -49,12 +48,29 @@ function getConfigResolver(): (filePath: string) => Linter.Config {
         // ignore
     }
     try {
+        // For ESLint v6
+
         // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -- special
         const eslint = require("eslint")
         const engine = new eslint.CLIEngine({})
         engine.addPlugin("eslint-plugin-jsonc", plugin)
         return (configResolver = (filePath) => {
-            return engine.getConfigForFile(filePath)
+            // Adjust the file name to avoid a crash.
+            // https://github.com/ota-meshi/eslint-plugin-jsonc/issues/28
+            let targetFilePath = filePath
+            const ext = extname(filePath)
+            while (!isValidFilename(targetFilePath)) {
+                const dir = dirname(targetFilePath)
+                if (dir === targetFilePath) {
+                    return {}
+                }
+                targetFilePath = dir
+                if (ext && extname(targetFilePath) !== ext) {
+                    targetFilePath += ext
+                }
+            }
+
+            return engine.getConfigForFile(targetFilePath)
         })
     } catch {
         // ignore
@@ -64,7 +80,7 @@ function getConfigResolver(): (filePath: string) => Linter.Config {
 }
 
 /**
- * Checks if the given file name can get the configuration.
+ * Checks if the given file name can get the configuration (for ESLint v6).
  */
 function isValidFilename(filename: string) {
     const dir = dirname(filename)
@@ -83,14 +99,6 @@ function isValidFilename(filename: string) {
  * @param filename
  */
 function getConfig(filename: string): Linter.Config {
-    while (!isValidFilename(filename)) {
-        const dir = dirname(filename)
-        if (dir === filename) {
-            return {}
-        }
-        // eslint-disable-next-line no-param-reassign -- ignore
-        filename = dir
-    }
     return getConfigResolver()(filename)
 }
 

package.json

@@ -29,7 +29,7 @@
     "test": "npm run test:base",
     "test:nyc": "nyc --reporter=lcov npm run test:base",
     "test:debug": "mocha --require ts-node/register/transpile-only \"tests/lib/**/*.ts\" --reporter dot",
-    "pretest:integrations": "npm run build:ts",
+    "pretest:integrations": "npm run build:ts && npm pack",
     "test:integrations": "mocha --require ts-node/register \"tests-integrations/lib/**/*.ts\" --reporter dot --timeout 120000",
     "update": "ts-node --transpile-only ./tools/update.ts && npm run eslint-fix && npm run test:nyc",
     "update-only": "ts-node --transpile-only ./tools/update.ts",

tests-integrations/fixtures/eslint-plugin-markdown-nest-for-v6/.eslintrc.json

@@ -0,0 +1,22 @@
+{
+  "root": true,
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2015
+  },
+  "extends": [
+    "plugin:markdown/recommended"
+  ],
+  "rules": {
+    "quotes": ["error", "single"]
+  },
+  "overrides": [
+    {
+      "files": ["*.json"],
+      "extends": [
+        "plugin:jsonc/recommended-with-json"
+      ],
+      "rules": { "jsonc/auto": "error" }
+    }
+  ]
+}

tests-integrations/fixtures/eslint-plugin-markdown-nest-for-v6/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "test-for-eslint-plugin-jsonc-with-md-nest",
+  "private": true,
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-plugin-jsonc": "file:../../../eslint-plugin-jsonc-2.3.0.tgz",
+    "eslint-plugin-markdown": "^2.2.1"
+  }
+}

tests-integrations/fixtures/eslint-plugin-markdown-nest-for-v6/test.md

@@ -0,0 +1,5 @@
+```json
+{
+    "quotes": 'value'
+}
+```

tests-integrations/fixtures/eslint-plugin-markdown-nest/.eslintrc.json

@@ -0,0 +1,22 @@
+{
+  "root": true,
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2015
+  },
+  "extends": [
+    "plugin:markdown/recommended"
+  ],
+  "rules": {
+    "quotes": ["error", "single"]
+  },
+  "overrides": [
+    {
+      "files": ["*.json"],
+      "extends": [
+        "plugin:jsonc/recommended-with-json"
+      ],
+      "rules": { "jsonc/auto": "error" }
+    }
+  ]
+}

tests-integrations/fixtures/eslint-plugin-markdown-nest/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "test-for-eslint-plugin-jsonc-with-md-nest",
+  "private": true,
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^8.19.0",
+    "eslint-plugin-jsonc": "file:../../../eslint-plugin-jsonc-2.3.0.tgz",
+    "eslint-plugin-markdown": "^2.2.1"
+  }
+}

tests-integrations/fixtures/eslint-plugin-markdown-nest/test.md

@@ -0,0 +1,13 @@
+```json
+{
+    "quotes": 'value'
+}
+```
+
+````md
+```json
+{
+  "quotes": 'value'
+}
+```
+````