chore: update esrap (#620)

* chore: update `esrap`

* use esrap pkg.pr.new

* fix `svelte-kit` adapter addon

* remove useless comment

* fix eslint

* fix eslint

* add changed tests

* thats ok too

* those are ok as well

* fix last failing test

* update esrap

* adapt to new api

* improvements

* cleanup

* remove useless comment

* Update packages/core/tooling/index.ts

Co-authored-by: Copilot <[email protected]>

* re-add quote style

* using esrap 2.2.1

* simplifying?

* good enough?

* simplify

* add & remove

* api?

* manual snapshot review OK

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: jycouet <[email protected]>

Author: 3 people

packages/addons/eslint/index.ts

@@ -53,7 +53,7 @@ export default defineAddon({
 		});
 
 		sv.file(files.eslintConfig, (content) => {
-			const { ast, generateCode } = parseScript(content);
+			const { ast, comments, generateCode } = parseScript(content);
 
 			const eslintConfigs: Array<AstTypes.Expression | AstTypes.SpreadElement> = [];
 			imports.addDefault(ast, { from: './svelte.config.js', as: 'svelteConfig' });
@@ -85,18 +85,16 @@ export default defineAddon({
 			if (rules.properties[0].type !== 'Property') {
 				throw new Error('rules.properties[0].type !== "Property"');
 			}
-			rules.properties[0].key.leadingComments = [
-				{
-					type: 'Line',
-					value:
-						' typescript-eslint strongly recommend that you do not use the no-undef lint rule on TypeScript projects.'
-				},
-				{
-					type: 'Line',
-					value:
-						' see: https://typescript-eslint.io/troubleshooting/faqs/eslint/#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors'
-				}
-			];
+			comments.add(rules.properties[0].key, {
+				type: 'Line',
+				value:
+					' typescript-eslint strongly recommend that you do not use the no-undef lint rule on TypeScript projects.'
+			});
+			comments.add(rules.properties[0].key, {
+				type: 'Line',
+				value:
+					' see: https://typescript-eslint.io/troubleshooting/faqs/eslint/#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors'
+			});
 
 			const globalsConfig = object.create({
 				languageOptions: {
@@ -153,7 +151,9 @@ export default defineAddon({
 
 			// type annotate config
 			if (!typescript)
-				common.addJsDocTypeComment(astNode, { type: "import('eslint').Linter.Config[]" });
+				common.addJsDocTypeComment(astNode, comments, {
+					type: "import('eslint').Linter.Config[]"
+				});
 
 			if (typescript) imports.addDefault(ast, { from: 'typescript-eslint', as: 'ts' });
 			imports.addDefault(ast, { from: 'globals', as: 'globals' });

packages/addons/sveltekit-adapter/index.ts

@@ -49,7 +49,7 @@ export default defineAddon({
 		sv.devDependency(adapter.package, adapter.version);
 
 		sv.file(files.svelteConfig, (content) => {
-			const { ast, generateCode } = parseScript(content);
+			const { ast, comments, generateCode } = parseScript(content);
 
 			// finds any existing adapter's import declaration
 			const importDecls = ast.body.filter((n) => n.type === 'ImportDeclaration');
@@ -86,8 +86,15 @@ export default defineAddon({
 			if (adapter.package !== '@sveltejs/adapter-auto') {
 				const fallback = object.create({});
 				const cfgKitValue = object.property(config, { name: 'kit', fallback });
-				const cfgAdapter = object.propertyNode(cfgKitValue, { name: 'adapter', fallback });
-				cfgAdapter.leadingComments = [];
+
+				// removes any existing adapter auto comments
+				comments.remove(
+					(c) =>
+						c.loc &&
+						cfgKitValue.loc &&
+						c.loc.start.line >= cfgKitValue.loc.start.line &&
+						c.loc.end.line <= cfgKitValue.loc.end.line
+				);
 			}
 
 			return generateCode();

packages/cli/tests/snapshots/create-with-all-addons/playwright.config.ts

@@ -1,9 +1,6 @@
 import { defineConfig } from '@playwright/test';
 
 export default defineConfig({
-	webServer: {
-		command: 'npm run build && npm run preview',
-		port: 4173
-	},
+	webServer: { command: 'npm run build && npm run preview', port: 4173 },
 	testDir: 'e2e'
 });

packages/cli/tests/snapshots/create-with-all-addons/src/app.d.ts

@@ -6,10 +6,13 @@ declare global {
 			user: import('$lib/server/auth').SessionValidationResult['user'];
 			session: import('$lib/server/auth').SessionValidationResult['session']
 		}
-	} // interface Error {}
-	// interface Locals {}
-} // interface PageData {}
-// interface PageState {}
 
-// interface Platform {}
+		// interface Error {}
+		// interface Locals {}
+		// interface PageData {}
+		// interface PageState {}
+		// interface Platform {}
+	}
+}
+
 export {};

packages/cli/tests/snapshots/create-with-all-addons/src/hooks.server.ts

@@ -17,6 +17,7 @@ const handleAuth: Handle = async ({ event, resolve }) => {
 	if (!sessionToken) {
 		event.locals.user = null;
 		event.locals.session = null;
+
 		return resolve(event);
 	}
 
@@ -30,6 +31,7 @@ const handleAuth: Handle = async ({ event, resolve }) => {
 
 	event.locals.user = user;
 	event.locals.session = session;
+
 	return resolve(event);
 };
 

packages/cli/tests/snapshots/create-with-all-addons/svelte.config.js

@@ -7,6 +7,7 @@ const config = {
 	// Consult https://svelte.dev/docs/kit/integrations
 	// for more information about preprocessors
 	preprocess: [vitePreprocess(), mdsvex()],
+
 	kit: { adapter: adapter() },
 	extensions: ['.svelte', '.svx']
 };

packages/cli/tests/snapshots/create-with-all-addons/vite.config.ts

@@ -10,29 +10,33 @@ export default defineConfig({
 		tailwindcss(),
 		sveltekit(),
 		devtoolsJson(),
-		paraglideVitePlugin({
-			project: './project.inlang',
-			outdir: './src/lib/paraglide'
-		})
+		paraglideVitePlugin({ project: './project.inlang', outdir: './src/lib/paraglide' })
 	],
+
 	test: {
 		expect: { requireAssertions: true },
+
 		projects: [
 			{
 				extends: './vite.config.ts',
+
 				test: {
 					name: 'client',
+
 					browser: {
 						enabled: true,
 						provider: playwright(),
 						instances: [{ browser: 'chromium', headless: true }]
 					},
+
 					include: ['src/**/*.svelte.{test,spec}.{js,ts}'],
 					exclude: ['src/lib/server/**']
 				}
 			},
+
 			{
 				extends: './vite.config.ts',
+
 				test: {
 					name: 'server',
 					environment: 'node',

packages/core/package.json

@@ -34,7 +34,7 @@
 		"dom-serializer": "^2.0.0",
 		"domhandler": "^5.0.3",
 		"domutils": "^3.2.2",
-		"esrap": "^1.4.9",
+		"esrap": "^2.2.1",
 		"htmlparser2": "^9.1.0",
 		"magic-string": "^0.30.21",
 		"picocolors": "^1.1.1",

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

@@ -1,9 +1,14 @@
-import { common, type AstTypes } from '@sveltejs/cli-core/js';
+import { common, type Comments, type AstTypes } from '@sveltejs/cli-core/js';
 
-export function run(ast: AstTypes.Program): void {
+export function run(ast: AstTypes.Program, comments: Comments): void {
 	const functionDeclaration = ast.body[0] as AstTypes.FunctionDeclaration;
 
-	common.addJsDocComment(functionDeclaration, {
+	common.addJsDocComment(functionDeclaration, comments, {
+		params: { 'import("$lib/paraglide/runtime").AvailableLanguageTag': 'newLanguage' }
+	});
+
+	// Adding 2 times the same comment should not add it twice!
+	common.addJsDocComment(functionDeclaration, comments, {
 		params: { 'import("$lib/paraglide/runtime").AvailableLanguageTag': 'newLanguage' }
 	});
 }

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

@@ -1,2 +1 @@
-/** @type {number} */
-const foo = 42;
+/** @type {number} */ const foo = 42;