Fix crash when used with eslint-plugin-markdown. (#29)

* Fix crash when used with eslint-plugin-markdown.

* fix

* update

Author: ota-meshi

.github/workflows/NodeCI.yml

@@ -20,6 +20,42 @@ jobs:
       run: npm run build
     - name: Lint
       run: npm run lint
+  test-for-win-integrations:
+    runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js 14
+      uses: actions/setup-node@v1
+      with:
+        node-version: 14
+    - name: Install Packages
+      run: npm install
+    - name: Test
+      run: npm run test:integrations
+  test-for-mac-integrations:
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js 14
+      uses: actions/setup-node@v1
+      with:
+        node-version: 14
+    - name: Install Packages
+      run: npm install
+    - name: Test
+      run: npm run test:integrations
+  test-for-ubuntu-integrations:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js 14
+      uses: actions/setup-node@v1
+      with:
+        node-version: 14
+    - name: Install Packages
+      run: npm install
+    - name: Test
+      run: npm run test:integrations
   test:
     runs-on: ubuntu-latest
     strategy:

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

@@ -1,4 +1,6 @@
 import type { Linter, CLIEngine } from "eslint"
+import { existsSync, statSync } from "fs"
+import { dirname } from "path"
 import type { RuleModule } from "../types"
 
 let engine: CLIEngine, ruleNames: Set<string>
@@ -17,11 +19,34 @@ function getCLIEngine() {
     return engine
 }
 
+/**
+ * Checks if the given file name can get the configuration.
+ */
+function isValidFilename(filename: string) {
+    const dir = dirname(filename)
+    if (existsSync(dir) && statSync(dir).isDirectory()) {
+        if (existsSync(filename) && statSync(filename).isDirectory()) {
+            return false
+        }
+        return true
+    }
+
+    return false
+}
+
 /**
  * Get config for the given filename
  * @param filename
  */
-function getConfig(filename: string) {
+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 getCLIEngine().getConfigForFile(filename)
 }
 

package.json

@@ -25,6 +25,8 @@
     "test": "npm run test:base",
     "test:nyc": "nyc --reporter=lcov npm run test:base",
     "test:debug": "mocha --require ts-node/register --inspect \"tests/lib/**/*.ts\" --reporter dot",
+    "pretest:integrations": "npm run build:ts",
+    "test:integrations": "mocha --require ts-node/register \"tests-integrations/lib/**/*.ts\" --reporter dot --timeout 60000",
     "update": "ts-node ./tools/update.ts && npm run eslint-fix && npm run test:nyc",
     "new": "ts-node ./tools/new-rule.ts",
     "predocs:watch": "npm run build:ts",

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

@@ -0,0 +1,15 @@
+{
+    "root": true,
+    "parserOptions": {
+        "sourceType": "module",
+        "ecmaVersion": 2015
+    },
+    "extends": [
+        "plugin:markdown/recommended",
+        "plugin:jsonc/recommended-with-json"
+    ],
+    "rules": {
+        "array-bracket-newline": "error",
+        "jsonc/auto": "error"
+    }
+}

tests-integrations/fixtures/eslint-plugin-markdown/.npmrc

@@ -0,0 +1 @@
+package-lock=false

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

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

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

@@ -0,0 +1,7 @@
+
+```json
+{
+    "arr": ["a", "b"
+    ]
+}
+```

tests-integrations/lib/eslint-plugin-markdown.ts

@@ -0,0 +1,45 @@
+import cp from "child_process"
+import assert from "assert"
+import path from "path"
+import plugin from "../../lib/index"
+
+// -----------------------------------------------------------------------------
+// Tests
+// -----------------------------------------------------------------------------
+
+const TEST_CWD = path.join(__dirname, "../fixtures/eslint-plugin-markdown")
+
+const ESLINT = path.join(TEST_CWD, `./node_modules/eslint`)
+
+describe("Integration with eslint-plugin-markdown", () => {
+    let originalCwd: string
+
+    before(() => {
+        originalCwd = process.cwd()
+        process.chdir(TEST_CWD)
+        cp.execSync("npm i", { stdio: "inherit" })
+    })
+    after(() => {
+        process.chdir(originalCwd)
+    })
+
+    it("should lint without errors", () => {
+        /* eslint-disable @typescript-eslint/ban-ts-comment, @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports -- test */
+        // @ts-ignore
+        const eslint = require(ESLINT)
+        /* eslint-enable @typescript-eslint/ban-ts-comment, @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports -- test */
+        const engine = new eslint.CLIEngine({
+            cwd: TEST_CWD,
+            extensions: [".js", ".json", ".yaml"],
+        })
+        engine.addPlugin("eslint-plugin-jsonc", plugin)
+        const r = engine.executeOnFiles(["./test.md"])
+
+        assert.strictEqual(r.results.length, 1)
+        assert.strictEqual(r.results[0].messages.length, 1)
+        assert.strictEqual(
+            r.results[0].messages[0].message,
+            "[jsonc/array-bracket-newline] There should be no linebreak before ']'.",
+        )
+    })
+})

tsconfig.build.json

@@ -1,6 +1,6 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["tests/**/*", "tools/**/*", "typings/**/*",],
+  "exclude": ["tests/**/*", "tests-integrations/lib/**/*", "tools/**/*", "typings/**/*",],
   "compilerOptions": {
     "removeComments": true,                /* Do not emit comments to output. */
   }

tsconfig.json

@@ -19,6 +19,6 @@
     },
     "esModuleInterop": true
   },
-  "include": ["lib/**/*", "tests/lib/**/*", "tools/**/*", "typings/**/*"],
+  "include": ["lib/**/*", "tests/lib/**/*", "tests-integrations/lib/**/*", "tools/**/*", "typings/**/*"],
   "exclude": ["dist/**/*"]
 }