fix(tools): migrate update scripts to cross platform URL's

InkedCat · InkedCat · commit 8cb54c67b2f3 · 2025-09-18T18:19:45.000+02:00
diff --git a/packages/eslint-plugin-svelte/tools/lib/changesets-util.ts b/packages/eslint-plugin-svelte/tools/lib/changesets-util.ts
@@ -1,11 +1,11 @@
 import getReleasePlan from '@changesets/get-release-plan';
-import path from 'path';
+import { fileURLToPath } from 'url';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const cwdURL = new URL('../../../..', import.meta.url);
 
 /** Get new version string from changesets */
 export async function getNewVersion(): Promise<string> {
-	const releasePlan = await getReleasePlan(path.resolve(__dirname, '../../../..'));
+	const releasePlan = await getReleasePlan(fileURLToPath(cwdURL));
 
 	return releasePlan.releases.find(({ name }) => name === 'eslint-plugin-svelte')!.newVersion;
 }
diff --git a/packages/eslint-plugin-svelte/tools/lib/load-rules.ts b/packages/eslint-plugin-svelte/tools/lib/load-rules.ts
@@ -1,18 +1,18 @@
 import path from 'path';
 import fs from 'fs';
 import type { RuleModule } from '../../src/types.js';
+import util from 'util';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const rulesLibRootURL = new URL('../../src/rules/', import.meta.url);
 
 /**
  * Get the all rules
  * @returns {Array} The all rules
  */
 async function readRules() {
-	const rulesLibRoot = path.resolve(__dirname, '../../src/rules');
 	const rules: RuleModule[] = [];
 	for (const name of iterateTsFiles()) {
-		const module = await import(path.join(rulesLibRoot, name));
+		const module = await import(new URL(name, rulesLibRootURL).href);
 		const rule: RuleModule = module && module.default;
 		if (!rule || typeof rule.create !== 'function') {
 			continue;
@@ -27,19 +27,18 @@ export const rules = await readRules();
 
 /** Iterate ts files */
 function* iterateTsFiles() {
-	const rulesLibRoot = path.resolve(__dirname, '../../src/rules');
-	const files = fs.readdirSync(rulesLibRoot);
+	const files = fs.readdirSync(rulesLibRootURL);
 
 	while (files.length) {
 		const file = files.shift()!;
 		if (file.endsWith('.ts')) {
 			yield file;
 			continue;
 		}
-		const filePath = path.join(rulesLibRoot, file);
-		if (!fs.statSync(filePath).isDirectory()) {
+		const filePathURL = new URL(file, rulesLibRootURL);
+		if (!fs.statSync(filePathURL).isDirectory()) {
 			continue;
 		}
-		files.unshift(...fs.readdirSync(filePath).map((n) => path.join(file, n)));
+		files.unshift(...fs.readdirSync(filePathURL).map((n) => path.join(file, n)));
 	}
 }
diff --git a/packages/eslint-plugin-svelte/tools/lib/write.ts b/packages/eslint-plugin-svelte/tools/lib/write.ts
@@ -1,28 +1,31 @@
 import fs from 'fs';
 import { ESLint } from 'eslint';
 import prettier from 'prettier';
+import { fileURLToPath } from 'url';
 
 /**
  * Write file and format it with ESLint
  */
-export function writeAndFormat(fileName: string, content: string): Promise<void> {
-	fs.writeFileSync(fileName, content, 'utf8');
+export async function writeAndFormat(fileURL: URL, content: string): Promise<void> {
+	fs.writeFileSync(fileURL, content, 'utf8');
+
+	const filePath = fileURLToPath(fileURL);
 	return prettier
-		.resolveConfig(fileName)
+		.resolveConfig(fileURL)
 		.then((prettierrc) => {
 			if (!prettierrc) {
 				return content;
 			}
-			return prettier.format(content, { filepath: fileName, ...prettierrc });
+			return prettier.format(content, { filepath: filePath, ...prettierrc });
 		})
 		.then((formatted) => {
-			fs.writeFileSync(fileName, formatted, 'utf8');
+			fs.writeFileSync(fileURL, formatted, 'utf8');
 			const eslint = new ESLint({ fix: true });
-			return eslint.lintText(formatted, { filePath: fileName });
+			return eslint.lintText(formatted, { filePath });
 		})
 		.then(([result]) => {
 			if (result.output) {
-				fs.writeFileSync(fileName, result.output, 'utf8');
+				fs.writeFileSync(fileURL, result.output, 'utf8');
 			}
 		});
 }
diff --git a/packages/eslint-plugin-svelte/tools/update-docs-rules-index.ts b/packages/eslint-plugin-svelte/tools/update-docs-rules-index.ts
@@ -1,13 +1,10 @@
-import path from 'path';
 import renderRulesTableContent from './render-rules.js';
 import { writeAndFormat } from './lib/write.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
-
 // -----------------------------------------------------------------------------
-const readmeFilePath = path.resolve(__dirname, '../../../docs/rules.md');
+const readmeFileURL = new URL('../../../docs/rules.md', import.meta.url);
 void writeAndFormat(
-	readmeFilePath,
+	readmeFileURL,
 	`---
 sidebarDepth: 0
 ---
diff --git a/packages/eslint-plugin-svelte/tools/update-docs.ts b/packages/eslint-plugin-svelte/tools/update-docs.ts
@@ -1,12 +1,9 @@
-import path from 'path';
 import fs from 'fs';
 import { rules } from '../src/utils/rules.js';
 import type { RuleModule } from '../src/types.js';
 import { getNewVersion } from './lib/changesets-util.js';
 import { writeAndFormat } from './lib/write.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
-
 function formatItems(items: string[]) {
 	if (items.length <= 2) {
 		return items.join(' and ');
@@ -21,7 +18,7 @@ function yamlValue(val: unknown) {
 	return val;
 }
 
-const ROOT = path.resolve(__dirname, '../../../docs/rules');
+const ROOT_URL = new URL('../../../docs/rules/', import.meta.url);
 
 function pickSince(content: string): string | null | Promise<string> {
 	const fileIntro = /^---\n((?:.*\n)+)---\n*/.exec(content);
@@ -46,16 +43,16 @@ function pickSince(content: string): string | null | Promise<string> {
 class DocFile {
 	private readonly rule: RuleModule;
 
-	private readonly filePath: string;
+	private readonly fileURL: URL;
 
 	private content: string;
 
 	private readonly since: string | null | Promise<string>;
 
 	public constructor(rule: RuleModule) {
 		this.rule = rule;
-		this.filePath = path.join(ROOT, `${rule.meta.docs.ruleName}.md`);
-		this.content = fs.readFileSync(this.filePath, 'utf8');
+		this.fileURL = new URL(`./${rule.meta.docs.ruleName}.md`, ROOT_URL);
+		this.content = fs.readFileSync(this.fileURL, 'utf8');
 		this.since = pickSince(this.content);
 	}
 
@@ -221,7 +218,7 @@ ${
 	public async write() {
 		this.content = this.content.replace(/\r?\n/gu, '\n');
 
-		await writeAndFormat(this.filePath, this.content);
+		await writeAndFormat(this.fileURL, this.content);
 	}
 }
 
diff --git a/packages/eslint-plugin-svelte/tools/update-meta.ts b/packages/eslint-plugin-svelte/tools/update-meta.ts
@@ -1,17 +1,15 @@
-import { fileURLToPath } from 'url';
 import { name, version } from '../package.json';
 import { getNewVersion } from './lib/changesets-util.js';
 import { writeAndFormat } from './lib/write.js';
 
-const fileURL = new URL('../src/meta.ts', import.meta.url);
-const META_PATH = fileURLToPath(fileURL);
+const META_URL = new URL('../src/meta.ts', import.meta.url);
 
 void main();
 
 /** main */
 async function main() {
 	await writeAndFormat(
-		META_PATH,
+		META_URL,
 		`/*
  * IMPORTANT!
  * This file has been automatically generated,
diff --git a/packages/eslint-plugin-svelte/tools/update-readme.ts b/packages/eslint-plugin-svelte/tools/update-readme.ts
@@ -1,27 +1,26 @@
-import path from 'path';
 import fs from 'fs';
 import renderRulesTableContent from './render-rules.js';
 import { writeAndFormat } from './lib/write.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const rootURL = new URL('../../../', import.meta.url);
 
 const insertText = `\n${renderRulesTableContent(
 	(name) => `https://sveltejs.github.io/eslint-plugin-svelte/rules/${name}/`
 )}\n`;
 
-const readmeFilePath = path.resolve(__dirname, '../../../README.md');
+const readmeFileURL = new URL('README.md', rootURL);
 const newReadme = fs
-	.readFileSync(readmeFilePath, 'utf8')
+	.readFileSync(readmeFileURL, 'utf8')
 	.replace(
 		/<!--RULES_TABLE_START-->[\s\S]*<!--RULES_TABLE_END-->/u,
 		`<!--RULES_TABLE_START-->${insertText.replace(/\$/g, '$$$$')}<!--RULES_TABLE_END-->`
 	);
-void writeAndFormat(readmeFilePath, newReadme);
+void writeAndFormat(readmeFileURL, newReadme);
 
-const docsReadmeFilePath = path.resolve(__dirname, '../../../docs/README.md');
+const docsReadmeFileURL = new URL('./docs/README.md', rootURL);
 
 void writeAndFormat(
-	docsReadmeFilePath,
+	docsReadmeFileURL,
 	`---
 title: "eslint-plugin-svelte"
 ---
@@ -65,12 +64,12 @@ ${newReadme
 	.replace(/\n{3,}/gu, '\n\n')}`
 );
 
-const docsUserGuideFilePath = path.resolve(__dirname, '../../../docs/user-guide.md');
+const docsUserGuideFileURL = new URL('./docs/user-guide.md', rootURL);
 
-const docsUserGuide = fs.readFileSync(docsUserGuideFilePath, 'utf8');
+const docsUserGuide = fs.readFileSync(docsUserGuideFileURL, 'utf8');
 
 void writeAndFormat(
-	docsUserGuideFilePath,
+	docsUserGuideFileURL,
 	docsUserGuide
 		.replace(
 			/<!--USAGE_GUIDE_START-->[\s\S]*<!--USAGE_GUIDE_END-->/u,
diff --git a/packages/eslint-plugin-svelte/tools/update-rule-types.ts b/packages/eslint-plugin-svelte/tools/update-rule-types.ts
@@ -1,9 +1,6 @@
 import fs from 'fs';
-import path from 'path';
 import plugin from '../src/index.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
-
 void main();
 
 async function main() {
@@ -13,7 +10,7 @@ async function main() {
 	const ruleTypes = await pluginsToRulesDTS({ svelte: plugin });
 
 	void fs.writeFileSync(
-		path.join(__dirname, '../src/rule-types.ts'),
+		new URL('../src/rule-types.ts', import.meta.url),
 		`// IMPORTANT!
 // This file has been automatically generated,
 // in order to update its content execute "pnpm run update"
diff --git a/packages/eslint-plugin-svelte/tools/update-rules.ts b/packages/eslint-plugin-svelte/tools/update-rules.ts
@@ -1,10 +1,7 @@
-import path from 'path';
 // import eslint from "eslint"
 import { rules } from './lib/load-rules.js';
 import { writeAndFormat } from './lib/write.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
-
 /**
  * Convert text to camelCase
  */
@@ -41,7 +38,7 @@ export const rules = [
 ] as RuleModule[]
 `;
 
-const filePath = path.resolve(__dirname, '../src/utils/rules.ts');
+const fileURL = new URL('../src/utils/rules.ts', import.meta.url);
 
 // Update file.
-void writeAndFormat(filePath, content);
+void writeAndFormat(fileURL, content);
diff --git a/packages/eslint-plugin-svelte/tools/update-rulesets.ts b/packages/eslint-plugin-svelte/tools/update-rulesets.ts
@@ -1,8 +1,7 @@
-import path from 'path';
 import { rules } from './lib/load-rules.js';
 import { writeAndFormat } from './lib/write.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const flatConfigFolderURL = new URL('../src/configs/flat/', import.meta.url);
 
 // ------------------
 // Flat Config
@@ -79,10 +78,10 @@ const config: Linter.Config[] = [
 export default config
 `;
 
-const baseFilePath = path.resolve(__dirname, '../src/configs/flat/base.ts');
+const baseFileURL = new URL('base.ts', flatConfigFolderURL);
 
 // Update file.
-void writeAndFormat(baseFilePath, baseContent);
+void writeAndFormat(baseFileURL, baseContent);
 
 const recommendedContent = `/*
  * IMPORTANT!
@@ -110,10 +109,10 @@ const config: Linter.Config[] = [
 export default config
 `;
 
-const recommendedFilePath = path.resolve(__dirname, '../src/configs/flat/recommended.ts');
+const recommendedFileURL = new URL('recommended.ts', flatConfigFolderURL);
 
 // Update file.
-void writeAndFormat(recommendedFilePath, recommendedContent);
+void writeAndFormat(recommendedFileURL, recommendedContent);
 
 const prettierContent = `/*
  * IMPORTANT!
@@ -138,7 +137,7 @@ const config: Linter.Config[] = [
 export default config
 `;
 
-const prettierFilePath = path.resolve(__dirname, '../src/configs/flat/prettier.ts');
+const prettierFileURL = new URL('prettier.ts', flatConfigFolderURL);
 
 // Update file.
-void writeAndFormat(prettierFilePath, prettierContent);
+void writeAndFormat(prettierFileURL, prettierContent);
diff --git a/packages/eslint-plugin-svelte/tools/update-types-for-node.ts b/packages/eslint-plugin-svelte/tools/update-types-for-node.ts
@@ -1,15 +1,11 @@
 import { AST_NODE_TYPES } from '@typescript-eslint/types';
 import { parseForESLint } from 'svelte-eslint-parser';
-import path from 'path';
 import { writeAndFormat } from './lib/write.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const sourceFolderURL = new URL('../src/', import.meta.url);
 
-// import { fileURLToPath } from "url"
-// const filename = fileURLToPath(import.meta.url)
-const dirname = __dirname; // path.dirname(filename)
-const typesForNodeFilename = path.join(dirname, '../src/types-for-node.ts');
-const estreeFilename = path.join(dirname, '../src/type-defs/estree.d.ts');
+const typesForNodeFileURL = new URL('types-for-node.ts', sourceFolderURL);
+const estreeFileURL = new URL('type-defs/estree.d.ts', sourceFolderURL);
 const { visitorKeys } = parseForESLint('');
 
 const esNextNodeNames = ['Decorator', 'ImportAttribute', 'StaticBlock'];
@@ -119,5 +115,5 @@ for (const nodeType of svelteNodeNames.filter((k) => !esSvelteNodeNames.includes
 typesForNodeCode.push(`}`);
 
 estreeCode.push(`}`);
-void writeAndFormat(typesForNodeFilename, typesForNodeCode.join('\n'));
-void writeAndFormat(estreeFilename, estreeCode.join('\n'));
+void writeAndFormat(typesForNodeFileURL, typesForNodeCode.join('\n'));
+void writeAndFormat(estreeFileURL, estreeCode.join('\n'));
