Change not to use ESLint internal modules (#1322)

* Change not to use ESLint internal modules * update * remove unused scrip
vuejs · Oct 18, 2020 · d44fb18 · d44fb18
1 parent 0e5480c
commit d44fb18
Show file tree

Hide file tree

Showing 38 changed files with 69 additions and 103 deletions.
diff --git a/docs/.vuepress/components/eslint-code-block.vue b/docs/.vuepress/components/eslint-code-block.vue
@@ -124,11 +124,11 @@ export default {
     // Load linter.
     const [
       { default: Linter },
-      { default: noUndefRule },
+      { default: coreRules },
       { parseForESLint }
     ] = await Promise.all([
       import('eslint4b/dist/linter'),
-      import('eslint/lib/rules/no-undef'),
+      import('eslint4b/dist/core-rules'),
       import('espree').then(() => import('vue-eslint-parser'))
     ])
 
@@ -137,7 +137,7 @@ export default {
     for (const ruleId of Object.keys(rules)) {
       linter.defineRule(`vue/${ruleId}`, rules[ruleId])
     }
-    linter.defineRule('no-undef', noUndefRule)
+    linter.defineRule('no-undef', coreRules['no-undef'])
 
     linter.defineParser('vue-eslint-parser', { parseForESLint })
   }

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -5,6 +5,7 @@
 'use strict'
 
 const rules = require('../../tools/lib/rules')
+const path = require('path')
 
 const uncategorizedRules = rules.filter(
   (rule) =>
@@ -122,7 +123,8 @@ module.exports = {
     return {
       resolve: {
         alias: {
-          module: require.resolve('./shim/module')
+          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/docs/.vuepress/shim/eslint/lib/rules/index.js b/docs/.vuepress/shim/eslint/lib/rules/index.js
diff --git a/docs/rules/no-textarea-mustache.md b/docs/rules/no-textarea-mustache.md
@@ -27,11 +27,15 @@ This rule reports mustaches in `<textarea>`.
 
 </eslint-code-block>
 
+<div v-pre>
+
 ::: warning Note
 Interpolation on textareas (`<textarea>{{text}}</textarea>`) won't work. Use `v-model` instead.
 [https://v3.vuejs.org/guide/forms.html#multiline-text](https://v3.vuejs.org/guide/forms.html#multiline-text)
 :::
 
+</div>
+
 ## :wrench: Options
 
 Nothing.

diff --git a/docs/rules/no-unused-vars.md b/docs/rules/no-unused-vars.md
@@ -33,7 +33,7 @@ This rule report variable definitions of v-for directives or scope attributes if
 
 ## :wrench: Options
 
-```js
+```json
 {
     "vue/no-unused-vars": ["error", {
         "ignorePattern": "^_"

diff --git a/lib/rules/array-bracket-spacing.js b/lib/rules/array-bracket-spacing.js
@@ -6,7 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(
-  require('eslint/lib/rules/array-bracket-spacing'),
-  { skipDynamicArguments: true }
-)
+module.exports = wrapCoreRule('array-bracket-spacing', {
+  skipDynamicArguments: true
+})
diff --git a/lib/rules/arrow-spacing.js b/lib/rules/arrow-spacing.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/arrow-spacing'))
+module.exports = wrapCoreRule('arrow-spacing')
diff --git a/lib/rules/block-spacing.js b/lib/rules/block-spacing.js
@@ -6,6 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/block-spacing'), {
+module.exports = wrapCoreRule('block-spacing', {
   skipDynamicArguments: true
 })
diff --git a/lib/rules/brace-style.js b/lib/rules/brace-style.js
@@ -6,6 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/brace-style'), {
+module.exports = wrapCoreRule('brace-style', {
   skipDynamicArguments: true
 })
diff --git a/lib/rules/camelcase.js b/lib/rules/camelcase.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/camelcase'))
+module.exports = wrapCoreRule('camelcase')
diff --git a/lib/rules/comma-dangle.js b/lib/rules/comma-dangle.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/comma-dangle'))
+module.exports = wrapCoreRule('comma-dangle')
diff --git a/lib/rules/comma-spacing.js b/lib/rules/comma-spacing.js
@@ -6,7 +6,7 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/comma-spacing'), {
+module.exports = wrapCoreRule('comma-spacing', {
   skipDynamicArguments: true,
   skipDynamicArgumentsReport: true
 })
diff --git a/lib/rules/comma-style.js b/lib/rules/comma-style.js
@@ -6,7 +6,7 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/comma-style'), {
+module.exports = wrapCoreRule('comma-style', {
   create(_context, { coreHandlers }) {
     return {
       VSlotScopeExpression(node) {

diff --git a/lib/rules/dot-location.js b/lib/rules/dot-location.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/dot-location'))
+module.exports = wrapCoreRule('dot-location')
diff --git a/lib/rules/dot-notation.js b/lib/rules/dot-notation.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/dot-notation'))
+module.exports = wrapCoreRule('dot-notation')
diff --git a/lib/rules/eqeqeq.js b/lib/rules/eqeqeq.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/eqeqeq'))
+module.exports = wrapCoreRule('eqeqeq')
diff --git a/lib/rules/func-call-spacing.js b/lib/rules/func-call-spacing.js
@@ -6,6 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/func-call-spacing'), {
+module.exports = wrapCoreRule('func-call-spacing', {
   skipDynamicArguments: true
 })
diff --git a/lib/rules/key-spacing.js b/lib/rules/key-spacing.js
@@ -6,6 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/key-spacing'), {
+module.exports = wrapCoreRule('key-spacing', {
   skipDynamicArguments: true
 })
diff --git a/lib/rules/keyword-spacing.js b/lib/rules/keyword-spacing.js
@@ -6,6 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/keyword-spacing'), {
+module.exports = wrapCoreRule('keyword-spacing', {
   skipDynamicArguments: true
 })
diff --git a/lib/rules/no-empty-pattern.js b/lib/rules/no-empty-pattern.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/no-empty-pattern'))
+module.exports = wrapCoreRule('no-empty-pattern')
diff --git a/lib/rules/no-extra-parens.js b/lib/rules/no-extra-parens.js
@@ -7,7 +7,7 @@ const { isParenthesized } = require('eslint-utils')
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/no-extra-parens'), {
+module.exports = wrapCoreRule('no-extra-parens', {
   skipDynamicArguments: true,
   create: createForVueSyntax
 })

diff --git a/lib/rules/no-restricted-syntax.js b/lib/rules/no-restricted-syntax.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/no-restricted-syntax'))
+module.exports = wrapCoreRule('no-restricted-syntax')
diff --git a/lib/rules/no-sparse-arrays.js b/lib/rules/no-sparse-arrays.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/no-sparse-arrays'))
+module.exports = wrapCoreRule('no-sparse-arrays')
diff --git a/lib/rules/no-useless-concat.js b/lib/rules/no-useless-concat.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/no-useless-concat'))
+module.exports = wrapCoreRule('no-useless-concat')
diff --git a/lib/rules/object-curly-newline.js b/lib/rules/object-curly-newline.js
@@ -6,7 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(
-  require('eslint/lib/rules/object-curly-newline'),
-  { skipDynamicArguments: true }
-)
+module.exports = wrapCoreRule('object-curly-newline', {
+  skipDynamicArguments: true
+})
diff --git a/lib/rules/object-curly-spacing.js b/lib/rules/object-curly-spacing.js
@@ -6,7 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(
-  require('eslint/lib/rules/object-curly-spacing'),
-  { skipDynamicArguments: true }
-)
+module.exports = wrapCoreRule('object-curly-spacing', {
+  skipDynamicArguments: true
+})
diff --git a/lib/rules/object-property-newline.js b/lib/rules/object-property-newline.js
@@ -6,7 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(
-  require('eslint/lib/rules/object-property-newline'),
-  { skipDynamicArguments: true }
-)
+module.exports = wrapCoreRule('object-property-newline', {
+  skipDynamicArguments: true
+})
diff --git a/lib/rules/operator-linebreak.js b/lib/rules/operator-linebreak.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/operator-linebreak'))
+module.exports = wrapCoreRule('operator-linebreak')
diff --git a/lib/rules/prefer-template.js b/lib/rules/prefer-template.js
@@ -6,4 +6,4 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/prefer-template'))
+module.exports = wrapCoreRule('prefer-template')
diff --git a/lib/rules/space-in-parens.js b/lib/rules/space-in-parens.js
@@ -6,7 +6,7 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/space-in-parens'), {
+module.exports = wrapCoreRule('space-in-parens', {
   skipDynamicArguments: true,
   skipDynamicArgumentsReport: true
 })
diff --git a/lib/rules/space-infix-ops.js b/lib/rules/space-infix-ops.js
@@ -6,6 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/space-infix-ops'), {
+module.exports = wrapCoreRule('space-infix-ops', {
   skipDynamicArguments: true
 })
diff --git a/lib/rules/space-unary-ops.js b/lib/rules/space-unary-ops.js
@@ -6,6 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(require('eslint/lib/rules/space-unary-ops'), {
+module.exports = wrapCoreRule('space-unary-ops', {
   skipDynamicArguments: true
 })
diff --git a/lib/rules/template-curly-spacing.js b/lib/rules/template-curly-spacing.js
@@ -6,7 +6,6 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
-module.exports = wrapCoreRule(
-  require('eslint/lib/rules/template-curly-spacing'),
-  { skipDynamicArguments: true }
-)
+module.exports = wrapCoreRule('template-curly-spacing', {
+  skipDynamicArguments: true
+})
diff --git a/lib/utils/index.js b/lib/utils/index.js
@@ -108,6 +108,18 @@ const { findVariable } = require('eslint-utils')
  */
 const componentComments = new WeakMap()
 
+/** @type { Map<string, RuleModule> | null } */
+let ruleMap = null
+/**
+ * Get the core rule implementation from the rule name
+ * @param {string} name
+ * @returns {RuleModule}
+ */
+function getCoreRule(name) {
+  const map = ruleMap || (ruleMap = new (require('eslint').Linter)().getRules())
+  return map.get(name) || require(`eslint/lib/rules/${name}`)
+}
+
 /**
  * Wrap the rule context object to override methods which access to tokens (such as getTokenAfter).
  * @param {RuleContext} context The rule context object.
@@ -225,15 +237,16 @@ module.exports = {
 
   /**
    * Wrap a given core rule to apply it to Vue.js template.
-   * @param {RuleModule} coreRule The core rule implementation to wrap.
+   * @param {string} coreRuleName The name of the core rule implementation to wrap.
    * @param {Object} [options] The option of this rule.
    * @param {string[]} [options.categories] The categories of this rule.
    * @param {boolean} [options.skipDynamicArguments] If `true`, skip validation within dynamic arguments.
    * @param {boolean} [options.skipDynamicArgumentsReport] If `true`, skip report within dynamic arguments.
    * @param { (context: RuleContext, options: { coreHandlers: RuleListener }) => TemplateListener } [options.create] If define, extend core rule.
    * @returns {RuleModule} The wrapped rule implementation.
    */
-  wrapCoreRule(coreRule, options) {
+  wrapCoreRule(coreRuleName, options) {
+    const coreRule = getCoreRule(coreRuleName)
     const {
       categories,
       skipDynamicArguments,

diff --git a/package.json b/package.json
@@ -13,7 +13,6 @@
     "cover:report": "nyc report --reporter=html",
     "lint": "eslint . --rulesdir eslint-internal-rules",
     "lint:fix": "eslint . --rulesdir eslint-internal-rules --fix",
-    "pretsc": "node ./tools/setup-eslint-rule-types.js",
     "tsc": "tsc",
     "preversion": "npm test && npm run update && git add .",
     "version": "npm run lint -- --fix && git add .",

diff --git a/tools/setup-eslint-rule-types.js b/tools/setup-eslint-rule-types.js
diff --git a/typings/eslint/index.d.ts b/typings/eslint/index.d.ts
@@ -357,6 +357,9 @@ export namespace Rule {
 }
 
 export class RuleTester extends ESLintRuleTester {}
+export class Linter {
+  getRules(): Map<string, Rule.RuleModule>
+}
 
 export namespace Linter {
   type LintMessage = ESLintLinter.LintMessage