Skip to content

Commit a283662

Browse files
MichaelDeBoeyMichaelDeBoey
committed
feat: add ESLint v9 compatibility layer
1 parent 3ee07fc commit a283662

10 files changed

+109
-83
lines changed

‎.eslintrc.js

+23
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,29 @@ module.exports = {
77
"plugin:@eslint-community/mysticatea/es2015",
88
"plugin:@eslint-community/mysticatea/+eslint-plugin",
99
],
10+
rules: {
11+
"no-restricted-properties": [
12+
"error",
13+
{
14+
object: "context",
15+
property: "getDeclaredVariables",
16+
message:
17+
"If you are using it in a test case, use test/test-lib/eslint-compat.mjs#getDeclaredVariables instead. Other than that, the API should also be compatible with ESLint v9.",
18+
},
19+
{
20+
object: "context",
21+
property: "getSourceCode",
22+
message:
23+
"If you are using it in a test case, use test/test-lib/eslint-compat.mjs#getSourceCode instead. Other than that, the API should also be compatible with ESLint v9.",
24+
},
25+
{
26+
object: "context",
27+
property: "getScope",
28+
message:
29+
"If you are using it in a test case, use test/test-lib/eslint-compat.mjs#getScope instead. Other than that, the API should also be compatible with ESLint v9.",
30+
},
31+
],
32+
},
1033
overrides: [
1134
{
1235
files: ["lib/utils.js", "scripts/*.js"],

‎lib/eslint-compat.js

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
"use strict"
2+
3+
function getDeclaredVariables(context, node) {
4+
return (
5+
getSourceCode(context).getDeclaredVariables?.(node) ??
6+
context.getDeclaredVariables(node)
7+
)
8+
}
9+
10+
function getSourceCode(context) {
11+
return context.sourceCode ?? context.getSourceCode()
12+
}
13+
14+
function getScope(context, node) {
15+
return getSourceCode(context).getScope?.(node) ?? context.getScope()
16+
}
17+
18+
module.exports = {
19+
getDeclaredVariables,
20+
getSourceCode,
21+
getScope,
22+
}

‎lib/rules/arrow-parens.js

+9-14
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
/**
2-
* @author Toru Nagashima
3-
* @copyright 2015 Toru Nagashima. All rights reserved.
4-
* See LICENSE file in root directory for full license.
5-
*/
61
"use strict"
72

3+
const { getSourceCode } = require("../eslint-compat")
4+
85
/**
9-
* Checks whether or not a given token is `(`.
6+
* Checks whether a given token is `(`.
107
* @param {Token} token - A token to check.
118
* @returns {boolean} `true` when the token is `(`.
129
*/
@@ -15,7 +12,7 @@ function isOpenParen(token) {
1512
}
1613

1714
/**
18-
* Checks whether or not given two tokens are at a same line.
15+
* Checks whether given two tokens are at a same line.
1916
* @param {Token} a - A left token.
2017
* @param {Token} b - A right token.
2118
* @returns {boolean} `true` when the tokens are at a same line.
@@ -43,12 +40,11 @@ module.exports = {
4340
type: "suggestion",
4441
},
4542
create(context) {
43+
const sourceCode = getSourceCode(context)
4644
return {
4745
ArrowFunctionExpression(node) {
48-
const first = context
49-
.getSourceCode()
50-
.getFirstToken(node, node.async ? 1 : 0)
51-
const before = context.getSourceCode().getTokenBefore(first)
46+
const first = sourceCode.getFirstToken(node, node.async ? 1 : 0)
47+
const before = sourceCode.getTokenBefore(first)
5248

5349
if (isOpenParen(first)) {
5450
if (
@@ -63,9 +59,8 @@ module.exports = {
6359
fix(fixer) {
6460
const id = node.params[0]
6561
const begin = first.range[0]
66-
const end = context
67-
.getSourceCode()
68-
.getTokenAfter(id).range[1]
62+
const end =
63+
sourceCode.getTokenAfter(id).range[1]
6964

7065
return fixer.replaceTextRange(
7166
[begin, end],

‎lib/rules/block-scoped-var.js

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
/**
2-
* @author Toru Nagashima
3-
* @copyright 2015 Toru Nagashima. All rights reserved.
4-
* See LICENSE file in root directory for full license.
5-
*/
61
"use strict"
72

3+
const { getDeclaredVariables } = require("../eslint-compat")
4+
85
//------------------------------------------------------------------------------
96
// Helpers
107
//------------------------------------------------------------------------------
@@ -15,7 +12,7 @@ const containerNodeType =
1512
/^(?:For(?:In|Of)?Statement|(?:Arrow)?Function(?:Declaration|Expression))$/u
1613

1714
/**
18-
* Checks whether or not a given definition should be skipped.
15+
* Checks whether a given definition should be skipped.
1916
* @param {escope.Variable.DefEntry} def - A definition to check.
2017
* @param {escope.Variable.DefEntry[]} defs - A definition list which includes `def`.
2118
* @param {escope.Variable} variable - A variable which is defined by the definition.
@@ -180,7 +177,7 @@ class PseudoScope {
180177
}
181178

182179
/**
183-
* Turns an used flag on.
180+
* Turns a used flag on.
184181
* @returns {void}
185182
*/
186183
markAsUsed() {
@@ -213,12 +210,12 @@ module.exports = {
213210
},
214211
create(context) {
215212
/**
216-
* Finds and reports references which are outside of valid scopes.
213+
* Finds and reports references which are outside valid scopes.
217214
* @param {ASTNode} node - A node to get variables.
218215
* @returns {void}
219216
*/
220217
function checkForVariables(node) {
221-
const variables = context.getDeclaredVariables(node)
218+
const variables = getDeclaredVariables(context, node)
222219
for (const variable of variables) {
223220
const defs = variable.defs
224221
const lastDef = defs[defs.length - 1]
@@ -235,7 +232,7 @@ module.exports = {
235232
continue
236233
}
237234

238-
// Check whether or not any reading reference exists.
235+
// Check whether any reading reference exists.
239236
// And while it does, warn references which does not belong to any
240237
// scope.
241238
let hasReadRef = false

‎lib/rules/no-instanceof-array.js

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
4-
* See LICENSE file in root directory for full license.
5-
*/
61
"use strict"
72

3+
const { getScope, getSourceCode } = require("../eslint-compat")
4+
85
//------------------------------------------------------------------------------
96
// Rule Definition
107
//------------------------------------------------------------------------------
@@ -26,7 +23,7 @@ module.exports = {
2623
},
2724

2825
create(context) {
29-
const sourceCode = context.getSourceCode()
26+
const sourceCode = getSourceCode(context)
3027

3128
/**
3229
* Checks whether the given node is RHS of instanceof.
@@ -43,8 +40,8 @@ module.exports = {
4340
}
4441

4542
return {
46-
"Program:exit"() {
47-
const globalScope = context.getScope()
43+
"Program:exit"(globalNode) {
44+
const globalScope = getScope(context, globalNode)
4845
const variable = globalScope.set.get("Array")
4946

5047
// Skip if undefined or shadowed

‎lib/rules/no-instanceof-wrapper.js

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
4-
* See LICENSE file in root directory for full license.
5-
*/
61
"use strict"
72

3+
const { getScope, getSourceCode } = require("../eslint-compat")
4+
85
//------------------------------------------------------------------------------
96
// Rule Definition
107
//------------------------------------------------------------------------------
@@ -26,7 +23,7 @@ module.exports = {
2623
},
2724

2825
create(context) {
29-
const sourceCode = context.getSourceCode()
26+
const sourceCode = getSourceCode(context)
3027
const targetTypes = [
3128
"Boolean",
3229
"Number",
@@ -51,8 +48,8 @@ module.exports = {
5148
}
5249

5350
return {
54-
"Program:exit"() {
55-
const globalScope = context.getScope()
51+
"Program:exit"(globalNode) {
52+
const globalScope = getScope(context, globalNode)
5653

5754
for (const ctorName of targetTypes) {
5855
const typeName = ctorName.toLowerCase()

‎lib/rules/no-this-in-static.js

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
4-
* See LICENSE file in root directory for full license.
5-
*/
61
"use strict"
72

3+
const { getSourceCode } = require("../eslint-compat")
4+
85
//------------------------------------------------------------------------------
96
// Rule Definition
107
//------------------------------------------------------------------------------
@@ -25,7 +22,7 @@ module.exports = {
2522
},
2623

2724
create(context) {
28-
const sourceCode = context.getSourceCode()
25+
const sourceCode = getSourceCode(context)
2926
let funcInfo = null
3027

3128
/**
@@ -65,7 +62,7 @@ module.exports = {
6562
}
6663

6764
/**
68-
* Reports the `this`/`super` node if this is inside of a static method.
65+
* Reports the `this`/`super` node if this is inside a static method.
6966
*
7067
* @param {ASTNode} node - The node to report.
7168
* @returns {void}

‎lib/rules/no-use-ignored-vars.js

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
/**
2-
* @fileoverview Rule to disallow a use of ignored variables.
3-
* @author Toru Nagashima
4-
*/
51
"use strict"
62

3+
const { getScope } = require("../eslint-compat")
4+
75
//------------------------------------------------------------------------------
86
// Helpers
97
//------------------------------------------------------------------------------
@@ -84,8 +82,8 @@ module.exports = {
8482
}
8583

8684
return {
87-
"Program:exit"() {
88-
const queue = [context.getScope()]
85+
"Program:exit"(node) {
86+
const queue = [getScope(context, node)]
8987
let scope = null
9088

9189
while ((scope = queue.pop()) != null) {

‎lib/rules/no-useless-rest-spread.js

+8-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
/**
2-
* @fileoverview Rule to disallow unnecessary spread operators.
3-
* @author Toru Nagashima
4-
*/
51
"use strict"
62

3+
const { getSourceCode } = require("../eslint-compat")
4+
75
//------------------------------------------------------------------------------
86
// Helpers
97
//------------------------------------------------------------------------------
@@ -109,7 +107,7 @@ module.exports = {
109107
},
110108

111109
create(context) {
112-
const sourceCode = context.getSourceCode()
110+
const sourceCode = getSourceCode(context)
113111

114112
/**
115113
* Verify the given SpreadElement or RestElement.
@@ -133,12 +131,11 @@ module.exports = {
133131
const isRestParameter =
134132
nodeType === "RestElement" && argumentType !== parentType
135133
const type1 = nodeType === "RestElement" ? "rest" : "spread"
136-
const type2 =
137-
/* eslint-disable @eslint-community/mysticatea/prettier */
138-
isRestParameter ? "parameter" :
139-
isArray ? "element" :
140-
/* otherwise */ "property"
141-
/* eslint-enable @eslint-community/mysticatea/prettier */
134+
const type2 = isRestParameter
135+
? "parameter"
136+
: isArray
137+
? "element"
138+
: /* otherwise */ "property"
142139

143140
context.report({
144141
node,

0 commit comments

Comments
 (0)