chore: use context.filename and context.physicalFilename

43081j · 43081j · commit 20b56b57aa12 · 2025-03-31T14:28:51.000+01:00
Since we now require latest 8.x, all versions of ESLint we support have
both `context.filename` and `context.physicalFilename`.

In the old types, `physicalFilename` could be undefined but now will
actually default to `filename` (so the type has also changed).
diff --git a/.changeset/petite-impalas-reply.md b/.changeset/petite-impalas-reply.md
@@ -0,0 +1,5 @@
+---
+'eslint-plugin-svelte': patch
+---
+
+chore: use `context.filename` and `context.physicalFilename` instead of compat functions.
diff --git a/packages/eslint-plugin-svelte/eslint.config.mjs b/packages/eslint-plugin-svelte/eslint.config.mjs
@@ -71,11 +71,11 @@ const config = [
 			'no-restricted-properties': [
 				'error',
 				{ object: 'context', property: 'getSourceCode', message: 'Use src/utils/compat.ts' },
-				{ object: 'context', property: 'getFilename', message: 'Use src/utils/compat.ts' },
+				{ object: 'context', property: 'getFilename', message: 'Use `context.filename`' },
 				{
 					object: 'context',
 					property: 'getPhysicalFilename',
-					message: 'Use src/utils/compat.ts'
+					message: 'Use `context.physicalFilename`'
 				},
 				{ object: 'context', property: 'getCwd', message: 'Use src/utils/compat.ts' },
 				{ object: 'context', property: 'getScope', message: 'Use src/utils/compat.ts' },
diff --git a/packages/eslint-plugin-svelte/src/rules/comment-directive.ts b/packages/eslint-plugin-svelte/src/rules/comment-directive.ts
@@ -2,7 +2,7 @@ import type { AST } from 'svelte-eslint-parser';
 import { getShared } from '../shared/index.js';
 import type { CommentDirectives } from '../shared/comment-directives.js';
 import { createRule } from '../utils/index.js';
-import { getFilename, getSourceCode } from '../utils/compat.js';
+import { getSourceCode } from '../utils/compat.js';
 
 type RuleAndLocation = {
 	ruleId: string;
@@ -54,7 +54,7 @@ export default createRule('comment-directive', {
 		type: 'problem'
 	},
 	create(context) {
-		const shared = getShared(getFilename(context));
+		const shared = getShared(context.filename);
 		if (!shared) return {};
 		const options = context.options[0] || {};
 		const reportUnusedDisableDirectives = Boolean(options.reportUnusedDisableDirectives);
diff --git a/packages/eslint-plugin-svelte/src/rules/indent-helpers/index.ts b/packages/eslint-plugin-svelte/src/rules/indent-helpers/index.ts
@@ -8,7 +8,7 @@ import { isCommentToken } from '@eslint-community/eslint-utils';
 import type { AnyToken, IndentOptions } from './commons.js';
 import type { OffsetCalculator } from './offset-context.js';
 import { OffsetContext } from './offset-context.js';
-import { getFilename, getSourceCode } from '../../utils/compat.js';
+import { getSourceCode } from '../../utils/compat.js';
 
 type IndentUserOptions = {
 	indent?: number | 'tab';
@@ -78,7 +78,7 @@ export function defineVisitor(
 	context: RuleContext,
 	defaultOptions: Partial<IndentOptions>
 ): RuleListener {
-	if (!getFilename(context).endsWith('.svelte')) return {};
+	if (!context.filename.endsWith('.svelte')) return {};
 
 	const options = parseOptions(context.options[0] || {}, defaultOptions);
 	const sourceCode = getSourceCode(context);
diff --git a/packages/eslint-plugin-svelte/src/rules/no-unused-props.ts b/packages/eslint-plugin-svelte/src/rules/no-unused-props.ts
@@ -4,7 +4,6 @@ import type { TSESTree } from '@typescript-eslint/types';
 import type ts from 'typescript';
 import { findVariable } from '../utils/ast-utils.js';
 import { toRegExp } from '../utils/regexp.js';
-import { getFilename } from '../utils/compat.js';
 
 type PropertyPathArray = string[];
 
@@ -58,7 +57,7 @@ export default createRule('no-unused-props', {
 		]
 	},
 	create(context) {
-		const fileName = getFilename(context);
+		const fileName = context.filename;
 		const tools = getTypeScriptTools(context);
 		if (!tools) {
 			return {};
diff --git a/packages/eslint-plugin-svelte/src/rules/system.ts b/packages/eslint-plugin-svelte/src/rules/system.ts
@@ -1,6 +1,5 @@
 import { getShared } from '../shared/index.js';
 import { createRule } from '../utils/index.js';
-import { getFilename } from '../utils/compat.js';
 import { isRegExp, toRegExp } from '../utils/regexp.js';
 
 export default createRule('system', {
@@ -15,7 +14,7 @@ export default createRule('system', {
 		type: 'problem'
 	},
 	create(context) {
-		const shared = getShared(getFilename(context));
+		const shared = getShared(context.filename);
 		if (!shared) return {};
 
 		const directives = shared.newCommentDirectives({
diff --git a/packages/eslint-plugin-svelte/src/shared/svelte-compile-warns/transform/less.ts b/packages/eslint-plugin-svelte/src/shared/svelte-compile-warns/transform/less.ts
@@ -3,7 +3,6 @@ import type less from 'less';
 import type { RuleContext } from '../../../types.js';
 import type { TransformResult } from './types.js';
 import { loadModule } from '../../../utils/load-module.js';
-import { getFilename } from '../../../utils/compat.js';
 
 type Less = typeof less;
 /**
@@ -26,7 +25,7 @@ export function transform(
 	}
 	const code = text.slice(...inputRange);
 
-	const filename = `${getFilename(context)}.less`;
+	const filename = `${context.filename}.less`;
 	try {
 		let output: Awaited<ReturnType<Less['render']>> | undefined;
 
diff --git a/packages/eslint-plugin-svelte/src/shared/svelte-compile-warns/transform/postcss.ts b/packages/eslint-plugin-svelte/src/shared/svelte-compile-warns/transform/postcss.ts
@@ -3,7 +3,7 @@ import postcss from 'postcss';
 import postcssLoadConfig from 'postcss-load-config';
 import type { RuleContext } from '../../../types.js';
 import type { TransformResult } from './types.js';
-import { getCwd, getFilename } from '../../../utils/compat.js';
+import { getCwd } from '../../../utils/compat.js';
 
 /**
  * Transform with postcss
@@ -25,7 +25,7 @@ export function transform(
 	}
 	const code = text.slice(...inputRange);
 
-	const filename = `${getFilename(context)}.css`;
+	const filename = `${context.filename}.css`;
 	try {
 		const configFilePath = postcssConfig?.configFilePath;
 
diff --git a/packages/eslint-plugin-svelte/src/shared/svelte-compile-warns/transform/stylus.ts b/packages/eslint-plugin-svelte/src/shared/svelte-compile-warns/transform/stylus.ts
@@ -4,7 +4,6 @@ import type { RawSourceMap } from 'source-map-js';
 import type { RuleContext } from '../../../types.js';
 import type { TransformResult } from './types.js';
 import { loadModule } from '../../../utils/load-module.js';
-import { getFilename } from '../../../utils/compat.js';
 
 type Stylus = typeof stylus;
 /**
@@ -27,7 +26,7 @@ export function transform(
 	}
 	const code = text.slice(...inputRange);
 
-	const filename = `${getFilename(context)}.stylus`;
+	const filename = `${context.filename}.stylus`;
 	try {
 		let output: string | undefined;
 
diff --git a/packages/eslint-plugin-svelte/src/types.ts b/packages/eslint-plugin-svelte/src/types.ts
@@ -149,7 +149,7 @@ export type RuleContext = {
 
 	getDeclaredVariables(node: TSESTree.Node): Variable[];
 
-	getFilename(): string;
+	filename: string;
 
 	getScope(): Scope;
 
@@ -161,8 +161,8 @@ export type RuleContext = {
 
 	// eslint@6 does not have this method.
 	getCwd?: () => string;
-	// eslint@<7.11.0 does not have this method.
-	getPhysicalFilename?: () => string;
+
+	physicalFilename: string;
 };
 
 export type NodeOrToken = {
diff --git a/packages/eslint-plugin-svelte/src/utils/compat.ts b/packages/eslint-plugin-svelte/src/utils/compat.ts
@@ -1,9 +1,4 @@
-import {
-	getSourceCode as getSourceCodeBase,
-	getFilename as getFilenameBase,
-	getPhysicalFilename as getPhysicalFilenameBase,
-	getCwd as getCwdBase
-} from 'eslint-compat-utils';
+import { getSourceCode as getSourceCodeBase, getCwd as getCwdBase } from 'eslint-compat-utils';
 import type { RuleContext, SourceCode } from '../types.js';
 
 // export function getSourceCode(context: RuleContext): SourceCode;
@@ -16,22 +11,6 @@ export function getSourceCode(context: RuleContext): SourceCode {
 	return getSourceCodeBase(context as never) as never;
 }
 
-/**
- * Gets the value of `context.filename`, but for older ESLint it returns the result of `context.getFilename()`.
- */
-export function getFilename(context: RuleContext): string {
-	return getFilenameBase(context as never);
-}
-/**
- * Gets the value of `context.physicalFilename`,
- * but for older ESLint it returns the result of `context.getPhysicalFilename()`.
- * Versions older than v7.28.0 return a value guessed from the result of `context.getFilename()`,
- * but it may be incorrect.
- */
-export function getPhysicalFilename(context: RuleContext): string {
-	return getPhysicalFilenameBase(context as never);
-}
-
 /**
  * Gets the value of `context.cwd`, but for older ESLint it returns the result of `context.getCwd()`.
  * Versions older than v6.6.0 return a value from the result of `process.cwd()`.
diff --git a/packages/eslint-plugin-svelte/src/utils/load-module.ts b/packages/eslint-plugin-svelte/src/utils/load-module.ts
@@ -2,7 +2,7 @@ import type { AST } from 'svelte-eslint-parser';
 import Module from 'module';
 import path from 'path';
 import type { RuleContext } from '../types.js';
-import { getCwd, getFilename, getPhysicalFilename, getSourceCode } from './compat.js';
+import { getCwd, getSourceCode } from './compat.js';
 const cache = new WeakMap<AST.SvelteProgram, Record<string, unknown>>();
 const cache4b = new Map<string, unknown>();
 /**
@@ -27,9 +27,9 @@ export function loadModule<R>(context: RuleContext, name: string): R | null {
 	}
 	for (const relativeTo of [
 		// load from lint file name
-		getFilename(context),
+		context.filename,
 		// load from lint file name (physical)
-		getPhysicalFilename(context),
+		context.physicalFilename,
 		// load from this plugin module
 		typeof __filename !== 'undefined' ? __filename : ''
 	]) {
diff --git a/packages/eslint-plugin-svelte/src/utils/svelte-context.ts b/packages/eslint-plugin-svelte/src/utils/svelte-context.ts
@@ -3,7 +3,7 @@ import fs from 'fs';
 import path from 'path';
 import { getPackageJsons } from './get-package-json.js';
 import { getNodeModule } from './get-node-module.js';
-import { getFilename, getSourceCode } from './compat.js';
+import { getSourceCode } from './compat.js';
 import { createCache } from './cache.js';
 import { VERSION as SVELTE_VERSION } from 'svelte/compiler';
 
@@ -122,7 +122,7 @@ const svelteKitContextCache = createCache<Pick<
 function getSvelteKitContext(
 	context: RuleContext
 ): Pick<SvelteContext, 'svelteKitFileType' | 'svelteKitVersion'> {
-	const filePath = getFilename(context);
+	const filePath = context.filename;
 
 	const cached = svelteKitContextCache.get(filePath);
 	if (cached) return cached;
@@ -151,7 +151,7 @@ function getSvelteKitContext(
 			context.settings?.svelte?.kit?.files?.routes ??
 			getSourceCode(context).parserServices.svelteParseContext?.svelteConfig?.kit?.files?.routes
 		)?.replace(/^\//, '') ?? 'src/routes';
-	const projectRootDir = getProjectRootDir(getFilename(context)) ?? '';
+	const projectRootDir = getProjectRootDir(context.filename) ?? '';
 
 	if (!filePath.startsWith(path.join(projectRootDir, routes))) {
 		const result: Pick<SvelteContext, 'svelteKitFileType' | 'svelteKitVersion'> = {
@@ -288,7 +288,7 @@ const svelteContextCache = createCache<SvelteContext | null>();
 export function getSvelteContext(context: RuleContext): SvelteContext | null {
 	const { parserServices } = getSourceCode(context);
 	const { svelteParseContext } = parserServices;
-	const filePath = getFilename(context);
+	const filePath = context.filename;
 
 	const cached = svelteContextCache.get(filePath);
 	if (cached) return cached;

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'eslint-plugin-svelte': patch
 +---
++
 +chore: use `context.filename` and `context.physicalFilename` instead of compat functions.