Skip to content

Commit ef5f965

Browse files
ota-meshiota-meshi
authored
feat: use eslint-compat-utils (#605)
1 parent ff28fd3 commit ef5f965

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+187
-77
lines changed

‎.changeset/slimy-jokes-reflect.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"eslint-plugin-svelte": minor
3+
---
4+
5+
feat: use eslint-compat-utils

‎.eslintrc.js

+13
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,19 @@ module.exports = {
133133
}
134134
]
135135
}
136+
],
137+
'no-restricted-properties': [
138+
'error',
139+
{ object: 'context', property: 'getSourceCode', message: 'Use src/utils/compat.ts' },
140+
{ object: 'context', property: 'getFilename', message: 'Use src/utils/compat.ts' },
141+
{
142+
object: 'context',
143+
property: 'getPhysicalFilename',
144+
message: 'Use src/utils/compat.ts'
145+
},
146+
{ object: 'context', property: 'getCwd', message: 'Use src/utils/compat.ts' },
147+
{ object: 'context', property: 'getScope', message: 'Use src/utils/compat.ts' },
148+
{ object: 'context', property: 'parserServices', message: 'Use src/utils/compat.ts' }
136149
]
137150
}
138151
},

‎package.json

+1
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@
6969
"@eslint-community/eslint-utils": "^4.2.0",
7070
"@jridgewell/sourcemap-codec": "^1.4.14",
7171
"debug": "^4.3.1",
72+
"eslint-compat-utils": "^0.1.2",
7273
"esutils": "^2.0.3",
7374
"known-css-properties": "^0.29.0",
7475
"postcss": "^8.4.5",

‎src/rules/@typescript-eslint/no-unnecessary-condition.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import {
2222
isTupleType
2323
} from '../../utils/ts-utils';
2424
import type { TS, TSTools } from '../../utils/ts-utils';
25+
import { getSourceCode } from '../../utils/compat';
2526

