Migrate tools and configs to typescript, require node.js >= 22.18.0 (#35421)

Migrate all JS config and tools to TS and fix a number of type issues. This required Node.js 22.18.0 or greater where [type-stripping was enabled](https://nodejs.org/en/blog/release/v22.18.0) by default. Given that Node 22 is the current LTS, I think it's ok to assume that the user has a recent version of it. Webpack currently requires the `--disable-interpret` flag to work, should be fixed eventually with https://github.com/webpack/webpack-cli/issues/4525. `fast-glob` is replaced by `fs.globSync`, available in Node 22.0.0 or greater.
2025-09-12 03:34:57 +00:00 · 2025-09-06 14:58:25 +02:00
parent 1640e9a490
commit b8f1c9f048
14 changed files with 89 additions and 99 deletions
--- a/tools/generate-svg.ts
+++ b/tools/generate-svg.ts
@@ -0,0 +1,114 @@
+#!/usr/bin/env node
+import {optimize} from 'svgo';
+import {dirname, parse} from 'node:path';
+import {globSync, writeFileSync} from 'node:fs';
+import {readFile, writeFile, mkdir} from 'node:fs/promises';
+import {fileURLToPath} from 'node:url';
+import {exit} from 'node:process';
+import type {Manifest} from 'material-icon-theme';
+
+const glob = (pattern: string) => globSync(pattern, {cwd: dirname(import.meta.dirname)});
+
+type Opts = {
+  prefix?: string,
+  fullName?: string,
+};
+
+async function processAssetsSvgFile(path: string, {prefix, fullName}: Opts = {}) {
+  let name = fullName;
+  if (!name) {
+    name = parse(path).name;
+    if (prefix) name = `${prefix}-${name}`;
+    if (prefix === 'octicon') name = name.replace(/-[0-9]+$/, ''); // chop of '-16' on octicons
+  }
+  // Set the `xmlns` attribute so that the files are displayable in standalone documents
+  // The svg backend module will strip the attribute during startup for inline display
+  const {data} = optimize(await readFile(path, 'utf8'), {
+    plugins: [
+      {name: 'preset-default'},
+      {name: 'removeDimensions'},
+      {name: 'removeTitle'},
+      {name: 'prefixIds', params: {prefix: () => name}},
+      {name: 'addClassesToSVGElement', params: {classNames: ['svg', name]}},
+      {
+        name: 'addAttributesToSVGElement', params: {
+          attributes: [
+            {'xmlns': 'http://www.w3.org/2000/svg'},
+            {'width': '16'}, {'height': '16'}, {'aria-hidden': 'true'},
+          ],
+        },
+      },
+    ],
+  });
+  await writeFile(fileURLToPath(new URL(`../public/assets/img/svg/${name}.svg`, import.meta.url)), data);
+}
+
+function processAssetsSvgFiles(pattern: string, opts: Opts = {}) {
+  return glob(pattern).map((path) => processAssetsSvgFile(path, opts));
+}
+
+async function processMaterialFileIcons() {
+  const paths = glob('node_modules/material-icon-theme/icons/*.svg');
+  const svgSymbols: Record<string, string> = {};
+  for (const path of paths) {
+    // remove all unnecessary attributes, only keep "viewBox"
+    const {data} = optimize(await readFile(path, 'utf8'), {
+      plugins: [
+        {name: 'preset-default'},
+        {name: 'removeDimensions'},
+        {name: 'removeXMLNS'},
+        {name: 'removeAttrs', params: {attrs: 'xml:space', elemSeparator: ','}},
+      ],
+    });
+    const svgName = parse(path).name;
+    // intentionally use single quote here to avoid escaping
+    svgSymbols[svgName] = data.replace(/"/g, `'`);
+  }
+  writeFileSync(fileURLToPath(new URL(`../options/fileicon/material-icon-svgs.json`, import.meta.url)), JSON.stringify(svgSymbols, null, 2));
+
+  const vscodeExtensionsJson = await readFile(fileURLToPath(new URL(`generate-svg-vscode-extensions.json`, import.meta.url)), 'utf8');
+  const vscodeExtensions = JSON.parse(vscodeExtensionsJson) as Record<string, string>;
+  const iconRulesJson = await readFile(fileURLToPath(new URL(`../node_modules/material-icon-theme/dist/material-icons.json`, import.meta.url)), 'utf8');
+  const iconRules = JSON.parse(iconRulesJson) as Manifest;
+  // The rules are from VSCode material-icon-theme, we need to adjust them to our needs
+  // 1. We only use lowercase filenames to match (it should be good enough for most cases and more efficient)
+  // 2. We do not have a "Language ID" system:
+  //    * https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers
+  //    * https://github.com/microsoft/vscode/tree/1.98.0/extensions
+  delete iconRules.iconDefinitions;
+  for (const [k, v] of Object.entries(iconRules.fileNames)) iconRules.fileNames[k.toLowerCase()] = v;
+  for (const [k, v] of Object.entries(iconRules.folderNames)) iconRules.folderNames[k.toLowerCase()] = v;
+  for (const [k, v] of Object.entries(iconRules.fileExtensions)) iconRules.fileExtensions[k.toLowerCase()] = v;
+  // Use VSCode's "Language ID" mapping from its extensions
+  for (const [_, langIdExtMap] of Object.entries(vscodeExtensions)) {
+    for (const [langId, names] of Object.entries(langIdExtMap)) {
+      for (const name of names) {
+        const nameLower = name.toLowerCase();
+        if (nameLower[0] === '.') {
+          iconRules.fileExtensions[nameLower.substring(1)] ??= langId;
+        } else {
+          iconRules.fileNames[nameLower] ??= langId;
+        }
+      }
+    }
+  }
+  const iconRulesPretty = JSON.stringify(iconRules, null, 2);
+  writeFileSync(fileURLToPath(new URL(`../options/fileicon/material-icon-rules.json`, import.meta.url)), iconRulesPretty);
+}
+
+async function main() {
+  await mkdir(fileURLToPath(new URL('../public/assets/img/svg', import.meta.url)), {recursive: true});
+  await Promise.all([
+    ...processAssetsSvgFiles('node_modules/@primer/octicons/build/svg/*-16.svg', {prefix: 'octicon'}),
+    ...processAssetsSvgFiles('web_src/svg/*.svg'),
+    ...processAssetsSvgFiles('public/assets/img/gitea.svg', {fullName: 'gitea-gitea'}),
+    processMaterialFileIcons(),
+  ]);
+}
+
+try {
+  await main();
+} catch (err) {
+  console.error(err);
+  exit(1);
+}