chore: tweak the comment about files should not be edited (#5463)

rollup · Apr 10, 2024 · 8c31e9b · 8c31e9b
1 parent b957e1d
commit 8c31e9b
Show file tree

Hide file tree

Showing 12 changed files with 39 additions and 28 deletions.
diff --git a/rust/parse_ast/src/convert_ast/converter/ast_constants.rs b/rust/parse_ast/src/convert_ast/converter/ast_constants.rs
@@ -1,4 +1,4 @@
-// This file is generated by scripts/generate-ast-converters.js.
+// This file is generated by scripts/generate-rust-constants.js.
 // Do not edit this file directly.
 
 pub const TYPE_PANIC_ERROR: [u8; 4] = 0u32.to_ne_bytes();

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,5 +1,6 @@
-// This file is generated by scripts/generate-string-constant.js.
+// This file is generated by scripts/generate-string-constants.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

diff --git a/scripts/generate-buffer-parsers.js b/scripts/generate-buffer-parsers.js
@@ -1,6 +1,8 @@
 import { writeFile } from 'node:fs/promises';
 import { astNodeNamesWithFieldOrder } from './ast-types.js';
-import { firstLetterLowercase, lintTsFile } from './helpers.js';
+import { firstLetterLowercase, generateNotEditFilesComment, lintTsFile } from './helpers.js';
+
+const notEditFilesComment = generateNotEditFilesComment(import.meta.url);
 
 const bufferParsersFile = new URL('../src/ast/bufferParsers.ts', import.meta.url);
 
@@ -168,9 +170,7 @@ function getFieldDefinition([fieldName, fieldType], node, originalNode, offset)
 	}
 }
 
-const bufferParsers = `// This file is generated by scripts/generate-ast-converters.js.
-// Do not edit this file directly.
-
+const bufferParsers = `${notEditFilesComment}
 import type * as estree from 'estree';
 import type { AstContext } from '../Module';
 import { convertAnnotations, convertString } from '../utils/astConverterHelpers';

diff --git a/scripts/generate-buffer-to-ast.js b/scripts/generate-buffer-to-ast.js
@@ -1,6 +1,8 @@
 import { writeFile } from 'node:fs/promises';
 import { astNodeNamesWithFieldOrder } from './ast-types.js';
-import { firstLetterLowercase, lintTsFile } from './helpers.js';
+import { firstLetterLowercase, generateNotEditFilesComment, lintTsFile } from './helpers.js';
+
+const notEditFilesComment = generateNotEditFilesComment(import.meta.url);
 
 const bufferToJsAstFile = new URL('../src/utils/bufferToAst.ts', import.meta.url);
 
@@ -156,9 +158,7 @@ const types = astNodeNamesWithFieldOrder.map(({ name, node }) => {
 	return typeDefinition;
 });
 
-const bufferToJsAst = `// This file is generated by scripts/generate-ast-converters.js.
-// Do not edit this file directly.
-
+const bufferToJsAst = `${notEditFilesComment}
 import type * as estree from 'estree';
 import { PanicError, ParseError } from '../ast/nodes/NodeType';import type { RollupAstNode } from '../rollup/types';
 import type { RollupAnnotation } from './astConverterHelpers';

diff --git a/scripts/generate-child-node-keys.js b/scripts/generate-child-node-keys.js
@@ -1,6 +1,8 @@
 import { writeFile } from 'node:fs/promises';
 import { AST_NODES } from './ast-types.js';
-import { lintTsFile } from './helpers.js';
+import { generateNotEditFilesComment, lintTsFile } from './helpers.js';
+
+const notEditFilesComment = generateNotEditFilesComment(import.meta.url);
 
 const childNodeKeysFile = new URL('../src/ast/childNodeKeys.ts', import.meta.url);
 
@@ -18,9 +20,7 @@ for (const [name, node] of Object.entries(AST_NODES)) {
 	}
 }
 
