Use new ESLint API (#654)

ota-meshi · web-flow · commit 5ac88c2f9184 · 2023-10-09T12:46:23.000+02:00
See https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/
diff --git a/.changeset/strong-carrots-arrive.md b/.changeset/strong-carrots-arrive.md
@@ -0,0 +1,5 @@
+---
+"eslint-plugin-regexp": patch
+---
+
+Use new ESLint API
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -43,6 +43,35 @@ module.exports = {
                 ],
             },
         ],
+        // See https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/
+        "no-restricted-properties": [
+            "error",
+            {
+                object: "context",
+                property: "getSourceCode",
+                message: "Please use `context.sourceCode` instead.",
+            },
+            {
+                object: "context",
+                property: "getFilename",
+                message: "Please use `context.filename` instead.",
+            },
+            {
+                object: "context",
+                property: "getCwd",
+                message: "Please use `context.cwd` instead.",
+            },
+            {
+                object: "context",
+                property: "getScope",
+                message: "Please use `sourceCode.getScope(node)` instead.",
+            },
+            {
+                object: "context",
+                property: "parserServices",
+                message: "Please use `sourceCode.parserServices` instead.",
+            },
+        ],
 
         // regexp next recommended
         "regexp/no-contradiction-with-assertion": "error",
diff --git a/lib/rules/match-any.ts b/lib/rules/match-any.ts
@@ -57,7 +57,7 @@ export default createRule("match-any", {
         type: "suggestion", // "problem",
     },
     create(context) {
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
         const allowList: Allowed[] = context.options[0]?.allows ?? [
             OPTION_SS1,
             OPTION_DOTALL,
diff --git a/lib/rules/no-control-character.ts b/lib/rules/no-control-character.ts
@@ -66,7 +66,7 @@ export default createRule("no-control-character", {
                 // We are only interested in control escapes in RegExp literals
                 const range = patternSource.getReplaceRange(char)?.range
                 const sourceRaw = range
-                    ? context.getSourceCode().text.slice(...range)
+                    ? context.sourceCode.text.slice(...range)
                     : char.raw
 
                 if (
diff --git a/lib/rules/no-invisible-character.ts b/lib/rules/no-invisible-character.ts
@@ -24,7 +24,7 @@ export default createRule("no-invisible-character", {
         type: "suggestion", // "problem",
     },
     create(context) {
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         function createLiteralVisitor({
             node,
diff --git a/lib/rules/no-legacy-features.ts b/lib/rules/no-legacy-features.ts
@@ -91,8 +91,8 @@ export default createRule("no-legacy-features", {
         return {
             ...(staticProperties.length
                 ? {
-                      Program() {
-                          const scope = context.getScope()
+                      Program(program) {
+                          const scope = context.sourceCode.getScope(program)
                           const tracker = new ReferenceTracker(scope)
 
                           const regexpTraceMap: TYPES.TraceMap = {}
diff --git a/lib/rules/no-useless-dollar-replacements.ts b/lib/rules/no-useless-dollar-replacements.ts
@@ -42,7 +42,7 @@ export default createRule("no-useless-dollar-replacements", {
     },
     create(context) {
         const typeTracer = createTypeTracker(context)
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         function verify(
             patternNode: Pattern | RegExpLiteral,
diff --git a/lib/rules/no-useless-flag.ts b/lib/rules/no-useless-flag.ts
@@ -713,7 +713,7 @@ function createRegExpReferenceExtractVisitor(
  * Create visitor for verify unnecessary flags of owned RegExp literals
  */
 function createOwnedRegExpFlagsVisitor(context: Rule.RuleContext) {
-    const sourceCode = context.getSourceCode()
+    const sourceCode = context.sourceCode
 
     /** Remove the flags of the given literal */
     function removeFlags(node: RegExpLiteral): void {
diff --git a/lib/rules/prefer-escape-replacement-dollar-char.ts b/lib/rules/prefer-escape-replacement-dollar-char.ts
@@ -19,7 +19,7 @@ export default createRule("prefer-escape-replacement-dollar-char", {
     },
     create(context) {
         const typeTracer = createTypeTracker(context)
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         function verify(replacement: Literal) {
             for (const element of parseReplacements(context, replacement)) {
diff --git a/lib/rules/prefer-named-replacement.ts b/lib/rules/prefer-named-replacement.ts
@@ -26,7 +26,7 @@ export default createRule("prefer-named-replacement", {
     },
     create(context) {
         const strictTypes = context.options[0]?.strictTypes ?? true
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         function createVisitor(
             regexpContext: RegExpContext,
diff --git a/lib/rules/prefer-range.ts b/lib/rules/prefer-range.ts
@@ -41,7 +41,7 @@ export default createRule("prefer-range", {
             context.options[0]?.target,
             context,
         )
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         type CharacterGroup = {
             min: Character
diff --git a/lib/rules/prefer-regexp-test.ts b/lib/rules/prefer-regexp-test.ts
@@ -29,7 +29,7 @@ export default createRule("prefer-regexp-test", {
         type: "suggestion", // "problem",
     },
     create(context) {
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
         const typeTracer = createTypeTracker(context)
 
         return {
diff --git a/lib/rules/prefer-result-array-groups.ts b/lib/rules/prefer-result-array-groups.ts
@@ -37,7 +37,7 @@ export default createRule("prefer-result-array-groups", {
     },
     create(context) {
         const strictTypes = context.options[0]?.strictTypes ?? true
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         function createVisitor(
             regexpContext: RegExpContext,
diff --git a/lib/utils/ast-utils/pattern-source.ts b/lib/utils/ast-utils/pattern-source.ts
@@ -258,7 +258,7 @@ export class PatternSource {
             return PatternSource.fromRegExpLiteral(context, expression)
         }
 
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         const flat = flattenPlus(context, expression)
 
@@ -306,7 +306,7 @@ export class PatternSource {
         source: string,
         flags: string,
     ): PatternSource {
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         return new PatternSource(
             sourceCode,
@@ -325,7 +325,7 @@ export class PatternSource {
         context: Rule.RuleContext,
         expression: RegExpLiteral,
     ): PatternSource {
-        const sourceCode = context.getSourceCode()
+        const sourceCode = context.sourceCode
 
         return new PatternSource(
             sourceCode,
diff --git a/lib/utils/ast-utils/utils.ts b/lib/utils/ast-utils/utils.ts
@@ -160,7 +160,7 @@ export function getScope(
     currentNode: Node,
 ): Scope.Scope {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any -- ignore
-    const scopeManager: Scope.ScopeManager = (context.getSourceCode() as any)
+    const scopeManager: Scope.ScopeManager = (context.sourceCode as any)
         .scopeManager
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any -- ignore
@@ -285,7 +285,7 @@ export function parseReplacements(
     context: Rule.RuleContext,
     node: Literal,
 ): ReplacementElement[] {
-    const stringLiteral = parseStringLiteral(context.getSourceCode().text, {
+    const stringLiteral = parseStringLiteral(context.sourceCode.text, {
         start: node.range![0],
         end: node.range![1],
     })
diff --git a/lib/utils/index.ts b/lib/utils/index.ts
@@ -263,7 +263,7 @@ export function defineRegexpVisitor(
     context: Rule.RuleContext,
     rule: DefineRegexpVisitorRule,
 ): RuleListener {
-    const programNode = context.getSourceCode().ast
+    const programNode = context.sourceCode.ast
 
     let visitor: RuleListener
     let rules = regexpRules.get(programNode)
@@ -410,8 +410,10 @@ function buildRegexpVisitor(
                 },
             )
         },
-        Program() {
-            const tracker = new ReferenceTracker(context.getScope())
+        Program(program) {
+            const tracker = new ReferenceTracker(
+                context.sourceCode.getScope(program),
+            )
 
             // Iterate calls of RegExp.
             // E.g., `new RegExp()`, `RegExp()`, `new window.RegExp()`,
@@ -631,7 +633,7 @@ function buildRegExpContextBase({
     flags: ReadonlyFlags
     parsedPattern: Pattern
 }): RegExpContextBase {
-    const sourceCode = context.getSourceCode()
+    const sourceCode = context.sourceCode
 
     let cacheUsageOfPattern: UsageOfPattern | null = null
     const cacheCapturingGroupReferenceMap = new Map<
@@ -734,7 +736,7 @@ function buildUnparsableRegExpContextBase({
     flagsNode: ESTree.Expression | null
     ownsFlags: boolean
 }): UnparsableRegExpContextBase {
-    const sourceCode = context.getSourceCode()
+    const sourceCode = context.sourceCode
     const flags = toCache(originalFlags)
 
     return {
diff --git a/lib/utils/ts-utils/index.ts b/lib/utils/ts-utils/index.ts
@@ -12,16 +12,17 @@ export function getTypeScriptTools(context: Rule.RuleContext): {
     usedTS: boolean
     hasFullTypeInformation: boolean
 } {
+    const sourceCode = context.sourceCode
     const ts = getTypeScript()
     const tsNodeMap: ReadonlyMap<unknown, TS.Node> | undefined =
-        context.parserServices.esTreeNodeToTSNodeMap
+        sourceCode.parserServices.esTreeNodeToTSNodeMap
     const usedTS = Boolean(ts && tsNodeMap)
     const hasFullTypeInformation =
-        usedTS && context.parserServices.hasFullTypeInformation !== false
+        usedTS && sourceCode.parserServices.hasFullTypeInformation !== false
     const checker: TS.TypeChecker | null =
         (hasFullTypeInformation &&
-            context.parserServices.program &&
-            context.parserServices.program.getTypeChecker()) ||
+            sourceCode.parserServices.program &&
+            sourceCode.parserServices.program.getTypeChecker()) ||
         null
 
     return {
diff --git a/lib/utils/type-tracker/index.ts b/lib/utils/type-tracker/index.ts
@@ -66,7 +66,7 @@ const cacheTypeTracker = new WeakMap<ES.Program, TypeTracker>()
  * Create Type tracker
  */
 export function createTypeTracker(context: Rule.RuleContext): TypeTracker {
-    const programNode = context.getSourceCode().ast
+    const programNode = context.sourceCode.ast
     const cache = cacheTypeTracker.get(programNode)
     if (cache) {
         return cache
diff --git a/lib/utils/type-tracker/jsdoc/index.ts b/lib/utils/type-tracker/jsdoc/index.ts
@@ -112,7 +112,7 @@ export function getJSDoc(
     node: ES.Expression | ES.VariableDeclarator | ES.FunctionDeclaration,
     context: Rule.RuleContext,
 ): JSDoc | null {
-    const sourceCode = context.getSourceCode()
+    const sourceCode = context.sourceCode
     const jsdoc = findJSDocComment(node, sourceCode)
     if (jsdoc) {
         try {
diff --git a/lib/utils/type-tracker/utils.ts b/lib/utils/type-tracker/utils.ts
@@ -29,5 +29,5 @@ export function isParenthesized(
     context: Rule.RuleContext,
     node: ES.Node,
 ): boolean {
-    return eslintUtils.isParenthesized(node, context.getSourceCode())
+    return eslintUtils.isParenthesized(node, context.sourceCode)
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/tests/lib/utils/ast-utils/extract-expression-references.ts b/tests/lib/utils/ast-utils/extract-expression-references.ts
diff --git a/tests/lib/utils/ast-utils/extract-property-references.ts b/tests/lib/utils/ast-utils/extract-property-references.ts
diff --git a/tests/lib/utils/get-usage-of-pattern.ts b/tests/lib/utils/get-usage-of-pattern.ts
diff --git a/tests/lib/utils/type-tracker/test-utils.ts b/tests/lib/utils/type-tracker/test-utils.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"eslint-plugin-regexp": patch
 +---
++
 +Use new ESLint API