make language required

Author: Rich-Harris

src/index.js

@@ -1,7 +1,6 @@
-/** @import { BaseNode, Command, Visitors, PrintOptions, Location, Margin, Newline, Indent, Dedent } from './types' */
+/** @import { BaseNode, Command, Visitors, PrintOptions } from './types' */
 import { encode } from '@jridgewell/sourcemap-codec';
 import { Context, dedent, indent, margin, newline } from './context.js';
-import ts from './languages/ts.js';
 
 /** @type {(str: string) => string} str */
 let btoa = () => {
@@ -17,19 +16,21 @@ if (typeof window !== 'undefined' && typeof window.btoa === 'function') {
 }
 
 /**
- * @template {BaseNode} T
+ * @template {BaseNode} [T=BaseNode]
  * @param {{ type: string, [key: string]: any }} node
- * @param {PrintOptions<T>} opts
+ * @param {Visitors<T>} visitors
+ * @param {PrintOptions} opts
  * @returns {{ code: string, map: any }} // TODO
  */
-export function print(node, opts = {}) {
+export function print(node, visitors, opts = {}) {
 	if (Array.isArray(node)) {
 		return print(
 			{
 				type: 'Program',
 				body: node,
 				sourceType: 'module'
 			},
+			visitors,
 			opts
 		);
 	}
@@ -38,7 +39,7 @@ export function print(node, opts = {}) {
 	const commands = [];
 
 	// @ts-expect-error some nonsense I don't understand
-	const context = new Context(opts.visitors ?? ts({ quotes: opts.quotes }), commands);
+	const context = new Context(visitors, commands);
 
 	context.visit(node);
 

src/types.d.ts

@@ -1,7 +1,7 @@
 import { TSESTree } from '@typescript-eslint/types';
 import type { Context } from './context.js';
 
-type BaseNode = { type: string };
+export type BaseNode = { type: string };
 
 type NodeOf<T extends string, X> = X extends { type: T } ? X : never;
 
@@ -64,11 +64,9 @@ export interface IndentChange {
 
 export type Command = string | Location | Margin | Newline | Indent | Dedent | Command[];
 
-export interface PrintOptions<T extends BaseNode = BaseNode> {
+export interface PrintOptions {
 	sourceMapSource?: string;
 	sourceMapContent?: string;
 	sourceMapEncodeMappings?: boolean; // default true
 	indent?: string; // default tab
-	quotes?: 'single' | 'double'; // default single
-	visitors?: Visitors<T>; // default to ts
 }

test/esrap.test.js

@@ -72,7 +72,7 @@ for (const dir of fs.readdirSync(`${__dirname}/samples`)) {
 		/** @type {TSESTree.Comment[]} */
 		let comments;
 
-		/** @type {PrintOptions<TSESTree.Node>} */
+		/** @type {PrintOptions} */
 		let opts;
 
 		if (input_json.length > 0) {
@@ -88,9 +88,7 @@ for (const dir of fs.readdirSync(`${__dirname}/samples`)) {
 			};
 		}
 
-		opts.visitors = tsx({ comments });
-
-		const { code, map } = print(ast, opts);
+		const { code, map } = print(ast, tsx({ comments }), opts);
 
 		fs.writeFileSync(`${__dirname}/samples/${dir}/_actual.${fileExtension}`, code);
 		fs.writeFileSync(

test/indent.test.js

@@ -4,12 +4,13 @@ import { test } from 'vitest';
 import { load } from './common';
 import { print } from '../src';
 import { expect } from 'vitest';
+import ts from '../src/languages/ts.js';
 
 const test_code = "const foo = () => { const bar = 'baz' }";
 
 test('default indent type is tab', () => {
 	const { ast } = load(test_code);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`
 		"const foo = () => {
@@ -20,7 +21,7 @@ test('default indent type is tab', () => {
 
 test('two space indent', () => {
 	const { ast } = load(test_code);
-	const code = print(ast, { indent: '  ' }).code;
+	const code = print(ast, ts(), { indent: '  ' }).code;
 
 	expect(code).toMatchInlineSnapshot(`
 		"const foo = () => {
@@ -31,7 +32,7 @@ test('two space indent', () => {
 
 test('four space indent', () => {
 	const { ast } = load(test_code);
-	const code = print(ast, { indent: '    ' }).code;
+	const code = print(ast, ts(), { indent: '    ' }).code;
 
 	expect(code).toMatchInlineSnapshot(`
 		"const foo = () => {

test/pluggability.test.js

@@ -3,26 +3,21 @@ import { print } from '../src';
 
 /** @import { Visitors } from '../types' */
 test('custom printers work', () => {
-	/** @type {Visitors} */
-	const funkyStringPrinter = {
-		CustomType(node, state) {
-			if (typeof node.value === 'string') {
-				state.write(`:) - `);
-
-				state.write(node.value);
-
-				state.write(` - (:`);
-			}
-		}
-	};
-
 	const { code } = print(
 		{
 			type: 'CustomType',
 			value: 'testing 123'
 		},
 		{
-			visitors: { ...funkyStringPrinter }
+			CustomType(node, context) {
+				if (typeof node.value === 'string') {
+					context.write(`:) - `);
+
+					context.write(node.value);
+
+					context.write(` - (:`);
+				}
+			}
 		}
 	);
 

test/quotes.test.js

@@ -5,6 +5,7 @@ import { print } from '../src/index.js';
 import { expect } from 'vitest';
 import { load } from './common.js';
 import { walk } from 'zimmerframe';
+import ts from '../src/languages/ts.js';
 
 /** @import { TSESTree } from '@typescript-eslint/types' */
 
@@ -29,95 +30,95 @@ const test_code = "const foo = 'bar'";
 test('default quote type is single', () => {
 	const { ast } = load(test_code);
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"const foo = 'bar';"`);
 });
 
 test('single quotes used when single quote type provided', () => {
 	const { ast } = load(test_code);
 	clean(ast);
-	const code = print(ast, { quotes: 'single' }).code;
+	const code = print(ast, ts({ quotes: 'single' })).code;
 
 	expect(code).toMatchInlineSnapshot(`"const foo = 'bar';"`);
 });
 
 test('double quotes used when double quote type provided', () => {
 	const { ast } = load(test_code);
 	clean(ast);
-	const code = print(ast, { quotes: 'double' }).code;
+	const code = print(ast, ts({ quotes: 'double' })).code;
 
 	expect(code).toMatchInlineSnapshot(`"const foo = "bar";"`);
 });
 
 test('escape single quotes if present in string literal', () => {
 	const { ast } = load('const foo = "b\'ar"');
 	clean(ast);
-	const code = print(ast, { quotes: 'single' }).code;
+	const code = print(ast, ts({ quotes: 'single' })).code;
 
 	expect(code).toMatchInlineSnapshot(`"const foo = 'b\\'ar';"`);
 });
 
 test('escape double quotes if present in string literal', () => {
 	const { ast } = load("const foo = 'b\"ar'");
 	clean(ast);
-	const code = print(ast, { quotes: 'double' }).code;
+	const code = print(ast, ts({ quotes: 'double' })).code;
 
 	expect(code).toMatchInlineSnapshot(`"const foo = "b\\"ar";"`);
 });
 
 test('escapes new lines', () => {
 	const { ast } = load('const str = "a\\nb"');
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"const str = 'a\\nb';"`);
 });
 
 test('escapes escape characters', () => {
 	const { ast } = load('const str = "a\\\\nb"');
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"const str = 'a\\\\nb';"`);
 });
 
 test('escapes escape characters#2', () => {
 	const { ast } = load('const str = "a\\\\\\nb"');
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"const str = 'a\\\\\\nb';"`);
 });
 
 test('escapes double escaped backslashes', () => {
 	const { ast } = load("var text = $.text('\\\\\\\\');");
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"var text = $.text('\\\\\\\\');"`);
 });
 
 test('does not escape already-escaped single quotes', () => {
 	const { ast } = load(`const str = 'a\\'b'`);
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"const str = 'a\\'b';"`);
 });
 
 test('does not escape already-escaped double quotes', () => {
 	const { ast } = load('const str = "a\\"b"');
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"const str = 'a"b';"`);
 });
 
 test('correctly handle \\n\\r', () => {
 	const { ast } = load('const str = "a\\n\\rb"');
 	clean(ast);
-	const code = print(ast).code;
+	const code = print(ast, ts()).code;
 
 	expect(code).toMatchInlineSnapshot(`"const str = 'a\\n\\rb';"`);
 });

test/sandbox/index.js

@@ -10,7 +10,5 @@ const dir = path.resolve(fileURLToPath(import.meta.url), '..');
 const input_js = fs.readFileSync(`${dir}/_input.ts`);
 const content = input_js.toString();
 const { ast, comments } = load(content);
-const { code } = print(ast, {
-	visitors: ts({ comments })
-});
+const { code } = print(ast, ts({ comments }));
 fs.writeFileSync(`${dir}/_output.ts`, code);