feat: add windows support (#1355)

Author: InkedCat

.changeset/icy-rocks-camp.md

@@ -0,0 +1,7 @@
+---
+'eslint-plugin-svelte': patch
+---
+
+fix: properly support Windows in `no-unused-props` rule
+fix: properly support Windows in `valid-style-parse` rule
+fix: properly support Windows in `no-unnecessary-condition` rule

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/NodeCI.yml

@@ -9,6 +9,12 @@ on:
 env:
   project_root_path: ./packages/eslint-plugin-svelte
 
+defaults:
+  run:
+    # Setting every runner to bash simplifies command calls;
+    #  plus, every platform supports it
+    shell: bash
+
 jobs:
   lint:
     runs-on: ubuntu-latest
@@ -51,7 +57,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
         eslint: [8, 9]
         node: [18.x, 20.x, 22.x, latest]
     steps:
@@ -84,7 +90,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
         eslint: [9]
         node: [18, 20, 22]
     steps:
@@ -115,7 +121,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
         node: [18]
     steps:
       - name: Checkout

.vscode/settings.json

@@ -10,5 +10,6 @@
 	"typescript.tsdk": "node_modules/typescript/lib",
 	"[typescript]": {
 		"editor.defaultFormatter": "esbenp.prettier-vscode"
-	}
+	},
+	"files.eol": "\n"
 }

packages/eslint-plugin-svelte/src/rules/no-unused-props.ts

@@ -4,6 +4,7 @@ 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 { normalize } from 'path';
 
 type PropertyPathArray = string[];
 type DeclaredPropertyNames = Set<{ originalName: string; aliasName: string }>;
@@ -122,7 +123,8 @@ export default createRule('no-unused-props', {
 			const declarations = symbol.getDeclarations();
 			if (!declarations || declarations.length === 0) return false;
 
-			return declarations.every((decl) => decl.getSourceFile().fileName === fileName);
+			// TypeScript declaration file name is normalized to support Windows style paths
+			return declarations.every((decl) => normalize(decl.getSourceFile().fileName) === fileName);
 		}
 
 		/**

packages/eslint-plugin-svelte/src/rules/valid-style-parse.ts

@@ -1,4 +1,5 @@
 import { createRule } from '../utils/index.js';
+import path from 'path';
 
 export default createRule('valid-style-parse', {
 	meta: {
@@ -16,15 +17,20 @@ export default createRule('valid-style-parse', {
 		if (!sourceCode.parserServices.isSvelte) {
 			return {};
 		}
-		const cwd = `${context.cwd ?? process.cwd()}/`;
+		const cwd = `${context.cwd ?? process.cwd()}${path.sep}`;
 
 		return {
 			SvelteStyleElement(node) {
 				const styleContext = sourceCode.parserServices.getStyleContext!();
 				if (styleContext.status === 'parse-error') {
+					// This will replace backslashes to forward slashes only
+					// 	if Node.js reports Windows style path separators
+					let message = styleContext.error.message.replace(cwd, '');
+					if (path.sep === '\\') message = message.replace(/\\/g, '/');
+
 					context.report({
 						loc: node.loc,
-						message: `Error parsing style element. Error message: "${styleContext.error.message.replace(cwd, '')}"`
+						message: `Error parsing style element. Error message: "${message}"`
 					});
 				}
 				if (styleContext.status === 'unknown-lang') {

packages/eslint-plugin-svelte/tests/src/rules/@typescript-eslint/original-tests/no-unnecessary-condition.ts

@@ -2,13 +2,15 @@
 // https://github.com/typescript-eslint/typescript-eslint/blob/78467fc1bde9bd2db1e08b3d19f151f4adaff8a9/packages/eslint-plugin/tests/rules/no-unnecessary-condition.test.ts
 /* eslint func-style: off, eslint-plugin/consistent-output: off -- respect original  */
 import * as path from 'path';
+import { fileURLToPath } from 'url';
 import { RuleTester } from '../../../../utils/eslint-compat.js';
 import type * as eslint from 'eslint';
 import * as typescriptParser from '@typescript-eslint/parser';
 
 import rule from '../../../../../src/rules/@typescript-eslint/no-unnecessary-condition.js';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const url = new URL(import.meta.url);
+const __dirname = path.dirname(fileURLToPath(url));
 
 function getFixturesRootDir(): string {
 	return path.join(__dirname, 'fixtures');

packages/eslint-plugin-svelte/tests/utils/utils.ts

@@ -12,8 +12,9 @@ import * as svelteParser from 'svelte-eslint-parser';
 import * as typescriptParser from '@typescript-eslint/parser';
 import Module from 'module';
 import globals from 'globals';
+import { fileURLToPath } from 'url';
 
-const __dirname = path.dirname(new URL(import.meta.url).pathname);
+const __dirname = path.dirname(fileURLToPath(new URL(import.meta.url)));
 const require = Module.createRequire(import.meta.url);
 
 /**
@@ -304,7 +305,8 @@ function writeFixtures(
 }
 
 function getConfig(ruleName: string, inputFile: string) {
-	const filename = inputFile.slice(inputFile.indexOf(ruleName));
+	// ruleName is normalized to support Windows style paths
+	const filename = inputFile.slice(inputFile.indexOf(path.normalize(ruleName)));
 	const code = fs.readFileSync(inputFile, 'utf8');
 	let config;
 	let configFile = [

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;
 }

packages/eslint-plugin-svelte/tools/lib/load-rules.ts

@@ -2,17 +2,16 @@ import path from 'path';
 import fs from 'fs';
 import type { RuleModule } from '../../src/types.js';
 
-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 +26,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)));
 	}
 }