fix eslint

Author: manuel3108

packages/addons/eslint/index.ts

@@ -154,7 +154,9 @@ export default defineAddon({
 
 			// type annotate config
 			if (!typescript)
-				common.addJsDocTypeComment(astNode, { type: "import('eslint').Linter.Config[]" });
+				common.addJsDocTypeComment(astNode, additionalComments, {
+					type: "import('eslint').Linter.Config[]"
+				});
 
 			if (typescript) imports.addDefault(ast, { from: 'typescript-eslint', as: 'ts' });
 			imports.addNamed(ast, { from: 'node:url', imports: ['fileURLToPath'] });

packages/core/tests/js/common/jsdoc-comment/run.ts

@@ -1,9 +1,9 @@
-import { common, type AstTypes } from '@sveltejs/cli-core/js';
+import { common, type AdditionalCommentMap, type AstTypes } from '@sveltejs/cli-core/js';
 
-export function run(ast: AstTypes.Program): void {
+export function run(ast: AstTypes.Program, additionalComments: AdditionalCommentMap): void {
 	const functionDeclaration = ast.body[0] as AstTypes.FunctionDeclaration;
 
-	common.addJsDocComment(functionDeclaration, {
+	common.addJsDocComment(functionDeclaration, additionalComments, {
 		params: { 'import("$lib/paraglide/runtime").AvailableLanguageTag': 'newLanguage' }
 	});
 }

packages/core/tests/js/common/jsdoc-type-comment/run.ts

@@ -1,13 +1,13 @@
-import { common, variables, type AstTypes } from '@sveltejs/cli-core/js';
+import { common, variables, type AdditionalCommentMap, type AstTypes } from '@sveltejs/cli-core/js';
 
-export function run(ast: AstTypes.Program): void {
+export function run(ast: AstTypes.Program, additionalComments: AdditionalCommentMap): void {
 	const declaration = variables.declaration(ast, {
 		kind: 'const',
 		name: 'foo',
 		value: { type: 'Literal', value: 42 }
 	});
 
-	common.addJsDocTypeComment(declaration, {
+	common.addJsDocTypeComment(declaration, additionalComments, {
 		type: 'number'
 	});
 

packages/core/tests/js/index.ts

@@ -16,13 +16,13 @@ for (const categoryDirectory of categoryDirectories) {
 
 				const inputFilePath = join(testDirectoryPath, 'input.ts');
 				const input = fs.existsSync(inputFilePath) ? fs.readFileSync(inputFilePath, 'utf8') : '';
-				const { ast, comments } = parseScript(input);
+				const { ast, comments, additionalComments } = parseScript(input);
 
 				// dynamic imports always need to provide the path inline for static analysis
 				const module = await import(`./${categoryDirectory}/${testName}/run.ts`);
-				module.run(ast);
+				module.run(ast, additionalComments);
 
-				let output = serializeScript(ast, comments, input);
+				let output = serializeScript(ast, comments, input, additionalComments);
 				if (!output.endsWith('\n')) output += '\n';
 				await expect(output).toMatchFileSnapshot(`${testDirectoryPath}/output.ts`);
 			});

packages/core/tooling/index.ts

@@ -18,6 +18,8 @@ import ts, { type AdditionalComment } from 'esrap/languages/ts';
 import * as acorn from 'acorn';
 import { tsPlugin } from '@sveltejs/acorn-typescript';
 
+type AdditionalCommentMap = WeakMap<TsEstree.Node, AdditionalComment[]>;
+
 export {
 	// html
 	Document as HtmlDocument,
@@ -41,6 +43,7 @@ export type {
 
 	// js
 	TsEstree as AstTypes,
+	AdditionalCommentMap,
 
 	//css
 	CssChildNode
@@ -53,7 +56,7 @@ export type {
 export function parseScript(content: string): {
 	ast: TsEstree.Program;
 	comments: TsEstree.Comment[];
-	additionalComments: WeakMap<TsEstree.Node, AdditionalComment[]>;
+	additionalComments: AdditionalCommentMap;
 } {
 	const comments: TsEstree.Comment[] = [];
 
@@ -96,7 +99,7 @@ export function serializeScript(
 	ast: TsEstree.Node,
 	comments: TsEstree.Comment[],
 	previousContent?: string,
-	additionalComments?: WeakMap<TsEstree.Node, AdditionalComment[]>
+	additionalComments?: AdditionalCommentMap
 ): string {
 	// @ts-expect-error we are still using `estree` while `esrap` is using `@typescript-eslint/types`
 	// which is causing these errors. But they are simmilar enough to work together.

packages/core/tooling/js/common.ts

@@ -1,18 +1,30 @@
-import { type AstTypes, Walker, parseScript, serializeScript, stripAst } from '../index.ts';
+import {
+	type AdditionalCommentMap,
+	type AstTypes,
+	Walker,
+	parseScript,
+	serializeScript,
+	stripAst
+} from '../index.ts';
 import decircular from 'decircular';
 import dedent from 'dedent';
 
-export function addJsDocTypeComment(node: AstTypes.Node, options: { type: string }): void {
+export function addJsDocTypeComment(
+	node: AstTypes.Node,
+	additionalComments: AdditionalCommentMap,
+	options: { type: string }
+): void {
 	const comment: AstTypes.Comment = {
 		type: 'Block',
 		value: `* @type {${options.type}} `
 	};
 
-	addComment(node, comment);
+	addComment(node, additionalComments, comment);
 }
 
 export function addJsDocComment(
 	node: AstTypes.Node,
+	additionalComments: AdditionalCommentMap,
 	options: { params: Record<string, string> }
 ): void {
 	const commentLines: string[] = [];
@@ -25,16 +37,23 @@ export function addJsDocComment(
 		value: `*\n * ${commentLines.join('\n * ')}\n `
 	};
 
-	addComment(node, comment);
+	addComment(node, additionalComments, comment);
 }
 
-function addComment(node: AstTypes.Node, comment: AstTypes.Comment) {
-	node.leadingComments ??= [];
-
-	const found = node.leadingComments.find(
-		(item) => item.type === 'Block' && item.value === comment.value
-	);
-	if (!found) node.leadingComments.push(comment);
+function addComment(
+	node: AstTypes.Node,
+	additionalComments: AdditionalCommentMap,
+	comment: AstTypes.Comment
+) {
+	const found = additionalComments
+		.get(node)
+		?.find((item) => item.type === 'Block' && item.value === comment.value);
+
+	if (!found) {
+		const comments = additionalComments.get(node) ?? [];
+		comments.push({ ...comment, position: 'leading' });
+		additionalComments.set(node, comments);
+	}
 }
 
 export function typeAnnotate(

packages/core/tooling/js/index.ts

@@ -7,4 +7,4 @@ export * as variables from './variables.ts';
 export * as exports from './exports.ts';
 export * as kit from './kit.ts';
 export * as vite from './vite.ts';
-export type { AstTypes } from '../index.ts';
+export type { AstTypes, AdditionalCommentMap } from '../index.ts';

packages/core/tooling/parsers.ts

@@ -1,7 +1,5 @@
 import * as utils from './index.ts';
 import MagicString from 'magic-string';
-import type { TsEstree } from './js/ts-estree.ts';
-import type { AdditionalComment } from 'esrap/languages/ts';
 
 type ParseBase = {
 	source: string;
@@ -11,7 +9,7 @@ type ParseBase = {
 export function parseScript(source: string): {
 	ast: utils.AstTypes.Program;
 	comments: utils.AstTypes.Comment[];
-	additionalComments: WeakMap<TsEstree.Node, AdditionalComment[]>;
+	additionalComments: utils.AdditionalCommentMap;
 } & ParseBase {
 	const { ast, comments, additionalComments } = utils.parseScript(source);
 	const generateCode = () => utils.serializeScript(ast, comments, source, additionalComments);