build: 增加 jsdoc 描述來表示這是自動生成出來的列表，防止誤編輯，並且提示原始來源

Author: bluelovers

packages/@lazy-cjk/jp-table-comparison/test/script/build-cache.ts

@@ -13,6 +13,7 @@ import { IPLUS_TABLE, ITeachKanjiComparison, IKanjiComparisonTable } from '../..
 import { array_unique_overwrite, array_unique } from 'array-hyper-unique';
 import { sortBySlugify } from '@lazy-cjk/sort';
 import { compareCaseInsensitive } from '@bluelovers/string-natural-compare/core';
+import { lineSplit } from 'crlf-normalize';
 
 const data = _jpTableCmparisonBuild({
 	PLUS_TABLE,
@@ -34,7 +35,10 @@ const data = _jpTableCmparisonBuild({
 	sortTable(data.TABLE);
 	sortTable(data.TABLE_SAFE);
 
+	lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison/lib/table/core.ts;\nDO NOT EDIT.\n@see {@link ./table/core.ts}`));
 	lines.push(`export const TABLE: IKanjiComparisonTable = [\n${printTable(data.TABLE).join('\n')}\n];`);
+
+	lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison/lib/table/core.ts;\nDO NOT EDIT.\n@see {@link ./table/core.ts}`));
 	lines.push(`export const TABLE_SAFE: IKanjiComparisonTable = [\n${printTable(data.TABLE_SAFE).join('\n')}\n];`);
 
 	lines.push(``);
@@ -58,7 +62,10 @@ const data = _jpTableCmparisonBuild({
 	sortTablePlus(data.PLUS_TABLE);
 	sortTablePlus(data.PLUS_TABLE_SAFE);
 
+	lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison/lib/table/core.ts;\nDO NOT EDIT.\n@see {@link ./table/core.ts}`));
 	lines.push(`export const PLUS_TABLE: IPLUS_TABLE = [\n${printTable(data.PLUS_TABLE).join('\n')}\n];`);
+
+	lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison/lib/table/core.ts;\nDO NOT EDIT.\n@see {@link ./table/core.ts}`));
 	lines.push(`export const PLUS_TABLE_SAFE: IPLUS_TABLE = [\n${printTable(data.PLUS_TABLE_SAFE).join('\n')}\n];`);
 
 	lines.push(``);
@@ -89,8 +96,10 @@ const data = _jpTableCmparisonBuild({
 
 		let re = new RegExp(`[${keys.join('')}]`, 'u');
 
+		lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison/lib/table/core.ts;\nDO NOT EDIT.\n@see {@link ./table/core.ts}`));
 		lines.push(`export const _re_table_keys = ${re.toString()};`);
 
+		lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison/lib/table/core.ts;\nDO NOT EDIT.\n@see {@link ./table/core.ts}`));
 		lines.push(`export  default _re_table_keys`);
 
 		lines.push(``);
@@ -109,6 +118,7 @@ const data = _jpTableCmparisonBuild({
 
 		lines.push(``);
 
+		lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison/lib/table/core.ts;\nDO NOT EDIT.\n@see {@link ./table/core.ts}`));
 		lines.push(`export const _table_keys = [\n${printTable(keys).join('\n')}\n];`);
 
 		lines.push(`export  default _table_keys`);
@@ -194,3 +204,11 @@ function sortTablePlus(table: IPLUS_TABLE)
 		return comp(s1[0], s2[0])
 	})
 }
+
+function printJSDOC(msg: string)
+{
+	const c = '\n * ';
+
+	return `/**${c}${lineSplit(msg).join(c)}${c}/`
+		.replace(/\*\s+\/$/, '*/');
+}

packages/@lazy-cjk/jp-table-convert/test/script/build-cache.ts

@@ -8,6 +8,7 @@ import assert from 'assert';
 import emitTsFiles from 'build-ts-file';
 import { _build_table } from '../../lib/core';
 import { ZHJP_TABLE, ZHJP_TABLE_SAFE } from '@lazy-cjk/jp-table-comparison';
+import { crlf, lineSplit } from 'crlf-normalize';
 
 const data = _build_table(ZHJP_TABLE, ZHJP_TABLE_SAFE);
 
@@ -19,9 +20,13 @@ const data = _build_table(ZHJP_TABLE, ZHJP_TABLE_SAFE);
 
 	lines.push(`import { ITABLE_MAIN } from './types';`);
 
+	lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison;\nDO NOT EDIT.\n@see {@link @lazy-cjk/jp-table-comparison}`));
 	lines.push(`export const TABLE_KEYS = ${printTable(Object.keys(data.TABLE))} as const;`);
 
+	lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison;\nDO NOT EDIT.\n@see {@link @lazy-cjk/jp-table-comparison}`));
 	lines.push(`export const TABLE: ITABLE_MAIN = ${printTable(data.TABLE)};`);
+
+	lines.push(printJSDOC(`Code generated from @lazy-cjk/jp-table-comparison;\nDO NOT EDIT.\n@see {@link @lazy-cjk/jp-table-comparison}`));
 	lines.push(`export const TABLE_SAFE: ITABLE_MAIN = ${printTable(data.TABLE_SAFE)};`);
 
 	lines.push(``);
@@ -38,3 +43,11 @@ function printTable(table)
 {
 	return JSON.stringify(table, null, `\t`);
 }
+
+function printJSDOC(msg: string)
+{
+	const c = '\n * ';
+
+	return `/**${c}${lineSplit(msg).join(c)}${c}/`
+		.replace(/\*\s+\/$/, '*/');
+}