chore: switch to @sveltejs/acorn-typescript (#51)

manuel3108 · web-flow · commit 4b2ed6b880a7 · 2025-04-01T10:29:10.000+02:00
* switch to `@sveltejs/acorn-typescript`

* fix tests
diff --git a/package.json b/package.json
@@ -20,10 +20,10 @@
   "types": "./types/index.d.ts",
   "devDependencies": {
     "@changesets/cli": "^2.27.11",
+    "@sveltejs/acorn-typescript": "^1.0.5",
     "@typescript-eslint/types": "^8.2.0",
     "@vitest/ui": "^2.1.1",
     "acorn": "^8.11.3",
-    "acorn-typescript": "^1.4.13",
     "dts-buddy": "^0.5.4",
     "prettier": "^3.0.3",
     "typescript": "^5.7.2",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/handlers.js b/src/handlers.js
@@ -501,8 +501,9 @@ function handle_type_annotation(node, state) {
 		case 'TSTypeReference':
 			handle(node.typeName, state);
 
-			// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
-			if (node.typeParameters) handle_type_annotation(node.typeParameters, state);
+			if (node.typeArguments) {
+				handle_type_annotation(node.typeArguments, state);
+			}
 			break;
 		case 'TSTypeParameterInstantiation':
 		case 'TSTypeParameterDeclaration':
@@ -514,7 +515,7 @@ function handle_type_annotation(node, state) {
 			state.commands.push('>');
 			break;
 		case 'TSTypeParameter':
-			// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
+			// @ts-expect-error `acorn-typescript` and `@typescript-eslint/types` have slightly different type definitions
 			state.commands.push(node.name);
 
 			if (node.constraint) {
@@ -536,14 +537,14 @@ function handle_type_annotation(node, state) {
 		case 'TSFunctionType':
 			if (node.typeParameters) handle_type_annotation(node.typeParameters, state);
 
-			// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
+			// @ts-expect-error `acorn-typescript` and `@typescript-eslint/types` have slightly different type definitions
 			const parameters = node.parameters;
 			state.commands.push('(');
 			sequence(parameters, state, false, handle);
 
 			state.commands.push(') => ');
 
-			// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
+			// @ts-expect-error `acorn-typescript` and `@typescript-eslint/types` have slightly different type definitions
 			handle_type_annotation(node.typeAnnotation.typeAnnotation, state);
 			break;
 		case 'TSIndexSignature':
@@ -552,19 +553,19 @@ function handle_type_annotation(node, state) {
 			sequence(indexParameters, state, false, handle);
 			state.commands.push(']');
 
-			// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
+			// @ts-expect-error `acorn-typescript` and `@typescript-eslint/types` have slightly different type definitions
 			handle_type_annotation(node.typeAnnotation, state);
 			break;
 		case 'TSMethodSignature':
 			handle(node.key, state);
 
-			// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
+			// @ts-expect-error `acorn-typescript` and `@typescript-eslint/types` have slightly different type definitions
 			const parametersSignature = node.parameters;
 			state.commands.push('(');
 			sequence(parametersSignature, state, false, handle);
 			state.commands.push(')');
 
-			// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
+			// @ts-expect-error `acorn-typescript` and `@typescript-eslint/types` have slightly different type definitions
 			handle_type_annotation(node.typeAnnotation, state);
 			break;
 		case 'TSExpressionWithTypeArguments':
@@ -715,8 +716,7 @@ const shared = {
 			state.commands.push('?.');
 		}
 
-		// @ts-expect-error
-		if (node.typeParameters) handle_type_annotation(node.typeParameters, state);
+		if (node.typeArguments) handle_type_annotation(node.typeArguments, state);
 
 		const open = create_sequence();
 		const join = create_sequence();
@@ -852,7 +852,7 @@ const shared = {
 		state.commands.push('...');
 		handle(node.argument, state);
 
-		// @ts-expect-error `acorn-typescript` and `@typescript-esling/types` have slightly different type definitions
+		// @ts-expect-error `acorn-typescript` and `@typescript-eslint/types` have slightly different type definitions
 		if (node.typeAnnotation) handle_type_annotation(node.typeAnnotation, state);
 	}
 };
diff --git a/test/common.js b/test/common.js
@@ -1,12 +1,18 @@
+// @ts-check
+
 import * as acorn from 'acorn';
-import { tsPlugin } from 'acorn-typescript';
+import { tsPlugin } from '@sveltejs/acorn-typescript';
 import { walk } from 'zimmerframe';
 
+/** @import { TSESTree } from '@typescript-eslint/types' */
+/** @import { NodeWithComments } from '../src/types' */
+
 // @ts-expect-error
 export const acornTs = acorn.Parser.extend(tsPlugin({ allowSatisfies: true }));
 
 /** @param {string} input */
 export function load(input) {
+	/** @type {any[]} */
 	const comments = [];
 
 	const ast = acornTs.parse(input, {
diff --git a/test/esrap.test.js b/test/esrap.test.js
@@ -1,6 +1,6 @@
 // @ts-check
 /** @import { TSESTree } from '@typescript-eslint/types' */
-/** @import { NodeWithComments, PrintOptions } from '../src/types' */
+/** @import { PrintOptions } from '../src/types' */
 import fs from 'node:fs';
 import { expect, test } from 'vitest';
 import { walk } from 'zimmerframe';
diff --git a/test/indent.test.js b/test/indent.test.js
@@ -1,3 +1,5 @@
+// @ts-check
+
 import { test } from 'vitest';
 import { load } from './common';
 import { print } from '../src';
diff --git a/test/quotes.test.js b/test/quotes.test.js
@@ -1,18 +1,22 @@
+// @ts-check
+
 import { test } from 'vitest';
 import { print } from '../src/index.js';
 import { expect } from 'vitest';
 import { load } from './common.js';
 import { walk } from 'zimmerframe';
-import { TSESTree } from '@typescript-eslint/types';
+
+/** @import { TSESTree } from '@typescript-eslint/types' */
 
 /**
  * Removes the `raw` property from all `Literal` nodes, as the printer is prefering it's
  * value. Only if the `raw` value is not present it will try to add the prefered quoting
- * @param {TSESTree.Program} ast
+ * @param {TSESTree.Node} ast
  */
 function clean(ast) {
 	walk(ast, null, {
 		Literal(node, { next }) {
+			// @ts-expect-error
 			delete node.raw;
 
 			next();
@@ -100,4 +104,4 @@ test('correctly handle \\n\\r', () => {
 	const code = print(ast).code;
 
 	expect(code).toMatchInlineSnapshot(`"const str = 'a\\n\\rb';"`);
-});
+});
diff --git a/test/samples/large-file/expected.js b/test/samples/large-file/expected.js
@@ -2294,7 +2294,10 @@
 				return bySet ? markFunction(superMatcher) : superMatcher;
 			}
 
-			function compile(selector, match) /* Internal Use Only */ {
+			function compile(
+				selector,
+				match /* Internal Use Only */
+			) {
 				var i,
 					setMatchers = [],
 					elementMatchers = [],
diff --git a/test/samples/large-file/expected.js.map b/test/samples/large-file/expected.js.map
diff --git a/test/sandbox/index.js b/test/sandbox/index.js
@@ -1,66 +1,10 @@
 // @ts-check
-/** @import { TSESTree } from '@typescript-eslint/types' */
-/** @import { NodeWithComments } from '../../src/types' */
-import * as acorn from 'acorn';
-import { tsPlugin } from 'acorn-typescript';
-import { walk } from 'zimmerframe';
 import { print } from '../../src/index.js';
+import { load } from '../common.js';
 import fs from 'fs';
 import path from 'path';
 import { fileURLToPath } from 'url';
 
-/** @param {string} input */
-function load(input) {
-	const comments = [];
-
-	// @ts-expect-error
-	const acornTs = acorn.Parser.extend(tsPlugin({ allowSatisfies: true }));
-
-	const ast = acornTs.parse(input, {
-		ecmaVersion: 'latest',
-		sourceType: 'module',
-		locations: true,
-		onComment: (block, value, start, end) => {
-			if (block && /\n/.test(value)) {
-				let a = start;
-				while (a > 0 && input[a - 1] !== '\n') a -= 1;
-
-				let b = a;
-				while (/[ \t]/.test(input[b])) b += 1;
-
-				const indentation = input.slice(a, b);
-				value = value.replace(new RegExp(`^${indentation}`, 'gm'), '');
-			}
-
-			comments.push({ type: block ? 'Block' : 'Line', value, start, end });
-		}
-	});
-
-	walk(ast, null, {
-		_(node, { next }) {
-			const commentNode = /** @type {NodeWithComments} */ (/** @type {any} */ (node));
-			let comment;
-
-			while (comments[0] && comments[0].start < node.start) {
-				comment = comments.shift();
-				(commentNode.leadingComments ||= []).push(comment);
-			}
-
-			next();
-
-			if (comments[0]) {
-				const slice = input.slice(node.end, comments[0].start);
-
-				if (/^[,) \t]*$/.test(slice)) {
-					commentNode.trailingComments = [comments.shift()];
-				}
-			}
-		}
-	});
-
-	return /** @type {TSESTree.Program} */ (/** @type {any} */ (ast));
-}
-
 const dir = path.resolve(fileURLToPath(import.meta.url), '..');
 const input_js = fs.readFileSync(`${dir}/_input.ts`);
 const content = input_js.toString();
diff --git a/tsconfig.json b/tsconfig.json
@@ -9,7 +9,5 @@
 		"moduleResolution": "bundler",
 		"lib": ["esnext", "dom"]
 	},
-	"include": [
-		"src"
-	]
+	"include": ["src"]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// @ts-check`
	`2`	`+`
`1`	`3`	`import { test } from 'vitest';`
`2`	`4`	`import { load } from './common';`
`3`	`5`	`import { print } from '../src';`