-const childNodeKeys = `// This file is generated by scripts/generate-ast-converters.js.
-// Do not edit this file directly.
-
+const childNodeKeys = `${notEditFilesComment}
 export const childNodeKeys: Record<string, string[]> = {
   ${Object.entries(childNodeKeysByAstType)
 		.sort(([astType1], [astType2]) => astType1.localeCompare(astType2))

diff --git a/scripts/generate-rust-constants.js b/scripts/generate-rust-constants.js
@@ -1,9 +1,11 @@
 import { writeFile } from 'node:fs/promises';
 import { AST_NODES, astNodeNamesWithFieldOrder } from './ast-types.js';
-import { lintRustFile, toScreamingSnakeCase } from './helpers.js';
+import { generateNotEditFilesComment, lintRustFile, toScreamingSnakeCase } from './helpers.js';
 
 const BYTES_PER_U32 = 4;
 
+const notEditFilesComment = generateNotEditFilesComment(import.meta.url);
+
 const astConstantsFile = new URL(
 	'../rust/parse_ast/src/convert_ast/converter/ast_constants.rs',
 	import.meta.url
@@ -67,9 +69,7 @@ const reservedBytesAndOffsets = astNodeNamesWithFieldOrder
 	})
 	.join('\n');
 
-const astConstants = `// This file is generated by scripts/generate-ast-converters.js.
-// Do not edit this file directly.
-
+const astConstants = `${notEditFilesComment}
 ${nodeTypes}
 
 ${reservedBytesAndOffsets}

diff --git a/scripts/generate-string-constants.js b/scripts/generate-string-constants.js
@@ -1,5 +1,7 @@
 import { writeFile } from 'node:fs/promises';
-import { lintRustFile, lintTsFile } from './helpers.js';
+import { generateNotEditFilesComment, lintRustFile, lintTsFile } from './helpers.js';
+
+const notEditFilesComment = generateNotEditFilesComment(import.meta.url);
 
 const targetRustFile = new URL(
 	'../rust/parse_ast/src/convert_ast/converter/string_constants.rs',
@@ -73,11 +75,8 @@ const stringConstantsTemplate = [
 	['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 +
+	notEditFilesComment +
 	stringConstantsTemplate
 		.map(
 			([variableName, value], index) =>
@@ -86,7 +85,7 @@ const rustCode =
 		.join('\n');
 
 const tsCode =
-	tipComment +
+	notEditFilesComment +
 	`export default ` +
 	JSON.stringify(
 		stringConstantsTemplate.map(([, value]) => value),

diff --git a/scripts/helpers.js b/scripts/helpers.js
@@ -1,5 +1,6 @@
 import { spawn } from 'node:child_process';
 import { readFile } from 'node:fs/promises';
+import { relative } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { ESLint } from 'eslint';
 import { blue, bold, cyan, green, magenta, red, yellow } from './colors.js';
@@ -112,3 +113,12 @@ export function firstLetterLowercase(string) {
 export function toScreamingSnakeCase(string) {
 	return string.replace(/(?<!^)([A-Z])/g, '_$1').toUpperCase();
 }
+
+/**
+ * @param {string} filePath
+ * @returns {string}
+ */
+export function generateNotEditFilesComment(filePath) {
+	return `// This file is generated by ${relative(process.cwd(), fileURLToPath(filePath))}.
+	// Do not edit this file directly.\n\n`;
+}
diff --git a/src/ast/bufferParsers.ts b/src/ast/bufferParsers.ts
@@ -1,4 +1,4 @@
-// This file is generated by scripts/generate-ast-converters.js.
+// This file is generated by scripts/generate-buffer-parsers.js.
 // Do not edit this file directly.
 
 import type * as estree from 'estree';

diff --git a/src/ast/childNodeKeys.ts b/src/ast/childNodeKeys.ts
@@ -1,4 +1,4 @@
-// This file is generated by scripts/generate-ast-converters.js.
+// This file is generated by scripts/generate-child-node-keys.js.
 // Do not edit this file directly.
 
 export const childNodeKeys: Record<string, string[]> = {

diff --git a/src/utils/bufferToAst.ts b/src/utils/bufferToAst.ts
@@ -1,4 +1,4 @@
-// This file is generated by scripts/generate-ast-converters.js.
+// This file is generated by scripts/generate-buffer-to-ast.js.
 // Do not edit this file directly.
 
 import type * as estree from 'estree';

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