2627
/**
2728
* Returns all types of a union type or an array containing `type` itself if it's no union type.
@@ -156,7 +157,7 @@ export default createRule('@typescript-eslint/no-unnecessary-condition', {
156157

157158
const { service, ts } = tools;
158159
const checker = service.program.getTypeChecker();
159-
const sourceCode = context.getSourceCode();
160+
const sourceCode = getSourceCode(context);
160161
const compilerOptions = service.program.getCompilerOptions();
161162
const isStrictNullChecks = compilerOptions.strict
162163
? compilerOptions.strictNullChecks !== false

‎src/rules/block-lang.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { createRule } from '../utils';
22
import { getLangValue } from '../utils/ast-utils';
33
import type { SvelteScriptElement, SvelteStyleElement } from 'svelte-eslint-parser/lib/ast';
4+
import { getSourceCode } from '../utils/compat';
45

56
export default createRule('block-lang', {
67
meta: {
@@ -56,7 +57,7 @@ export default createRule('block-lang', {
5657
type: 'suggestion'
5758
},
5859
create(context) {
59-
if (!context.parserServices.isSvelte) {
60+
if (!getSourceCode(context).parserServices.isSvelte) {
6061
return {};
6162
}
6263
const enforceScriptPresent: boolean = context.options[0]?.enforceScriptPresent ?? false;

‎src/rules/comment-directive.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type { AST } from 'svelte-eslint-parser';
22
import { getShared } from '../shared';
33
import type { CommentDirectives } from '../shared/comment-directives';
44
import { createRule } from '../utils';
5+
import { getFilename, getSourceCode } from '../utils/compat';
56

67
type RuleAndLocation = {
78
ruleId: string;
@@ -53,7 +54,7 @@ export default createRule('comment-directive', {
5354
type: 'problem'
5455
},
5556
create(context) {
56-
const shared = getShared(context.getFilename());
57+
const shared = getShared(getFilename(context));
5758
if (!shared) return {};
5859
const options = context.options[0] || {};
5960
const reportUnusedDisableDirectives = Boolean(options.reportUnusedDisableDirectives);
@@ -62,7 +63,7 @@ export default createRule('comment-directive', {
6263
reportUnusedDisableDirectives
6364
});
6465

65-
const sourceCode = context.getSourceCode();
66+
const sourceCode = getSourceCode(context);
6667

6768
/**
6869
* Parse a given comment.

‎src/rules/first-attribute-linebreak.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { AST } from 'svelte-eslint-parser';
22
import { createRule } from '../utils';
3+
import { getSourceCode } from '../utils/compat';
34

45
export default createRule('first-attribute-linebreak', {
56
meta: {
@@ -29,7 +30,7 @@ export default createRule('first-attribute-linebreak', {
2930
create(context) {
3031
const multiline: 'below' | 'beside' = context.options[0]?.multiline || 'below';
3132
const singleline: 'below' | 'beside' = context.options[0]?.singleline || 'beside';
32-
const sourceCode = context.getSourceCode();
33+
const sourceCode = getSourceCode(context);
3334

3435
/**
3536
* Report attribute

‎src/rules/html-quotes.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { createRule } from '../utils';
33
import type { QuoteAndRange } from '../utils/ast-utils';
44
import { getMustacheTokens } from '../utils/ast-utils';
55
import { getAttributeValueQuoteAndRange } from '../utils/ast-utils';
6+
import { getSourceCode } from '../utils/compat';
67

78
const QUOTE_CHARS = {
89
double: '"',
@@ -48,7 +49,7 @@ export default createRule('html-quotes', {
4849
type: 'layout' // "problem",
4950
},
5051
create(context) {
51-
const sourceCode = context.getSourceCode();
52+
const sourceCode = getSourceCode(context);
5253
const preferQuote: 'double' | 'single' = context.options[0]?.prefer ?? 'double';
5354
const dynamicQuote = context.options[0]?.dynamic?.quoted ? preferQuote : 'unquoted';
5455
const avoidInvalidUnquotedInHTML = Boolean(

‎src/rules/html-self-closing.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import type { AST } from 'svelte-eslint-parser';
22
import { createRule } from '../utils';
33
import { getNodeName, isVoidHtmlElement } from '../utils/ast-utils';
4+
import { getSourceCode } from '../utils/compat';
45

56
const TYPE_MESSAGES = {
67
normal: 'HTML elements',
@@ -126,9 +127,9 @@ export default createRule('html-self-closing', {
126127
context.report({
127128
node,
128129
loc: {
129-
start: context
130-
.getSourceCode()
131-
.getLocFromIndex(node.startTag.range[1] - (node.startTag.selfClosing ? 2 : 1)),
130+
start: getSourceCode(context).getLocFromIndex(
131+
node.startTag.range[1] - (node.startTag.selfClosing ? 2 : 1)
132+
),
132133
end: node.loc.end
133134
},
134135
messageId: shouldBeClosed ? 'requireClosing' : 'disallowClosing',

‎src/rules/indent-helpers/index.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { isCommentToken } from '@eslint-community/eslint-utils';
99
import type { AnyToken, IndentOptions } from './commons';
1010
import type { OffsetCalculator } from './offset-context';
1111
import { OffsetContext } from './offset-context';
12+
import { getFilename, getSourceCode } from '../../utils/compat';
1213

1314
type IndentUserOptions = {
1415
indent?: number | 'tab';
@@ -78,10 +79,10 @@ export function defineVisitor(
7879
context: RuleContext,
7980
defaultOptions: Partial<IndentOptions>
8081
): RuleListener {
81-
if (!context.getFilename().endsWith('.svelte')) return {};
82+
if (!getFilename(context).endsWith('.svelte')) return {};
8283

8384
const options = parseOptions(context.options[0] || {}, defaultOptions);
84-
const sourceCode = context.getSourceCode();
85+
const sourceCode = getSourceCode(context);
8586
const offsets = new OffsetContext({ sourceCode, options });
8687

8788
/**

‎src/rules/infinite-reactive-loop.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ import { createRule } from '../utils';
55
import type { RuleContext } from '../types';
66
import { findVariable } from '../utils/ast-utils';
77
import { traverseNodes } from 'svelte-eslint-parser';
8+
import { getSourceCode } from '../utils/compat';
89

910
/**
1011
* Get usage of `tick`
1112
*/
1213
function extractTickReferences(
1314
context: RuleContext
1415
): { node: TSESTree.CallExpression; name: string }[] {
15-
const referenceTracker = new ReferenceTracker(context.getSourceCode().scopeManager.globalScope!);
16+
const referenceTracker = new ReferenceTracker(getSourceCode(context).scopeManager.globalScope!);
1617
const a = referenceTracker.iterateEsmReferences({
1718
svelte: {
1819
[ReferenceTracker.ESM]: true,
@@ -35,7 +36,7 @@ function extractTickReferences(
3536
function extractTaskReferences(
3637
context: RuleContext
3738
): { node: TSESTree.CallExpression; name: string }[] {
38-
const referenceTracker = new ReferenceTracker(context.getSourceCode().scopeManager.globalScope!);
39+
const referenceTracker = new ReferenceTracker(getSourceCode(context).scopeManager.globalScope!);
3940
const a = referenceTracker.iterateGlobalReferences({
4041
setTimeout: { [ReferenceTracker.CALL]: true },
4142
setInterval: { [ReferenceTracker.CALL]: true },
@@ -122,7 +123,7 @@ function isPromiseThenOrCatchBody(node: TSESTree.Node): boolean {
122123
* Get all reactive variable reference.
123124
*/
124125
function getReactiveVariableReferences(context: RuleContext) {
125-
const scopeManager = context.getSourceCode().scopeManager;
126+
const scopeManager = getSourceCode(context).scopeManager;
126127
// Find the top-level (module or global) scope.
127128
// Any variable defined at the top-level (module scope or global scope) can be made reactive.
128129
const toplevelScope =

‎src/rules/max-attributes-per-line.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { AST } from 'svelte-eslint-parser';
22
import { createRule } from '../utils';
3+
import { getSourceCode } from '../utils/compat';
34

45
/**
56
* Check whether the component is declared in a single line or not.
@@ -57,7 +58,7 @@ export default createRule('max-attributes-per-line', {
5758
create(context) {
5859
const multilineMaximum = context.options[0]?.multiline ?? 1;
5960
const singlelineMaximum = context.options[0]?.singleline ?? 1;
60-
const sourceCode = context.getSourceCode();
61+
const sourceCode = getSourceCode(context);
6162

6263
/**
6364
* Report attributes

‎src/rules/mustache-spacing.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type { AST } from 'svelte-eslint-parser';
22
import { isClosingBraceToken, isOpeningBraceToken } from '@eslint-community/eslint-utils';
33
import { createRule } from '../utils';
44
import { getMustacheTokens } from '../utils/ast-utils';
5+
import { getSourceCode } from '../utils/compat';
56
type DeepPartial<T> = {
67
[P in keyof T]?: DeepPartial<T[P]>;
78
};
@@ -73,7 +74,7 @@ export default createRule('mustache-spacing', {
7374
},
7475
create(context) {
7576
const options = parseOptions(context.options[0]);
76-
const sourceCode = context.getSourceCode();
77+
const sourceCode = getSourceCode(context);
7778

7879
function verifyBraces(
7980
openingBrace: AST.Token | AST.Comment,

‎src/rules/no-dupe-else-if-blocks.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type { AST } from 'svelte-eslint-parser';
22
import type { TSESTree } from '@typescript-eslint/types';
33
import { createRule } from '../utils';
44
import { equalTokens } from '../utils/ast-utils';
5+
import { getSourceCode } from '../utils/compat';
56

67
// ------------------------------------------------------------------------------
78
// Helpers
@@ -81,7 +82,7 @@ export default createRule('no-dupe-else-if-blocks', {
8182
type: 'problem' // "problem",
8283
},
8384
create(context) {
84-
const sourceCode = context.getSourceCode();
85+
const sourceCode = getSourceCode(context);
8586

8687
/**
8788
* Determines whether the two given nodes are considered to be equal. In particular, given that the nodes

‎src/rules/no-dupe-on-directives.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type { AST } from 'svelte-eslint-parser';
22
import type { TSESTree } from '@typescript-eslint/types';
33
import { createRule } from '../utils';
44
import { equalTokens } from '../utils/ast-utils';
5+
import { getSourceCode } from '../utils/compat';
56

67
export default createRule('no-dupe-on-directives', {
78
meta: {
@@ -18,7 +19,7 @@ export default createRule('no-dupe-on-directives', {
1819
type: 'problem'
1920
},
2021
create(context) {
21-
const sourceCode = context.getSourceCode();
22+
const sourceCode = getSourceCode(context);
2223

2324
const directiveDataMap = new Map<
2425
string, // event type

‎src/rules/no-dupe-use-directives.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type { AST } from 'svelte-eslint-parser';
22
import type { TSESTree } from '@typescript-eslint/types';
33
import { createRule } from '../utils';
44
import { equalTokens, getAttributeKeyText } from '../utils/ast-utils';
5+
import { getSourceCode } from '../utils/compat';
56

67
export default createRule('no-dupe-use-directives', {
78
meta: {
@@ -18,7 +19,7 @@ export default createRule('no-dupe-use-directives', {
1819
type: 'problem'
1920
},
2021
create(context) {
21-
const sourceCode = context.getSourceCode();
22+
const sourceCode = getSourceCode(context);
2223

2324
const directiveDataMap = new Map<
2425
string, // key text

‎src/rules/no-dynamic-slot-name.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import {
66
getAttributeValueQuoteAndRange,
77
getStringIfConstant
88
} from '../utils/ast-utils';
9+
import { getSourceCode } from '../utils/compat';
910

1011
export default createRule('no-dynamic-slot-name', {
1112
meta: {
@@ -23,7 +24,7 @@ export default createRule('no-dynamic-slot-name', {
2324
type: 'problem'
2425
},
2526
create(context) {
26-
const sourceCode = context.getSourceCode();
27+
const sourceCode = getSourceCode(context);
2728
return {
2829
"SvelteElement[name.name='slot'] > SvelteStartTag.startTag > SvelteAttribute[key.name='name']"(
2930
node: AST.SvelteAttribute

‎src/rules/no-extra-reactive-curlies.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { TSESTree } from '@typescript-eslint/types';
22
import { createRule } from '../utils';
3+
import { getSourceCode } from '../utils/compat';
34

45
export default createRule('no-extra-reactive-curlies', {
56
meta: {
@@ -23,7 +24,7 @@ export default createRule('no-extra-reactive-curlies', {
2324
[`SvelteReactiveStatement > BlockStatement[body.length=1]`]: (
2425
node: TSESTree.BlockStatement
2526
) => {
26-
const source = context.getSourceCode();
27+
const source = getSourceCode(context);
2728

2829
return context.report({
2930
node,

‎src/rules/no-immutable-reactive-statements.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { createRule } from '../utils';
33
import type { Scope, Variable, Reference, Definition } from '@typescript-eslint/scope-manager';
44
import type { TSESTree } from '@typescript-eslint/types';
55
import { findVariable, iterateIdentifiers } from '../utils/ast-utils';
6+
import { getSourceCode } from '../utils/compat';
67

78
export default createRule('no-immutable-reactive-statements', {
89
meta: {
@@ -20,7 +21,7 @@ export default createRule('no-immutable-reactive-statements', {
2021
type: 'suggestion'
2122
},
2223
create(context) {
23-
const scopeManager = context.getSourceCode().scopeManager;
24+
const scopeManager = getSourceCode(context).scopeManager;
2425
const globalScope = scopeManager.globalScope;
2526
const toplevelScope =
2627
globalScope?.childScopes.find((scope) => scope.type === 'module') || globalScope;

‎src/rules/no-reactive-functions.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import type { TSESTree } from '@typescript-eslint/types';
22
import type { AST } from 'svelte-eslint-parser';
33
import { createRule } from '../utils';
4+
import { getSourceCode } from '../utils/compat';
45

56
export default createRule('no-reactive-functions', {
67
meta: {
@@ -30,7 +31,7 @@ export default createRule('no-reactive-functions', {
3031
return false;
3132
}
3233

33-
const source = context.getSourceCode();
34+
const source = getSourceCode(context);
3435

3536
return context.report({
3637
node: parent,

‎src/rules/no-reactive-literals.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { TSESTree } from '@typescript-eslint/types';
22
import { createRule } from '../utils';
3+
import { getSourceCode } from '../utils/compat';
34

45
export default createRule('no-reactive-literals', {
56
meta: {
@@ -36,7 +37,7 @@ export default createRule('no-reactive-literals', {
3637
return false;
3738
}
3839

39-
const source = context.getSourceCode();
40+
const source = getSourceCode(context);
4041

4142
return context.report({
4243
node: parent,

‎src/rules/no-reactive-reassign.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import type { TSESTree } from '@typescript-eslint/types';
22
import type { AST } from 'svelte-eslint-parser';
33
import { createRule } from '../utils';
44
import { getPropertyName } from '@eslint-community/eslint-utils';
5+
import { getSourceCode } from '../utils/compat';
56

67
export default createRule('no-reactive-reassign', {
78
meta: {
@@ -30,7 +31,7 @@ export default createRule('no-reactive-reassign', {
3031
},
3132
create(context) {
3233
const props = context.options[0]?.props !== false; // default true
33-
const sourceCode = context.getSourceCode();
34+
const sourceCode = getSourceCode(context);
3435
const scopeManager = sourceCode.scopeManager;
3536
const globalScope = scopeManager.globalScope;
3637
const toplevelScope =

0 commit comments

Comments
 (0)