chore: switch to estree compatible ast tooling (#380)

* use `acorn` and `estree`

* update tests

* fix most type errors

* update snapshots

* remove useless function

* fix

* fix check

* update esrap

* fix

* fixes

* remove now duplicated code

* fix sveltekit-adapter addon

* fix lucia

* update `esrap`

* update `esrap`

* remove unused code

* start work on indendation

* migrate to `@sveltejs/acorn-typescript`

* make it work

* changeset

* fix eslint quotes

* fixes

* remove useless import

* update tests

* remove todo

* changeset for code formatting

* dedupe

* should be evaluating the type of the `value`

* tweaks

* simplify

* use strict equality

* simplify

* fix and add missing test

* simplify more

* tweak

* re-export `CssAst` from `cli-core/css`

* fix arrowFunction

* add eslint strict equality rule

* removed unused interface

* revert

* improve comments

* fix eslint

---------

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

Author: manuel3108

.changeset/little-otters-call.md

@@ -0,0 +1,5 @@
+---
+'sv': minor
+---
+
+feat: enhanced code generation for more intuitive formatting

.changeset/olive-hotels-deny.md

@@ -0,0 +1,5 @@
+---
+'sv': minor
+---
+
+chore: switch to `estree` compatible ast tooling

eslint.config.js

@@ -17,6 +17,7 @@ export default [
 			}
 		},
 		rules: {
+			eqeqeq: 'error',
 			'@typescript-eslint/await-thenable': 'error',
 			'@typescript-eslint/no-unused-expressions': 'off',
 			'@typescript-eslint/require-await': 'error'

packages/addons/common.ts

@@ -39,7 +39,7 @@ export function addEslintConfigPrettier(content: string): string {
 	if (!common.hasNode(eslintConfig, configSpread)) nodesToInsert.push(configSpread);
 
 	const elements =
-		eslintConfig.type == 'ArrayExpression' ? eslintConfig.elements : eslintConfig.arguments;
+		eslintConfig.type === 'ArrayExpression' ? eslintConfig.elements : eslintConfig.arguments;
 	// finds index of `...svelte.configs["..."]`
 	const idx = elements.findIndex(
 		(el) =>

packages/addons/drizzle/index.ts

@@ -199,8 +199,8 @@ export default defineAddon({
 					url: common.expressionFromString('process.env.DATABASE_URL'),
 					authToken
 				}),
-				verbose: { type: 'BooleanLiteral', value: true },
-				strict: { type: 'BooleanLiteral', value: true }
+				verbose: { type: 'Literal', value: true },
+				strict: { type: 'Literal', value: true }
 			});
 
 			const dialect = options.sqlite === 'turso' ? 'turso' : options.database;
@@ -338,8 +338,8 @@ export default defineAddon({
 			const paramObject = object.create({
 				schema: variables.identifier('schema')
 			});
-			if (options.database == 'mysql') {
-				const mode = options.mysql == 'planetscale' ? 'planetscale' : 'default';
+			if (options.database === 'mysql') {
+				const mode = options.mysql === 'planetscale' ? 'planetscale' : 'default';
 				object.property(paramObject, 'mode', common.createLiteral(mode));
 			}
 			drizzleCall.arguments.push(paramObject);

packages/addons/eslint/index.ts

@@ -7,7 +7,6 @@ import {
 	functions,
 	imports,
 	object,
-	type AstKinds,
 	type AstTypes
 } from '@sveltejs/cli-core/js';
 import { parseJson, parseScript } from '@sveltejs/cli-core/parsers';
@@ -54,14 +53,12 @@ export default defineAddon({
 		sv.file('eslint.config.js', (content) => {
 			const { ast, generateCode } = parseScript(content);
 
-			const eslintConfigs: Array<
-				AstKinds.ExpressionKind | AstTypes.SpreadElement | AstTypes.ObjectExpression
-			> = [];
+			const eslintConfigs: Array<AstTypes.Expression | AstTypes.SpreadElement> = [];
 
 			imports.addDefault(ast, './svelte.config.js', 'svelteConfig');
 
 			const gitIgnorePathStatement = common.statementFromString(
-				'\nconst gitignorePath = fileURLToPath(new URL("./.gitignore", import.meta.url));'
+				"\nconst gitignorePath = fileURLToPath(new URL('./.gitignore', import.meta.url));"
 			);
 			common.addStatement(ast, gitIgnorePathStatement);
 
@@ -90,16 +87,19 @@ export default defineAddon({
 				'"no-undef"': off
 			});
 
-			if (rules.properties[0].type !== 'ObjectProperty') {
-				throw new Error('rules.properties[0].type !== "ObjectProperty"');
+			if (rules.properties[0].type !== 'Property') {
+				throw new Error('rules.properties[0].type !== "Property"');
 			}
-			rules.properties[0].key.comments = [
+			rules.properties[0].key.leadingComments = [
 				{
-					type: 'Block',
+					type: 'Line',
 					value:
-						'*\n   * typescript-eslint strongly recommend that you do not use the no-undef lint rule on TypeScript projects.\n   * 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\n ',
-					leading: true,
-					trailing: false
+						' 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'
 				}
 			];
 
@@ -114,8 +114,8 @@ export default defineAddon({
 
 			if (typescript) {
 				const svelteTSParserConfig = object.create({
-					files: common.expressionFromString('["**/*.svelte", "**/*.svelte.ts", "**/*.svelte.js"]'),
-					ignores: common.expressionFromString('["eslint.config.js", "svelte.config.js"]'),
+					files: common.expressionFromString("['**/*.svelte', '**/*.svelte.ts', '**/*.svelte.js']"),
+					ignores: common.expressionFromString("['eslint.config.js', 'svelte.config.js']"),
 					languageOptions: object.create({
 						parserOptions: object.create({
 							projectService: common.expressionFromString('true'),
@@ -128,7 +128,7 @@ export default defineAddon({
 				eslintConfigs.push(svelteTSParserConfig);
 			} else {
 				const svelteTSParserConfig = object.create({
-					files: common.expressionFromString('["**/*.svelte", "**/*.svelte.js"]'),
+					files: common.expressionFromString("['**/*.svelte', '**/*.svelte.js']"),
 					languageOptions: object.create({
 						parserOptions: object.create({
 							svelteConfig: common.expressionFromString('svelteConfig')

packages/addons/lucia/index.ts

@@ -55,20 +55,27 @@ export default defineAddon({
 
 		sv.file(`drizzle.config.${ext}`, (content) => {
 			const { ast, generateCode } = parseScript(content);
-			const isProp = (name: string, node: AstTypes.ObjectProperty) =>
+			const isProp = (name: string, node: AstTypes.Property) =>
 				node.key.type === 'Identifier' && node.key.name === name;
 
-			// prettier-ignore
-			Walker.walk(ast as AstTypes.ASTNode, {}, {
-				ObjectProperty(node) {
-					if (isProp('dialect', node) && node.value.type === 'StringLiteral') {
+			Walker.walk(ast as AstTypes.Node, null, {
+				Property(node) {
+					if (
+						isProp('dialect', node) &&
+						node.value.type === 'Literal' &&
+						typeof node.value.value === 'string'
+					) {
 						drizzleDialect = node.value.value as Dialect;
 					}
-					if (isProp('schema', node) && node.value.type === 'StringLiteral') {
+					if (
+						isProp('schema', node) &&
+						node.value.type === 'Literal' &&
+						typeof node.value.value === 'string'
+					) {
 						schemaPath = node.value.value;
 					}
 				}
-			})
+			});
 
 			if (!drizzleDialect) {
 				throw new Error('Failed to detect DB dialect in your `drizzle.config.[js|ts]` file');
@@ -601,13 +608,14 @@ function createLuciaType(name: string): AstTypes.TSInterfaceBody['body'][number]
 			type: 'Identifier',
 			name
 		},
+		computed: false,
 		typeAnnotation: {
 			type: 'TSTypeAnnotation',
 			typeAnnotation: {
 				type: 'TSIndexedAccessType',
 				objectType: {
 					type: 'TSImportType',
-					argument: { type: 'StringLiteral', value: '$lib/server/auth' },
+					argument: { type: 'Literal', value: '$lib/server/auth' },
 					qualifier: {
 						type: 'Identifier',
 						name: 'SessionValidationResult'
@@ -616,7 +624,7 @@ function createLuciaType(name: string): AstTypes.TSInterfaceBody['body'][number]
 				indexType: {
 					type: 'TSLiteralType',
 					literal: {
-						type: 'StringLiteral',
+						type: 'Literal',
 						value: name
 					}
 				}
@@ -649,14 +657,13 @@ function getAuthHandleContent() {
 		};`;
 }
 
-function getCallExpression(ast: AstTypes.ASTNode): AstTypes.CallExpression | undefined {
+function getCallExpression(ast: AstTypes.Node): AstTypes.CallExpression | undefined {
 	let callExpression;
 
-	// prettier-ignore
-	Walker.walk(ast, {}, {
+	Walker.walk(ast, null, {
 		CallExpression(node) {
 			callExpression ??= node;
-		},
+		}
 	});
 
 	return callExpression;

packages/addons/sveltekit-adapter/index.ts

@@ -71,6 +71,9 @@ export default defineAddon({
 			if (adapterImportDecl) {
 				// replaces the import's source with the new adapter
 				adapterImportDecl.source.value = adapter.package;
+				// reset raw value, so that the string is re-generated
+				adapterImportDecl.source.raw = undefined;
+
 				adapterName = adapterImportDecl.specifiers?.find((s) => s.type === 'ImportDefaultSpecifier')
 					?.local?.name as string;
 			} else {
@@ -79,16 +82,15 @@ export default defineAddon({
 
 			const { value: config } = exports.defaultExport(ast, object.createEmpty());
 			const kitConfig = config.properties.find(
-				(p) => p.type === 'ObjectProperty' && p.key.type === 'Identifier' && p.key.name === 'kit'
-			) as AstTypes.ObjectProperty | undefined;
+				(p) => p.type === 'Property' && p.key.type === 'Identifier' && p.key.name === 'kit'
+			) as AstTypes.Property | undefined;
 
 			if (kitConfig && kitConfig.value.type === 'ObjectExpression') {
 				const adapterProp = kitConfig.value.properties.find(
-					(p) =>
-						p.type === 'ObjectProperty' && p.key.type === 'Identifier' && p.key.name === 'adapter'
+					(p) => p.type === 'Property' && p.key.type === 'Identifier' && p.key.name === 'adapter'
 				);
 				if (adapterProp) {
-					adapterProp.comments = [];
+					adapterProp.leadingComments = [];
 				}
 
 				// only overrides the `adapter` property so we can reset it's args