chore: generate string constants from config (#5451)

rollup · Apr 4, 2024 · 459bfe1 · 459bfe1
1 parent 5abe71b
commit 459bfe1
Show file tree

Hide file tree

Showing 12 changed files with 130 additions and 18 deletions.
diff --git a/rust/parse_ast/src/convert_ast/converter/string_constants.rs b/rust/parse_ast/src/convert_ast/converter/string_constants.rs
@@ -1,4 +1,5 @@
-// These need to correspond to the positions in convert-ast-strings.ts
+// This file is generated by scripts/generate-string-constant.js.
+// Do not edit this file directly.
 pub const STRING_VAR: [u8; 4] = 0u32.to_ne_bytes(); // var
 pub const STRING_LET: [u8; 4] = 1u32.to_ne_bytes(); // let
 pub const STRING_CONST: [u8; 4] = 2u32.to_ne_bytes(); // const
@@ -49,7 +50,7 @@ pub const STRING_DIVASSIGN: [u8; 4] = 46u32.to_ne_bytes(); // /=
 pub const STRING_MODASSIGN: [u8; 4] = 47u32.to_ne_bytes(); // %=
 pub const STRING_LSHIFTASSIGN: [u8; 4] = 48u32.to_ne_bytes(); // <<=
 pub const STRING_RSHIFTASSIGN: [u8; 4] = 49u32.to_ne_bytes(); // >>=
-pub const STRING_ZEROFILLRSHIFTASSIGN: [u8; 4] = 50u32.to_ne_bytes(); // ">>>=
+pub const STRING_ZEROFILLRSHIFTASSIGN: [u8; 4] = 50u32.to_ne_bytes(); // >>>=
 pub const STRING_BITORASSIGN: [u8; 4] = 51u32.to_ne_bytes(); // |=
 pub const STRING_BITXORASSIGN: [u8; 4] = 52u32.to_ne_bytes(); // ^=
 pub const STRING_BITANDASSIGN: [u8; 4] = 53u32.to_ne_bytes(); // &=

diff --git a/scripts/generate-ast-converters.js b/scripts/generate-ast-converters.js
@@ -4,3 +4,4 @@ import './generate-rust-constants.js';
 import './generate-buffer-to-ast.js';
 import './generate-child-node-keys.js';
 import './generate-buffer-parsers.js';
+import './generate-string-constants.js';
diff --git a/scripts/generate-buffer-parsers.js b/scripts/generate-buffer-parsers.js
@@ -1,7 +1,7 @@
 import { writeFile } from 'node:fs/promises';
 import { AST_NODES, astNodeNamesWithFieldOrder } from './ast-types.js';
 import { getNode } from './generate-buffer-to-ast.js';
-import { firstLetterLowercase, lintFile } from './helpers.js';
+import { firstLetterLowercase, lintTsFile } from './helpers.js';
 
 const bufferParsersFile = new URL('../src/ast/bufferParsers.ts', import.meta.url);
 
@@ -187,7 +187,7 @@ import type * as estree from 'estree';
 import type { AstContext } from '../Module';
 import { convertAnnotations, convertString } from '../utils/astConverterHelpers';
 import { convertNode as convertJsonNode } from '../utils/bufferToAst';
-import { FIXED_STRINGS } from '../utils/convert-ast-strings';
+import FIXED_STRINGS from '../utils/convert-ast-strings';
 import type { ReadString } from '../utils/getReadStringFunction';
 import getReadStringFunction from '../utils/getReadStringFunction';
 ${nodeTypeImports.join('\n')}
@@ -253,4 +253,4 @@ function convertNodeList(parent: Node | { context: AstContext; type: string }, p
 `;
 
 await writeFile(bufferParsersFile, bufferParsers);
-await lintFile(bufferParsersFile);
+await lintTsFile(bufferParsersFile);
diff --git a/scripts/generate-buffer-to-ast.js b/scripts/generate-buffer-to-ast.js
@@ -1,6 +1,6 @@
 import { writeFile } from 'node:fs/promises';
 import { AST_NODES, astNodeNamesWithFieldOrder } from './ast-types.js';
-import { firstLetterLowercase, lintFile } from './helpers.js';
+import { firstLetterLowercase, lintTsFile } from './helpers.js';
 
 const bufferToJsAstFile = new URL('../src/utils/bufferToAst.ts', import.meta.url);
 
@@ -190,7 +190,7 @@ import {
   convertString,
   INVALID_ANNOTATION_KEY
 } from './astConverterHelpers';
-import { FIXED_STRINGS } from './convert-ast-strings';
+import FIXED_STRINGS from './convert-ast-strings';
 import type { ReadString } from './getReadStringFunction';
 import { error, getRollupError, logParseError } from './logs';
 
@@ -239,4 +239,4 @@ function convertNodeList(position: number, buffer: Uint32Array, readString: Read
 `;
 
 await writeFile(bufferToJsAstFile, bufferToJsAst);
-await lintFile(bufferToJsAstFile);
+await lintTsFile(bufferToJsAstFile);
diff --git a/scripts/generate-child-node-keys.js b/scripts/generate-child-node-keys.js
@@ -1,6 +1,6 @@
 import { writeFile } from 'node:fs/promises';
 import { AST_NODES } from './ast-types.js';
-import { lintFile } from './helpers.js';
+import { lintTsFile } from './helpers.js';
 
 const childNodeKeysFile = new URL('../src/ast/childNodeKeys.ts', import.meta.url);
 
@@ -30,4 +30,4 @@ export const childNodeKeys: Record<string, string[]> = {
 `;
 
 await writeFile(childNodeKeysFile, childNodeKeys);
-await lintFile(childNodeKeysFile);
+await lintTsFile(childNodeKeysFile);
diff --git a/scripts/generate-rust-constants.js b/scripts/generate-rust-constants.js
@@ -1,7 +1,6 @@
 import { writeFile } from 'node:fs/promises';
-import { fileURLToPath } from 'node:url';
 import { AST_NODES, astNodeNamesWithFieldOrder } from './ast-types.js';
-import { runWithEcho, toScreamingSnakeCase } from './helpers.js';
+import { lintRustFile, toScreamingSnakeCase } from './helpers.js';
 
 const BYTES_PER_U32 = 4;
 
@@ -79,4 +78,4 @@ ${reservedBytesAndOffsets}
 `;
 
 await writeFile(astConstantsFile, astConstants);
-await runWithEcho('rustfmt', [fileURLToPath(astConstantsFile)]);
+await lintRustFile(astConstantsFile);
diff --git a/scripts/generate-string-constants.js b/scripts/generate-string-constants.js
@@ -0,0 +1,101 @@
+import { writeFile } from 'node:fs/promises';
+import { lintRustFile, lintTsFile } from './helpers.js';
+
+const targetRustFile = new URL(
+	'../rust/parse_ast/src/convert_ast/converter/string_constants.rs',
+	import.meta.url
+);
+const targetTsFile = new URL('../src/utils/convert-ast-strings.ts', import.meta.url);
+
+const stringConstantsTemplate = [
+	['STRING_VAR', 'var'],
+	['STRING_LET', 'let'],
+	['STRING_CONST', 'const'],
+	['STRING_INIT', 'init'],
+	['STRING_GET', 'get'],
+	['STRING_SET', 'set'],
+	['STRING_CONSTRUCTOR', 'constructor'],
+	['STRING_METHOD', 'method'],
+	['STRING_MINUS', '-'],
+	['STRING_PLUS', '+'],
+	['STRING_BANG', '!'],
+	['STRING_TILDE', '~'],
+	['STRING_TYPEOF', 'typeof'],
+	['STRING_VOID', 'void'],
+	['STRING_DELETE', 'delete'],
+	['STRING_PLUSPLUS', '++'],
+	['STRING_MINUSMINUS', '--'],
+	['STRING_EQEQ', '=='],
+	['STRING_NOTEQ', '!='],
+	['STRING_EQEQEQ', '==='],
+	['STRING_NOTEQEQ', '!=='],
+	['STRING_LT', '<'],
+	['STRING_LTEQ', '<='],
+	['STRING_GT', '>'],
+	['STRING_GTEQ', '>='],
+	['STRING_LSHIFT', '<<'],
+	['STRING_RSHIFT', '>>'],
+	['STRING_ZEROFILLRSHIFT', '>>>'],
+	['STRING_ADD', '+'],
+	['STRING_SUB', '-'],
+	['STRING_MUL', '*'],
+	['STRING_DIV', '/'],
+	['STRING_MOD', '%'],
+	['STRING_BITOR', '|'],
+	['STRING_BITXOR', '^'],
+	['STRING_BITAND', '&'],
+	['STRING_LOGICALOR', '||'],
+	['STRING_LOGICALAND', '&&'],
+	['STRING_IN', 'in'],
+	['STRING_INSTANCEOF', 'instanceof'],
+	['STRING_EXP', '**'],
+	['STRING_NULLISHCOALESCING', '??'],
+	['STRING_ASSIGN', '='],
+	['STRING_ADDASSIGN', '+='],
+	['STRING_SUBASSIGN', '-='],
+	['STRING_MULASSIGN', '*='],
+	['STRING_DIVASSIGN', '/='],
+	['STRING_MODASSIGN', '%='],
+	['STRING_LSHIFTASSIGN', '<<='],
+	['STRING_RSHIFTASSIGN', '>>='],
+	['STRING_ZEROFILLRSHIFTASSIGN', '>>>='],
+	['STRING_BITORASSIGN', '|='],
+	['STRING_BITXORASSIGN', '^='],
+	['STRING_BITANDASSIGN', '&='],
+	['STRING_EXPASSIGN', '**='],
+	['STRING_ANDASSIGN', '&&='],
+	['STRING_ORASSIGN', '||='],
+	['STRING_NULLISHASSIGN', '??='],
+	['STRING_PURE', 'pure'],
+	['STRING_NOSIDEEFFECTS', 'noSideEffects'],
+	['STRING_SOURCEMAP', 'sourcemap'],
+	['STRING_USING', 'using'],
+	['STRING_AWAIT_USING', 'await using']
+];
+
+const tipComment = `// This file is generated by scripts/generate-string-constant.js.
+// Do not edit this file directly.\n`;
+
+const rustCode =
+	tipComment +
+	stringConstantsTemplate
+		.map(
+			([variableName, value], index) =>
+				`pub const ${variableName}: [u8; 4] = ${index}u32.to_ne_bytes(); // ${value}`
+		)
+		.join('\n');
+
+const tsCode =
+	tipComment +
+	`export default ` +
+	JSON.stringify(
+		stringConstantsTemplate.map(([, value]) => value),
+		undefined,
+		2
+	) +
+	`;\n`;
+
+await Promise.all([
+	writeFile(targetTsFile, tsCode).then(() => lintTsFile(targetTsFile)),
+	writeFile(targetRustFile, rustCode).then(() => lintRustFile(targetRustFile))
+]);
diff --git a/scripts/helpers.js b/scripts/helpers.js
@@ -80,7 +80,7 @@ export async function readJson(file) {
  * @param {URL} file
  * @return {Promise<void>}
  */
-export async function lintFile(file) {
+export async function lintTsFile(file) {
 	const eslint = new ESLint({ fix: true });
 	const results = await eslint.lintFiles([fileURLToPath(file)]);
 	await ESLint.outputFixes(results);
@@ -89,6 +89,14 @@ export async function lintFile(file) {
 	console.log(resultText);
 }
 
+/**
+ * @param {URL} file
+ * @return {Promise<void>}
+ */
+export function lintRustFile(file) {
+	return runWithEcho('rustfmt', [fileURLToPath(file)]);
+}
+
 /**
  * @param {string} string
  * @returns {string}

diff --git a/src/ast/bufferParsers.ts b/src/ast/bufferParsers.ts
@@ -5,7 +5,7 @@ import type * as estree from 'estree';
 import type { AstContext } from '../Module';
 import { convertAnnotations, convertString } from '../utils/astConverterHelpers';
 import { convertNode as convertJsonNode } from '../utils/bufferToAst';
-import { FIXED_STRINGS } from '../utils/convert-ast-strings';
+import FIXED_STRINGS from '../utils/convert-ast-strings';
 import type { ReadString } from '../utils/getReadStringFunction';
 import getReadStringFunction from '../utils/getReadStringFunction';
 import ArrayExpression from './nodes/ArrayExpression';

diff --git a/src/utils/astConverterHelpers.ts b/src/utils/astConverterHelpers.ts
@@ -1,4 +1,4 @@
-import { FIXED_STRINGS } from './convert-ast-strings';
+import FIXED_STRINGS from './convert-ast-strings';
 import type { ReadString } from './getReadStringFunction';
 
 export const ANNOTATION_KEY = '_rollupAnnotations';

diff --git a/src/utils/bufferToAst.ts b/src/utils/bufferToAst.ts
@@ -11,7 +11,7 @@ import {
 	convertString,
 	INVALID_ANNOTATION_KEY
 } from './astConverterHelpers';
-import { FIXED_STRINGS } from './convert-ast-strings';
+import FIXED_STRINGS from './convert-ast-strings';
 import type { ReadString } from './getReadStringFunction';
 import { error, getRollupError, logParseError } from './logs';
 

diff --git a/src/utils/convert-ast-strings.ts b/src/utils/convert-ast-strings.ts
@@ -1,4 +1,6 @@
-export const FIXED_STRINGS = [
+// This file is generated by scripts/generate-string-constant.js.
+// Do not edit this file directly.
+export default [
 	'var',
 	'let',
 	'const',