chore: add comments to explain changes

Author: InkedCat

.github/workflows/NodeCI.yml

@@ -11,6 +11,8 @@ env:
 
 defaults:
   run:
+    # Setting every runner to bash simplifies command calls;
+    #  plus, every platform supports it
     shell: bash
 
 jobs:

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

@@ -123,6 +123,7 @@ export default createRule('no-unused-props', {
 			const declarations = symbol.getDeclarations();
 			if (!declarations || declarations.length === 0) return false;
 
+			// 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

@@ -23,6 +23,8 @@ export default createRule('valid-style-parse', {
 			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, '/');
 

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

@@ -305,6 +305,7 @@ function writeFixtures(
 }
 
 function getConfig(ruleName: string, inputFile: string) {
+	// 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;