Change not to use ESLint internal modules (#23)

ota-meshi · web-flow · commit 67de93752eb5 · 2020-10-18T18:34:42.000+09:00
* Change not to use ESLint internal modules

* fix
diff --git a/.github/workflows/NodeCI.yml b/.github/workflows/NodeCI.yml
@@ -58,8 +58,6 @@ jobs:
         node-version: 10.x
     - name: Install Packages
       run: npm install
-    - name: Setup
-      run: npm run setup-types
     - name: Test
       run: npm run test:nyc
     - name: Coveralls GitHub Action
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -1,3 +1,4 @@
+const path = require('path')
 const { rules } = require("../../dist/utils/rules")
 
 function ruleToLink({
@@ -19,6 +20,7 @@ module.exports = {
             resolve: {
                 alias: {
                     module: require.resolve("./shim/module"),
+                    eslint: path.resolve(__dirname, './shim/eslint')
                 },
             },
         }
diff --git a/docs/.vuepress/shim/eslint/index.js b/docs/.vuepress/shim/eslint/index.js
@@ -0,0 +1,2 @@
+const Linter = require('eslint4b')
+module.exports = { Linter }
diff --git a/lib/rules/array-bracket-newline.ts b/lib/rules/array-bracket-newline.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/array-bracket-newline"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("array-bracket-newline")
 
 export default createRule("array-bracket-newline", {
     meta: {
diff --git a/lib/rules/array-bracket-spacing.ts b/lib/rules/array-bracket-spacing.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/array-bracket-spacing"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("array-bracket-spacing")
 
 export default createRule("array-bracket-spacing", {
     meta: {
diff --git a/lib/rules/array-element-newline.ts b/lib/rules/array-element-newline.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/array-element-newline"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("array-element-newline")
 
 export default createRule("array-element-newline", {
     meta: {
diff --git a/lib/rules/comma-dangle.ts b/lib/rules/comma-dangle.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/comma-dangle"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("comma-dangle")
 
 export default createRule("comma-dangle", {
     meta: {
diff --git a/lib/rules/comma-style.ts b/lib/rules/comma-style.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/comma-style"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("comma-style")
 
 export default createRule("comma-style", {
     meta: {
diff --git a/lib/rules/indent.ts b/lib/rules/indent.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/indent"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("indent")
 
 export default createRule("indent", {
     meta: {
diff --git a/lib/rules/key-spacing.ts b/lib/rules/key-spacing.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/key-spacing"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("key-spacing")
 
 export default createRule("key-spacing", {
     meta: {
diff --git a/lib/rules/no-dupe-keys.ts b/lib/rules/no-dupe-keys.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/no-dupe-keys"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("no-dupe-keys")
 
 export default createRule("no-dupe-keys", {
     meta: {
diff --git a/lib/rules/no-multi-str.ts b/lib/rules/no-multi-str.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/no-multi-str"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("no-multi-str")
 
 export default createRule("no-multi-str", {
     meta: {
diff --git a/lib/rules/no-octal-escape.ts b/lib/rules/no-octal-escape.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/no-octal-escape"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("no-octal-escape")
 
 export default createRule("no-octal-escape", {
     meta: {
diff --git a/lib/rules/no-sparse-arrays.ts b/lib/rules/no-sparse-arrays.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/no-sparse-arrays"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("no-sparse-arrays")
 
 export default createRule("no-sparse-arrays", {
     meta: {
diff --git a/lib/rules/no-useless-escape.ts b/lib/rules/no-useless-escape.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/no-useless-escape"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("no-useless-escape")
 
 export default createRule("no-useless-escape", {
     meta: {
diff --git a/lib/rules/object-curly-newline.ts b/lib/rules/object-curly-newline.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/object-curly-newline"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("object-curly-newline")
 
 export default createRule("object-curly-newline", {
     meta: {
diff --git a/lib/rules/object-curly-spacing.ts b/lib/rules/object-curly-spacing.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/object-curly-spacing"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("object-curly-spacing")
 
 export default createRule("object-curly-spacing", {
     meta: {
diff --git a/lib/rules/object-property-newline.ts b/lib/rules/object-property-newline.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/object-property-newline"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("object-property-newline")
 
 export default createRule("object-property-newline", {
     meta: {
diff --git a/lib/rules/quote-props.ts b/lib/rules/quote-props.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/quote-props"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("quote-props")
 
 export default createRule("quote-props", {
     meta: {
diff --git a/lib/rules/quotes.ts b/lib/rules/quotes.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/quotes"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("quotes")
 
 export default createRule("quotes", {
     meta: {
diff --git a/lib/rules/space-unary-ops.ts b/lib/rules/space-unary-ops.ts
@@ -1,5 +1,5 @@
-import coreRule from "eslint/lib/rules/space-unary-ops"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("space-unary-ops")
 
 export default createRule("space-unary-ops", {
     meta: {
diff --git a/lib/utils/index.ts b/lib/utils/index.ts
@@ -100,3 +100,19 @@ export function defineWrapperListener(
 
     return jsonListener
 }
+
+let ruleMap: Map<string, Rule.RuleModule> | null = null
+
+/**
+ * Get the core rule implementation from the rule name
+ */
+export function getCoreRule(name: string): Rule.RuleModule {
+    let map: Map<string, Rule.RuleModule>
+    if (ruleMap) {
+        map = ruleMap
+    } else {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -- load eslint
+        ruleMap = map = new (require("eslint").Linter)().getRules()
+    }
+    return map.get(name)!
+}
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
     "index.d.ts"
   ],
   "scripts": {
-    "prebuild": "npm run -s clean && npm run setup-types",
+    "prebuild": "npm run -s clean",
     "build": "npm run build:ts && npm run build:dts",
     "build:ts": "tsc --project ./tsconfig.build.json",
     "build:dts": "npm run build:dts-step1 && npm run build:dts-step2",
@@ -21,7 +21,6 @@
     "clean": "rimraf .nyc_output dist coverage",
     "lint": "eslint \"tests\" \"lib\" \"docs/.vuepress\" --ext .js,.vue,.ts",
     "eslint-fix": "eslint \"tests\" \"lib\" \"docs/.vuepress\" --ext .js,.vue,.ts --fix",
-    "pretest": "npm run setup-types",
     "test:base": "mocha --require ts-node/register \"tests/lib/**/*.ts\" --reporter dot --timeout 60000",
     "test": "npm run test:base",
     "test:nyc": "nyc --reporter=lcov npm run test:base",
@@ -35,8 +34,7 @@
     "docs-deploysetup:clean": "rimraf assets",
     "docs-deploysetup:copy": "npx cpx \"docs/\\.vuepress/dist/**\" . -u",
     "preversion": "npm test && npm run update && git add .",
-    "version": "npm run eslint-fix && git add .",
-    "setup-types": "node ./tools/setup-eslint-rule-types.js"
+    "version": "npm run eslint-fix && git add ."
   },
   "repository": {
     "type": "git",
diff --git a/tools/new-rule.ts b/tools/new-rule.ts
@@ -24,8 +24,8 @@ const logger = console
         ruleFile,
         `
 import type { AST } from "jsonc-eslint-parser"
-import coreRule from "eslint/lib/rules/${ruleId}"
-import { createRule, defineWrapperListener } from "../utils"
+import { createRule, defineWrapperListener, getCoreRule } from "../utils"
+const coreRule = getCoreRule("${ruleId}")
 
 export default createRule("${ruleId}", {
     meta: {
diff --git a/tools/setup-eslint-rule-types.js b/tools/setup-eslint-rule-types.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+const Linter = require('eslint4b')`
	`2`	`+module.exports = { Linter }`