[v4.0] Expose parser (#5169)

* Expose parser as separate API * Ensure key and value of a shorthand property have different references
rollup · Oct 5, 2023 · 4e8e5b4 · 4e8e5b4
1 parent cade24f
commit 4e8e5b4
Show file tree

Hide file tree

Showing 31 changed files with 208 additions and 31 deletions.
diff --git a/browser/package.json b/browser/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rollup/browser",
-  "version": "4.0.0-24",
+  "version": "4.0.0-25",
   "description": "Next-generation ES module bundler browser build",
   "main": "dist/rollup.browser.js",
   "module": "dist/es/rollup.browser.js",

diff --git a/build-plugins/copy-types.ts b/build-plugins/copy-types.ts
@@ -33,6 +33,7 @@ export function copyNodeTypes(): Plugin[] {
 			'cli/run/loadConfigFileType.d.ts',
 			'../../src/rollup/types'
 		),
-		copyRollupType('getLogFilter.d.ts', 'src/utils/getLogFilterType.d.ts', '../rollup/types')
+		copyRollupType('getLogFilter.d.ts', 'src/utils/getLogFilterType.d.ts', '../rollup/types'),
+		copyRollupType('parseAst.d.ts', 'src/utils/parseAstType.d.ts', '../rollup/types')
 	];
 }
diff --git a/docs/javascript-api/index.md b/docs/javascript-api/index.md
@@ -336,3 +336,36 @@ export default {
 	}
 };
 ```
+
+## Accessing the parser
+
+In order to parse arbitrary code using Rollup's parser, plugins can use [`this.parse`](../plugin-development/index.md#this-parse). To use this functionality outside the context of a Rollup build, the parser is also exposed as a separate export. It has the same signature as `this.parse`:
+
+```js
+import { parseAst } from 'rollup/parseAst';
+import assert from 'node:assert';
+
+assert.deepEqual(
+	parseAst('return 42;', { allowReturnOutsideFunction: true }),
+	{
+		type: 'Program',
+		start: 0,
+		end: 10,
+		body: [
+			{
+				type: 'ReturnStatement',
+				start: 0,
+				end: 10,
+				argument: {
+					type: 'Literal',
+					start: 7,
+					end: 9,
+					raw: '42',
+					value: 42
+				}
+			}
+		],
+		sourceType: 'module'
+	}
+);
+```
diff --git a/docs/plugin-development/index.md b/docs/plugin-development/index.md
@@ -1669,7 +1669,7 @@ interface ParseOptions {
 }
 ```
 
-Use Rollup's internal SWC-based parser to parse code to an AST.
+Use Rollup's internal SWC-based parser to parse code to an [ESTree-compatible](https://github.com/estree/estree) AST.
 
 - `allowReturnOutsideFunction`: When `true` this allows return statements to be outside functions to e.g. support parsing CommonJS code.
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rollup",
-  "version": "4.0.0-24",
+  "version": "4.0.0-25",
   "description": "Next-generation ES module bundler",
   "main": "dist/rollup.js",
   "module": "dist/es/rollup.js",
@@ -214,6 +214,11 @@
       "require": "./dist/getLogFilter.js",
       "import": "./dist/es/getLogFilter.js"
     },
+    "./parseAst": {
+      "types": "./dist/parseAst.d.ts",
+      "require": "./dist/parseAst.js",
+      "import": "./dist/es/parseAst.js"
+    },
     "./dist/*": "./dist/*"
   }
 }
