Improve compatibility with ESLint v9 (#2331)

vuejs · Nov 29, 2023 · 7b7b4ce · 7b7b4ce
1 parent 022afb5
commit 7b7b4ce
Show file tree

Hide file tree

Showing 62 changed files with 290 additions and 165 deletions.
diff --git a/docs/.vitepress/build-system/shim/eslint/use-at-your-own-risk.mjs b/docs/.vitepress/build-system/shim/eslint/use-at-your-own-risk.mjs
@@ -0,0 +1,3 @@
+export default {
+  /* empty */
+}
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -145,6 +145,10 @@ export default async () => {
       plugins: [vitePluginRequireResolve(), viteCommonjs()],
       resolve: {
         alias: {
+          'eslint/use-at-your-own-risk': path.join(
+            dirname,
+            './build-system/shim/eslint/use-at-your-own-risk.mjs'
+          ),
           eslint: path.join(dirname, './build-system/shim/eslint.mjs'),
           assert: path.join(dirname, './build-system/shim/assert.mjs'),
           path: path.join(dirname, './build-system/shim/path.mjs'),

diff --git a/eslint.config.js b/eslint.config.js
@@ -160,6 +160,20 @@ module.exports = [
       'dot-notation': 'error',
       'arrow-body-style': 'error',
 
+      'no-restricted-properties': [
+        'error',
+        {
+          object: 'context',
+          property: 'parserServices',
+          message: 'Use sourceCode.parserServices'
+        },
+        {
+          object: 'context',
+          property: 'getScope',
+          message: 'Use utils.getScope'
+        }
+      ],
+
       'unicorn/consistent-function-scoping': [
         'error',
         { checkArrowFunctions: false }

diff --git a/lib/rules/block-order.js b/lib/rules/block-order.js
@@ -106,9 +106,10 @@ module.exports = {
     function getOrderElement(element) {
       return orders.find((o) => o.selector.test(element))
     }
+    const sourceCode = context.getSourceCode()
     const documentFragment =
-      context.parserServices.getDocumentFragment &&
-      context.parserServices.getDocumentFragment()
+      sourceCode.parserServices.getDocumentFragment &&
+      sourceCode.parserServices.getDocumentFragment()
 
     function getTopLevelHTMLElements() {
       if (documentFragment) {

diff --git a/lib/rules/block-tag-newline.js b/lib/rules/block-tag-newline.js
@@ -84,15 +84,14 @@ module.exports = {
   },
   /** @param {RuleContext} context */
   create(context) {
+    const sourceCode = context.getSourceCode()
     const df =
-      context.parserServices.getDocumentFragment &&
-      context.parserServices.getDocumentFragment()
+      sourceCode.parserServices.getDocumentFragment &&
+      sourceCode.parserServices.getDocumentFragment()
     if (!df) {
       return {}
     }
 
-    const sourceCode = context.getSourceCode()
-
     /**
      * @param {VStartTag} startTag
      * @param {string} beforeText

diff --git a/lib/rules/comment-directive.js b/lib/rules/comment-directive.js
@@ -313,9 +313,10 @@ module.exports = {
     const options = context.options[0] || {}
     /** @type {boolean} */
     const reportUnusedDisableDirectives = options.reportUnusedDisableDirectives
+    const sourceCode = context.getSourceCode()
     const documentFragment =
-      context.parserServices.getDocumentFragment &&
-      context.parserServices.getDocumentFragment()
+      sourceCode.parserServices.getDocumentFragment &&
+      sourceCode.parserServices.getDocumentFragment()
 
     return {
       Program(node) {

diff --git a/lib/rules/component-name-in-template-casing.js b/lib/rules/component-name-in-template-casing.js
@@ -86,9 +86,10 @@ module.exports = {
     /** @type {string[]} */
     const globals = (options.globals || []).map(casing.pascalCase)
     const registeredComponentsOnly = options.registeredComponentsOnly !== false
+    const sourceCode = context.getSourceCode()
     const tokens =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
 
     /** @type { Set<string> } */
     const registeredComponents = new Set(globals)

diff --git a/lib/rules/custom-event-name-casing.js b/lib/rules/custom-event-name-casing.js
@@ -210,7 +210,10 @@ module.exports = {
               return
             }
             // const emit = defineEmits()
-            const variable = findVariable(context.getScope(), emitParam)
+            const variable = findVariable(
+              utils.getScope(context, emitParam),
+              emitParam
+            )
             if (!variable) {
               return
             }
@@ -251,7 +254,10 @@ module.exports = {
               }
               const emitParam = emitProperty.value
               // `setup(props, {emit})`
-              const variable = findVariable(context.getScope(), emitParam)
+              const variable = findVariable(
+                utils.getScope(context, emitParam),
+                emitParam
+              )
               if (!variable) {
                 return
               }
@@ -260,7 +266,10 @@ module.exports = {
               }
             } else {
               // `setup(props, context)`
-              const variable = findVariable(context.getScope(), contextParam)
+              const variable = findVariable(
+                utils.getScope(context, contextParam),
+                contextParam
+              )
               if (!variable) {
                 return
               }

diff --git a/lib/rules/first-attribute-linebreak.js b/lib/rules/first-attribute-linebreak.js
@@ -39,9 +39,10 @@ module.exports = {
     const multiline =
       (context.options[0] && context.options[0].multiline) || 'below'
 
+    const sourceCode = context.getSourceCode()
     const template =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
 
     /**
      * Report attribute

diff --git a/lib/rules/html-closing-bracket-newline.js b/lib/rules/html-closing-bracket-newline.js
@@ -59,9 +59,10 @@ module.exports = {
       },
       context.options[0] || {}
     )
+    const sourceCode = context.getSourceCode()
     const template =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
 
     return utils.defineDocumentVisitor(context, {
       /** @param {VStartTag | VEndTag} node */

diff --git a/lib/rules/html-closing-bracket-spacing.js b/lib/rules/html-closing-bracket-spacing.js
@@ -80,8 +80,8 @@ module.exports = {
   create(context) {
     const sourceCode = context.getSourceCode()
     const tokens =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
     const options = parseOptions(context.options[0], tokens)
 
     return utils.defineDocumentVisitor(context, {

diff --git a/lib/rules/html-indent.js b/lib/rules/html-indent.js
@@ -11,9 +11,10 @@ const utils = require('../utils')
 module.exports = {
   /** @param {RuleContext} context */
   create(context) {
+    const sourceCode = context.getSourceCode()
     const tokenStore =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
     const visitor = indentCommon.defineVisitor(context, tokenStore, {
       baseIndent: 1
     })

diff --git a/lib/rules/html-self-closing.js b/lib/rules/html-self-closing.js
@@ -159,7 +159,7 @@ module.exports = {
               },
               fix(fixer) {
                 const tokens =
-                  context.parserServices.getTemplateBodyTokenStore()
+                  sourceCode.parserServices.getTemplateBodyTokenStore()
                 const close = tokens.getLastToken(node.startTag)
                 if (close.type !== 'HTMLTagClose') {
                   return null
@@ -183,7 +183,7 @@ module.exports = {
               },
               fix(fixer) {
                 const tokens =
-                  context.parserServices.getTemplateBodyTokenStore()
+                  sourceCode.parserServices.getTemplateBodyTokenStore()
                 const close = tokens.getLastToken(node.startTag)
                 if (close.type !== 'HTMLSelfClosingTagClose') {
                   return null

diff --git a/lib/rules/max-attributes-per-line.js b/lib/rules/max-attributes-per-line.js
@@ -124,8 +124,8 @@ module.exports = {
     const multilineMaximum = configuration.multiline
     const singlelinemMaximum = configuration.singleline
     const template =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
 
     return utils.defineTemplateBodyVisitor(context, {
       VStartTag(node) {

diff --git a/lib/rules/max-len.js b/lib/rules/max-len.js
@@ -307,8 +307,8 @@ module.exports = {
       const scriptTokens = sourceCode.ast.tokens
       const scriptComments = sourceCode.getAllComments()
 
-      if (context.parserServices.getTemplateBodyTokenStore && templateBody) {
-        const tokenStore = context.parserServices.getTemplateBodyTokenStore()
+      if (sourceCode.parserServices.getTemplateBodyTokenStore && templateBody) {
+        const tokenStore = sourceCode.parserServices.getTemplateBodyTokenStore()
 
         const templateTokens = tokenStore.getTokens(templateBody, {
           includeComments: true

diff --git a/lib/rules/max-lines-per-block.js b/lib/rules/max-lines-per-block.js
@@ -65,9 +65,10 @@ module.exports = {
     }
 
     const code = context.getSourceCode()
+    const sourceCode = context.getSourceCode()
     const documentFragment =
-      context.parserServices.getDocumentFragment &&
-      context.parserServices.getDocumentFragment()
+      sourceCode.parserServices.getDocumentFragment &&
+      sourceCode.parserServices.getDocumentFragment()
 
     function getTopLevelHTMLElements() {
       if (documentFragment) {

diff --git a/lib/rules/multiline-html-element-content-newline.js b/lib/rules/multiline-html-element-content-newline.js
@@ -98,10 +98,10 @@ module.exports = {
     const ignores = options.ignores
     const ignoreWhenEmpty = options.ignoreWhenEmpty
     const allowEmptyLines = options.allowEmptyLines
-    const template =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
     const sourceCode = context.getSourceCode()
+    const template =
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
 
     /** @type {VElement | null} */
     let inIgnoreElement = null

diff --git a/lib/rules/mustache-interpolation-spacing.js b/lib/rules/mustache-interpolation-spacing.js
@@ -30,9 +30,10 @@ module.exports = {
   /** @param {RuleContext} context */
   create(context) {
     const options = context.options[0] || 'always'
+    const sourceCode = context.getSourceCode()
     const template =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
 
     return utils.defineTemplateBodyVisitor(context, {
       /** @param {VExpressionContainer} node */

diff --git a/lib/rules/next-tick-style.js b/lib/rules/next-tick-style.js
@@ -43,7 +43,10 @@ function getVueNextTickCallExpression(identifier, context) {
     identifier.parent.type === 'CallExpression' &&
     identifier.parent.callee === identifier
   ) {
-    const variable = findVariable(context.getScope(), identifier)
+    const variable = findVariable(
+      utils.getScope(context, identifier),
+      identifier
+    )
 
     if (variable != null && variable.defs.length === 1) {
       const def = variable.defs[0]

diff --git a/lib/rules/no-async-in-computed-properties.js b/lib/rules/no-async-in-computed-properties.js
@@ -260,8 +260,9 @@ module.exports = {
 
     return utils.compositingVisitors(
       {
-        Program() {
-          const tracker = new ReferenceTracker(context.getScope())
+        /** @param {Program} program */
+        Program(program) {
+          const tracker = new ReferenceTracker(utils.getScope(context, program))
           const traceMap = utils.createCompositionApiTraceMap({
             [ReferenceTracker.ESM]: true,
             computed: {

diff --git a/lib/rules/no-child-content.js b/lib/rules/no-child-content.js
@@ -123,8 +123,8 @@ module.exports = {
         if (elementNode.endTag === null) {
           return
         }
-
-        const tokenStore = context.parserServices.getTemplateBodyTokenStore()
+        const sourceCode = context.getSourceCode()
+        const tokenStore = sourceCode.parserServices.getTemplateBodyTokenStore()
         const elementComments = tokenStore.getTokensBetween(
           elementNode.startTag,
           elementNode.endTag,

diff --git a/lib/rules/no-dupe-keys.js b/lib/rules/no-dupe-keys.js
@@ -118,7 +118,10 @@ module.exports = {
           for (const prop of props) {
             if (!prop.propName) continue
 
-            const variable = findVariable(context.getScope(), prop.propName)
+            const variable = findVariable(
+              utils.getScope(context, node),
+              prop.propName
+            )
             if (!variable || variable.defs.length === 0) continue
 
             if (
@@ -149,7 +152,7 @@ module.exports = {
      */
     function extractReferences(node) {
       if (node.type === 'Identifier') {
-        const variable = findVariable(context.getScope(), node)
+        const variable = findVariable(utils.getScope(context, node), node)
         if (!variable) {
           return []
         }

diff --git a/lib/rules/no-dupe-v-else-if.js b/lib/rules/no-dupe-v-else-if.js
@@ -83,9 +83,10 @@ module.exports = {
   },
   /** @param {RuleContext} context */
   create(context) {
+    const sourceCode = context.getSourceCode()
     const tokenStore =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
     /**
      * Determines whether the two given nodes are considered to be equal. In particular, given that the nodes
      * represent expressions in a boolean context, `||` and `&&` can be considered as commutative operators.

diff --git a/lib/rules/no-empty-component-block.js b/lib/rules/no-empty-component-block.js
@@ -57,10 +57,11 @@ module.exports = {
    * @returns {RuleListener} AST event handlers.
    */
   create(context) {
-    if (!context.parserServices.getDocumentFragment) {
+    const sourceCode = context.getSourceCode()
+    if (!sourceCode.parserServices.getDocumentFragment) {
       return {}
     }
-    const documentFragment = context.parserServices.getDocumentFragment()
+    const documentFragment = sourceCode.parserServices.getDocumentFragment()
     if (!documentFragment) {
       return {}
     }

diff --git a/lib/rules/no-expose-after-await.js b/lib/rules/no-expose-after-await.js
@@ -192,7 +192,10 @@ module.exports = {
             // `setup(props, {emit})`
             const variable =
               exposeParam.type === 'Identifier'
-                ? findVariable(context.getScope(), exposeParam)
+                ? findVariable(
+                    utils.getScope(context, exposeParam),
+                    exposeParam
+                  )
                 : null
             if (!variable) {
               return
@@ -205,7 +208,10 @@ module.exports = {
             }
           } else if (contextParam.type === 'Identifier') {
             // `setup(props, context)`
-            const variable = findVariable(context.getScope(), contextParam)
+            const variable = findVariable(
+              utils.getScope(context, contextParam),
+              contextParam
+            )
             if (!variable) {
               return
             }

diff --git a/lib/rules/no-extra-parens.js b/lib/rules/no-extra-parens.js
@@ -84,10 +84,11 @@ function isIIFE(node) {
  * @returns {TemplateListener} AST event handlers.
  */
 function createForVueSyntax(context) {
-  if (!context.parserServices.getTemplateBodyTokenStore) {
+  const sourceCode = context.getSourceCode()
+  if (!sourceCode.parserServices.getTemplateBodyTokenStore) {
     return {}
   }
-  const tokenStore = context.parserServices.getTemplateBodyTokenStore()
+  const tokenStore = sourceCode.parserServices.getTemplateBodyTokenStore()
 
   /**
    * Checks if the given node turns into a filter when unwraped.

diff --git a/lib/rules/no-lifecycle-after-await.js b/lib/rules/no-lifecycle-after-await.js
@@ -60,8 +60,9 @@ module.exports = {
 
     return utils.compositingVisitors(
       {
-        Program() {
-          const tracker = new ReferenceTracker(context.getScope())
+        /** @param {Program} program */
+        Program(program) {
+          const tracker = new ReferenceTracker(utils.getScope(context, program))
           const traceMap = {
             /** @type {TraceMap} */
             vue: {