diff --git a/rollup.config.ts b/rollup.config.ts
@@ -66,6 +66,7 @@ export default async function (
 		input: {
 			'getLogFilter.js': 'src/utils/getLogFilter.ts',
 			'loadConfigFile.js': 'cli/run/loadConfigFile.ts',
+			'parseAst.js': 'src/utils/parseAst.ts',
 			'rollup.js': 'src/node-entry.ts'
 		},
 		onwarn,
@@ -112,6 +113,7 @@ export default async function (
 		...commonJSBuild,
 		input: {
 			'getLogFilter.js': 'src/utils/getLogFilter.ts',
+			'parseAst.js': 'src/utils/parseAst.ts',
 			'rollup.js': 'src/node-entry.ts'
 		},
 		output: {

diff --git a/src/Bundle.ts b/src/Bundle.ts
@@ -26,6 +26,7 @@ import {
 } from './utils/logs';
 import type { OutputBundleWithPlaceholders } from './utils/outputBundle';
 import { getOutputBundle, removeUnreferencedAssets } from './utils/outputBundle';
+import { parseAst } from './utils/parseAst';
 import { isAbsolute } from './utils/path';
 import { renderChunks } from './utils/renderChunks';
 import { timeEnd, timeStart } from './utils/timers';
@@ -150,7 +151,7 @@ export default class Bundle {
 			for (const file of Object.values(bundle)) {
 				if ('code' in file) {
 					try {
-						this.graph.contextParse(file.code);
+						parseAst(file.code);
 					} catch (error_: any) {
 						this.inputOptions.onLog(LOGLEVEL_WARN, logChunkInvalid(file, error_));
 					}

diff --git a/src/Graph.ts b/src/Graph.ts
@@ -1,5 +1,4 @@
 import flru from 'flru';
-import { parse } from '../native';
 import type ExternalModule from './ExternalModule';
 import Module from './Module';
 import { ModuleLoader, type UnresolvedModule } from './ModuleLoader';
@@ -18,9 +17,7 @@ import type {
 import { PluginDriver } from './utils/PluginDriver';
 import Queue from './utils/Queue';
 import { BuildPhase } from './utils/buildPhase';
-import { convertProgram, type ProgramAst } from './utils/convert-ast';
 import { analyseModuleExecution } from './utils/executionOrder';
-import getReadStringFunction from './utils/getReadStringFunction';
 import { LOGLEVEL_WARN } from './utils/logging';
 import {
 	error,
@@ -123,15 +120,6 @@ export default class Graph {
 		this.phase = BuildPhase.GENERATE;
 	}
 
-	contextParse(
-		code: string,
-		{ allowReturnOutsideFunction = false }: { allowReturnOutsideFunction?: boolean } = {}
-	): ProgramAst {
-		const astBuffer = parse(code, allowReturnOutsideFunction);
-		const readString = getReadStringFunction(astBuffer);
-		return convertProgram(astBuffer.buffer, readString);
-	}
-
 	getCache(): RollupCache {
 		// handle plugin cache eviction
 		for (const name in this.pluginCache) {

diff --git a/src/Module.ts b/src/Module.ts
@@ -63,11 +63,12 @@ import {
 	logInvalidFormatForTopLevelAwait,
 	logInvalidSourcemapForError,
 	logMissingExport,
+	logModuleParseError,
 	logNamespaceConflict,
-	logParseError,
 	logShimmedExport,
 	logSyntheticNamedExportsNeedNamespaceExport
 } from './utils/logs';
+import { parseAst } from './utils/parseAst';
 import {
 	doAttributesDiffer,
 	getAttributesFromImportExportDeclaration
@@ -1328,9 +1329,9 @@ export default class Module {
 
 	private tryParse(): ProgramAst {
 		try {
-			return this.graph.contextParse(this.info.code!);
+			return parseAst(this.info.code!) as ProgramAst;
 		} catch (error_: any) {
-			return this.error(logParseError(error_, this.id), error_.pos);
+			return this.error(logModuleParseError(error_, this.id), error_.pos);
 		}
 	}
 }

diff --git a/src/rollup/types.d.ts b/src/rollup/types.d.ts
@@ -201,6 +201,11 @@ type LoggingFunctionWithPosition = (
 	pos?: number | { column: number; line: number }
 ) => void;
 
+export type ParseAst = (
+	input: string,
+	options?: { allowReturnOutsideFunction?: boolean }
+) => AstNode;
+
 export interface PluginContext extends MinimalPluginContext {
 	addWatchFile: (id: string) => void;
 	cache: PluginCache;
@@ -215,7 +220,7 @@ export interface PluginContext extends MinimalPluginContext {
 	load: (
 		options: { id: string; resolveDependencies?: boolean } & Partial<PartialNull<ModuleOptions>>
 	) => Promise<ModuleInfo>;
-	parse: (input: string, options?: { allowReturnOutsideFunction?: boolean }) => AstNode;
+	parse: ParseAst;
 	resolve: (
 		source: string,
 		importer?: string,

diff --git a/src/utils/PluginContext.ts b/src/utils/PluginContext.ts
@@ -15,6 +15,7 @@ import { getLogHandler } from './logHandler';
 import { LOGLEVEL_DEBUG, LOGLEVEL_INFO, LOGLEVEL_WARN } from './logging';
 import { error, logInvalidRollupPhaseForAddWatchFile, logPluginError } from './logs';
 import { normalizeLog } from './options/options';
+import { parseAst } from './parseAst';
 import { ANONYMOUS_OUTPUT_PLUGIN_PREFIX, ANONYMOUS_PLUGIN_PREFIX } from './pluginUtils';
 
 export function getPluginContext(
@@ -76,7 +77,7 @@ export function getPluginContext(
 			rollupVersion,
 			watchMode: graph.watchMode
 		},
-		parse: graph.contextParse.bind(graph),
+		parse: parseAst,
 		resolve(source, importer, { attributes, custom, isEntry, skipSelf } = BLANK) {
 			skipSelf ??= true;
 			return graph.moduleLoader.resolveId(

diff --git a/src/utils/convert-ast.ts b/src/utils/convert-ast.ts
@@ -1,7 +1,7 @@
 import type * as estree from 'estree';
 import type { AstNode } from '../rollup/types';
 import { FIXED_STRINGS } from './convert-ast-strings';
-import { error } from './logs';
+import { error, logParseError } from './logs';
 
 type ReadString = (start: number, length: number) => string;
 
@@ -862,7 +862,7 @@ const nodeConverters: ((position: number, buffer: Uint32Array, readString: ReadS
 			kind,
 			method,
 			shorthand,
-			value: valuePosition ? convertNode(valuePosition, buffer, readString) : key
+			value: valuePosition ? convertNode(valuePosition, buffer, readString) : { ...key }
 		};
 	},
 	// index:55; PropertyDefinition
@@ -1156,10 +1156,7 @@ const nodeConverters: ((position: number, buffer: Uint32Array, readString: ReadS
 	(position, buffer, readString): never => {
 		const pos = buffer[position++];
 		const message = convertString(position, buffer, readString);
-		error({
-			pos,
-			message
-		});
+		error(logParseError(message, pos));
 	}
 ];
 

diff --git a/src/utils/logs.ts b/src/utils/logs.ts
@@ -809,7 +809,11 @@ export function logOptimizeChunkStatus(
 	};
 }
 
-export function logParseError(error: Error, moduleId: string): RollupLog {
+export function logParseError(message: string, pos: number): RollupLog {
+	return { code: PARSE_ERROR, message, pos };
+}
+
+export function logModuleParseError(error: Error, moduleId: string): RollupLog {
 	let message = error.message.replace(/ \(\d+:\d+\)$/, '');
 	if (moduleId.endsWith('.json')) {
 		message += ' (Note that you need @rollup/plugin-json to import JSON files)';

diff --git a/src/utils/parseAst.ts b/src/utils/parseAst.ts
@@ -0,0 +1,10 @@
+import { parse } from '../../native';
+import type { ParseAst } from '../rollup/types';
+import { convertProgram } from './convert-ast';
+import getReadStringFunction from './getReadStringFunction';
+
+export const parseAst: ParseAst = (input, { allowReturnOutsideFunction = false } = {}) => {
+	const astBuffer = parse(input, allowReturnOutsideFunction);
+	const readString = getReadStringFunction(astBuffer);
+	return convertProgram(astBuffer.buffer, readString);
+};
diff --git a/src/utils/parseAstType.d.ts b/src/utils/parseAstType.d.ts
@@ -0,0 +1,3 @@
+import type { ParseAst } from '../rollup/types';
+
+export const parseAst: ParseAst;
diff --git a/test/function/samples/double-default-export/_config.js b/test/function/samples/double-default-export/_config.js
@@ -6,6 +6,7 @@ module.exports = defineTest({
 	description: 'throws on double default exports',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'the name `default` is exported multiple times',
 			pos: 18
 		},

diff --git a/test/function/samples/double-named-export/_config.js b/test/function/samples/double-named-export/_config.js
@@ -6,6 +6,7 @@ module.exports = defineTest({
 	description: 'throws on duplicate named exports',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'the name `foo` is exported multiple times',
 			pos: 38
 		},

diff --git a/test/function/samples/double-named-reexport/_config.js b/test/function/samples/double-named-reexport/_config.js
@@ -6,6 +6,7 @@ module.exports = defineTest({
 	description: 'throws on duplicate named exports',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'the name `foo` is exported multiple times',
 			pos: 38
 		},

diff --git a/test/function/samples/duplicate-import-fails/_config.js b/test/function/samples/duplicate-import-fails/_config.js
@@ -5,6 +5,7 @@ module.exports = defineTest({
 	description: 'disallows duplicate imports',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'the name `a` is defined multiple times',
 			pos: 36
 		},

diff --git a/test/function/samples/duplicate-import-specifier-fails/_config.js b/test/function/samples/duplicate-import-specifier-fails/_config.js
@@ -5,6 +5,7 @@ module.exports = defineTest({
 	description: 'disallows duplicate import specifiers',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'the name `a` is defined multiple times',
 			pos: 12
 		},

diff --git a/test/function/samples/error-parse-json/_config.js b/test/function/samples/error-parse-json/_config.js
@@ -7,6 +7,7 @@ module.exports = defineTest({
 		'throws with an extended error message when failing to parse a file with ".json" extension',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			pos: 10,
 			message: "Expected ';', '}' or <eof>"
 		},

diff --git a/test/function/samples/error-parse-unknown-extension/_config.js b/test/function/samples/error-parse-unknown-extension/_config.js
@@ -7,6 +7,7 @@ module.exports = defineTest({
 		'throws with an extended error message when failing to parse a file without .(m)js extension',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			pos: 0,
 			message: 'Expression expected'
 		},

diff --git a/test/function/samples/export-not-at-top-level-fails/_config.js b/test/function/samples/export-not-at-top-level-fails/_config.js
@@ -5,6 +5,7 @@ module.exports = defineTest({
 	description: 'disallows non-top-level exports',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			pos: 19,
 			message: "'import', and 'export' cannot be used outside of module code"
 		},

diff --git a/test/function/samples/import-not-at-top-level-fails/_config.js b/test/function/samples/import-not-at-top-level-fails/_config.js
@@ -5,6 +5,7 @@ module.exports = defineTest({
 	description: 'disallows non-top-level imports',
 	error: {
 		cause: {
+			code: 'PARSE_ERROR',
 			pos: 19,
 			message: "'import', and 'export' cannot be used outside of module code"
 		},

diff --git a/test/function/samples/parse-return-outside-function/_config.js b/test/function/samples/parse-return-outside-function/_config.js
@@ -36,6 +36,7 @@ module.exports = defineTest({
 						expectedError = error;
 					}
 					compareError(expectedError, {
+						code: 'PARSE_ERROR',
 						message: 'Return statement is not allowed here',
 						pos: 0
 					});
@@ -46,6 +47,7 @@ module.exports = defineTest({
 						expectedError = error;
 					}
 					compareError(expectedError, {
+						code: 'PARSE_ERROR',
 						message: 'Return statement is not allowed here',
 						pos: 0
 					});

diff --git a/test/function/samples/reassign-import-fails/_config.js b/test/function/samples/reassign-import-fails/_config.js
@@ -6,6 +6,7 @@ module.exports = defineTest({
 	error: {
 		code: 'PARSE_ERROR',
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'cannot reassign to an imported binding',
 			pos: 113
 		},

diff --git a/test/function/samples/reassign-import-not-at-top-level-fails/_config.js b/test/function/samples/reassign-import-not-at-top-level-fails/_config.js
@@ -6,6 +6,7 @@ module.exports = defineTest({
 	error: {
 		code: 'PARSE_ERROR',
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'cannot reassign to an imported binding',
 			pos: 95
 		},

diff --git a/test/function/samples/update-expression-of-import-fails/_config.js b/test/function/samples/update-expression-of-import-fails/_config.js
@@ -6,6 +6,7 @@ module.exports = defineTest({
 	error: {
 		code: 'PARSE_ERROR',
 		cause: {
+			code: 'PARSE_ERROR',
 			message: 'cannot reassign to an imported binding',
 			pos: 28
 		},