ci: Improve build speeds (#2778)

* Revert sync to async functions * Replace more sync fs functions * Format files * Fix build svelte package
lucide-icons · Feb 10, 2025 · 50630b3 · 50630b3
1 parent e28426a
commit 50630b3
Show file tree

Hide file tree

Showing 46 changed files with 236 additions and 162 deletions.
diff --git a/docs/scripts/writeCategoriesMetadata.mjs b/docs/scripts/writeCategoriesMetadata.mjs
@@ -1,16 +1,17 @@
-import fs from 'fs';
+import fs from 'fs/promises';
 import path from 'path';
 
 const currentDir = process.cwd();
 const dataDirectory = path.resolve(currentDir, '.vitepress/data');
 const directory = path.join(process.cwd(), '../categories');
 
-function getAllCategoryFiles() {
-  const fileNames = fs.readdirSync(directory).filter((file) => path.extname(file) === '.json');
+async function getAllCategoryFiles() {
+  const categoryDirectoryContents = await fs.readdir(directory);
+  const fileNames = categoryDirectoryContents.filter((file) => path.extname(file) === '.json');
 
-  return fileNames.map((fileName) => {
+  const categoryJSONReadPromises = fileNames.map(async (fileName) => {
     const name = path.basename(fileName, '.json');
-    const fileContent = fs.readFileSync(path.join(directory, fileName), 'utf8');
+    const fileContent = await fs.readFile(path.join(directory, fileName), 'utf8');
 
     const parsedFileContent = JSON.parse(fileContent);
 
@@ -19,14 +20,15 @@ function getAllCategoryFiles() {
       title: parsedFileContent.title,
     };
   });
+
+  return Promise.all(categoryJSONReadPromises);
 }
 
 const categoriesFile = path.resolve(dataDirectory, `categoriesData.json`);
 
-const categoriesData = getAllCategoryFiles();
+const categoriesData = await getAllCategoryFiles();
 
-fs.promises
-  .writeFile(categoriesFile, JSON.stringify(categoriesData, null, 2), 'utf-8')
+fs.writeFile(categoriesFile, JSON.stringify(categoriesData, null, 2), 'utf-8')
   .then(() => {
     console.log('Successfully written categoriesData.json file');
   })

diff --git a/docs/scripts/writeIconDetails.mjs b/docs/scripts/writeIconDetails.mjs
@@ -4,7 +4,7 @@ import { readSvgDirectory, toCamelCase } from '@lucide/helpers';
 
 const currentDir = process.cwd();
 const ICONS_DIR = path.resolve(currentDir, '../icons');
-const icons = readSvgDirectory(ICONS_DIR, '.json');
+const icons = await readSvgDirectory(ICONS_DIR, '.json');
 
 const iconDetailsDirectory = path.resolve(currentDir, '.vitepress/data', 'iconDetails');
 

diff --git a/docs/scripts/writeIconMetaIndex.mjs b/docs/scripts/writeIconMetaIndex.mjs
@@ -4,7 +4,7 @@ import { readSvgDirectory, toCamelCase } from '@lucide/helpers';
 
 const currentDir = process.cwd();
 const ICONS_DIR = path.resolve(currentDir, '../icons');
-const iconJsonFiles = readSvgDirectory(ICONS_DIR, '.json');
+const iconJsonFiles = await readSvgDirectory(ICONS_DIR, '.json');
 
 const location = path.resolve(currentDir, '.vitepress/data', 'iconMetaData.ts');
 

diff --git a/docs/scripts/writeIconNodes.mjs b/docs/scripts/writeIconNodes.mjs
@@ -5,8 +5,8 @@ import { readSvgDirectory, toCamelCase } from '@lucide/helpers';
 
 const currentDir = process.cwd();
 const ICONS_DIR = path.resolve(currentDir, '../icons');
-const svgFiles = readSvgDirectory(ICONS_DIR);
-const icons = renderIconsObject(svgFiles, ICONS_DIR, true);
+const svgFiles = await readSvgDirectory(ICONS_DIR);
+const icons = await renderIconsObject(svgFiles, ICONS_DIR, true);
 
 const iconNodesDirectory = path.resolve(currentDir, '.vitepress/data', 'iconNodes');
 
@@ -32,7 +32,7 @@ const writeIconFiles = Object.entries(icons).map(async ([iconName, { children }]
   await fs.promises.writeFile(location, output, 'utf-8');
 
   iconIndexFileImports.push(
-    `import ${toCamelCase(iconName)}Node from './${iconName}.node.json' assert { type: "json" };`,
+    `import ${toCamelCase(iconName)}Node from './${iconName}.node.json' with { type: "json" };`,
   );
   iconIndexFileExports.push(`  ${toCamelCase(iconName)}Node as ${toCamelCase(iconName)},`);
   iconIndexFileDefaultExports.push(`  '${iconName}': ${toCamelCase(iconName)}Node,`);

diff --git a/docs/scripts/writeIconRelatedIcons.mjs b/docs/scripts/writeIconRelatedIcons.mjs
@@ -4,7 +4,7 @@ import { readSvgDirectory } from '@lucide/helpers';
 
 const currentDir = process.cwd();
 const ICONS_DIR = path.resolve(currentDir, '../icons');
-const svgFiles = readSvgDirectory(ICONS_DIR, '.json');
+const svgFiles = await readSvgDirectory(ICONS_DIR, '.json');
 
 const location = path.resolve(currentDir, '.vitepress/data', 'relatedIcons.json');
 
@@ -18,9 +18,7 @@ const categoryWeight = 3;
 
 const MAX_RELATED_ICONS = 4 * 17; // grid of 4x17 icons, = 68 icons
 
-const arrayMatches = (a, b) => {
-  return a.filter((item) => b.includes(item)).length;
-};
+const arrayMatches = (a, b) => a.filter((item) => b.includes(item)).length;
 
 const nameParts = (icon) =>
   [
@@ -36,6 +34,7 @@ const getRelatedIcons = (currentIcon, icons) => {
     nameWeight * arrayMatches(nameParts(item), nameParts(currentIcon)) +
     categoryWeight * arrayMatches(item.categories ?? [], currentIcon.categories ?? []) +
     tagWeight * arrayMatches(item.tags ?? [], currentIcon.tags ?? []);
+
   return icons
     .filter((i) => i.name !== currentIcon.name)
     .map((icon) => ({ icon, similarity: iconSimilarity(icon) }))
@@ -46,7 +45,8 @@ const getRelatedIcons = (currentIcon, icons) => {
 };
 
 const iconsMetaDataPromises = svgFiles.map(async (iconName) => {
-  const metaData = JSON.parse(fs.readFileSync(`../icons/${iconName}`));
+  const metaDataFileContent = await fs.promises.readFile(`../icons/${iconName}`);
+  const metaData = JSON.parse(metaDataFileContent);
 
   const name = iconName.replace('.json', '');
 

diff --git a/docs/scripts/writeReleaseMetadata.mjs b/docs/scripts/writeReleaseMetadata.mjs
@@ -11,7 +11,7 @@ const git = simpleGit();
 
 const currentDir = process.cwd();
 const ICONS_DIR = path.resolve(currentDir, '../icons');
-const iconJsonFiles = readSvgDirectory(ICONS_DIR, '.json');
+const iconJsonFiles = await readSvgDirectory(ICONS_DIR, '.json');
 const location = path.resolve(currentDir, '.vitepress/data', 'releaseMetaData.json');
 const releaseMetaDataDirectory = path.resolve(currentDir, '.vitepress/data', 'releaseMetadata');
 

diff --git a/docs/scripts/writeVercelOutput.mjs b/docs/scripts/writeVercelOutput.mjs
@@ -44,4 +44,4 @@ const output = JSON.stringify(vercelRouteConfig, null, 2);
 
 const vercelOutputJSON = path.resolve(currentDir, '.vercel/output/config.json');
 
-fs.writeFileSync(vercelOutputJSON, output, 'utf-8');
+await fs.promises.writeFile(vercelOutputJSON, output, 'utf-8');
diff --git a/packages/lucide-angular/scripts/exportTemplate.mjs b/packages/lucide-angular/scripts/exportTemplate.mjs
@@ -1,8 +1,15 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  componentName,
+  iconName,
+  children,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `\

diff --git a/packages/lucide-preact/rollup.config.mjs b/packages/lucide-preact/rollup.config.mjs
@@ -1,6 +1,6 @@
 import plugins from '@lucide/rollup-plugins';
 import dts from 'rollup-plugin-dts';
-import pkg from './package.json' assert { type: 'json' };
+import pkg from './package.json' with { type: 'json' };
 
 const packageName = 'LucidePreact';
 const outputFileName = 'lucide-preact';

diff --git a/packages/lucide-preact/scripts/exportTemplate.mjs b/packages/lucide-preact/scripts/exportTemplate.mjs
@@ -1,8 +1,15 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  componentName,
+  iconName,
+  children,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `

diff --git a/packages/lucide-react-native/scripts/exportTemplate.mjs b/packages/lucide-react-native/scripts/exportTemplate.mjs
@@ -1,8 +1,15 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  componentName,
+  iconName,
+  children,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `

diff --git a/packages/lucide-react/scripts/exportTemplate.mjs b/packages/lucide-react/scripts/exportTemplate.mjs
@@ -1,8 +1,15 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  componentName,
+  iconName,
+  children,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `

diff --git a/packages/lucide-solid/scripts/exportTemplate.mjs b/packages/lucide-solid/scripts/exportTemplate.mjs
@@ -1,8 +1,15 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  componentName,
+  iconName,
+  children,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `

diff --git a/packages/lucide-static/scripts/buildLib.mjs b/packages/lucide-static/scripts/buildLib.mjs
@@ -30,15 +30,17 @@ const license = `@license ${pkg.name} v${pkg.version} - ${pkg.license}`;
 createDirectory(LIB_DIR);
 createDirectory(ICON_MODULE_DIR);
 
-const svgFiles = readSvgDirectory(ICONS_DIR);
-const svgs = readSvgs(svgFiles, ICONS_DIR);
+const svgFiles = await readSvgDirectory(ICONS_DIR);
+const svgs = await readSvgs(svgFiles, ICONS_DIR);
 
 const parsedSvgs = svgs.map(({ name, contents }) => ({
   name,
   contents,
   parsedSvg: parseSync(contents),
 }));
 
-generateSprite(parsedSvgs, PACKAGE_DIR, license);
-generateIconNodes(parsedSvgs, PACKAGE_DIR);
-copyIcons(parsedSvgs, PACKAGE_DIR, license);
+await Promise.all([
+  generateSprite(parsedSvgs, PACKAGE_DIR, license),
+  generateIconNodes(parsedSvgs, PACKAGE_DIR),
+  copyIcons(parsedSvgs, PACKAGE_DIR, license),
+]);
diff --git a/packages/lucide-static/scripts/exportTemplate.mjs b/packages/lucide-static/scripts/exportTemplate.mjs
@@ -1,8 +1,8 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  let svgContents = getSvg();
+export default async ({ componentName, iconName, getSvg, deprecated, deprecationReason }) => {
+  let svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   svgContents = svgContents.replace(

diff --git a/packages/lucide-static/scripts/generateIconNodes.mjs b/packages/lucide-static/scripts/generateIconNodes.mjs
@@ -1,6 +1,6 @@
 import { writeFile } from '@lucide/helpers';
 
-export default function generateIconNodes(parsedSvgs, packageDir) {
+export default async function generateIconNodes(parsedSvgs, packageDir) {
   const iconNodes = parsedSvgs.reduce((acc, { name, parsedSvg }) => {
     acc[name] = parsedSvg.children.map(({ name, attributes }) => [name, attributes]);
 
@@ -9,5 +9,5 @@ export default function generateIconNodes(parsedSvgs, packageDir) {
 
   const iconNodesStringified = JSON.stringify(iconNodes, null, 2);
 
-  writeFile(iconNodesStringified, 'icon-nodes.json', packageDir);
+  await writeFile(iconNodesStringified, 'icon-nodes.json', packageDir);
 }
diff --git a/packages/lucide-static/scripts/generateSprite.mjs b/packages/lucide-static/scripts/generateSprite.mjs
@@ -3,7 +3,7 @@ import { stringify } from 'svgson';
 import { format } from 'prettier';
 import { appendFile } from '@lucide/helpers';
 
-export default function generateSprite(svgs, packageDir, license) {
+export default async function generateSprite(svgs, packageDir, license) {
   const symbols = svgs.map(({ name, parsedSvg }) => ({
     name: 'symbol',
     type: 'element',
@@ -34,6 +34,6 @@ export default function generateSprite(svgs, packageDir, license) {
 
   const xmlMeta = `<?xml version="1.0" encoding="utf-8"?>\n<!-- ${license} -->\n`;
 
-  appendFile(xmlMeta, `sprite.svg`, packageDir);
-  appendFile(prettifiedSprite, `sprite.svg`, packageDir);
+  await appendFile(xmlMeta, `sprite.svg`, packageDir);
+  await appendFile(prettifiedSprite, `sprite.svg`, packageDir);
 }
diff --git a/packages/lucide-static/scripts/readSvgs.mjs b/packages/lucide-static/scripts/readSvgs.mjs
@@ -9,10 +9,12 @@ import { readSvg } from '@lucide/helpers';
  * @returns {Object}
  */
 export default function readSVGs(svgFiles, iconsDirectory) {
-  return svgFiles.map((svgFile) => {
+  const SVGReadPromises = svgFiles.map(async (svgFile) => {
     const name = basename(svgFile, '.svg');
-    const contents = readSvg(svgFile, iconsDirectory);
+    const contents = await readSvg(svgFile, iconsDirectory);
 
     return { name, contents };
   });
+
+  return Promise.all(SVGReadPromises);
 }
diff --git a/packages/lucide-svelte/package.json b/packages/lucide-svelte/package.json
@@ -52,7 +52,7 @@
     "build:icons": "build-icons --output=./src --templateSrc=./scripts/exportTemplate.mjs --exportFileName=index.ts --iconFileExtension=.svelte --importImportFileExtension=.svelte --separateIconFileExport --separateIconFileExportExtension=.ts --withAliases --aliasesFileExtension=.ts --separateAliasesFile  --separateAliasesFileExtension=.ts --aliasImportFileExtension=.js --pretty=false",
     "build:package": "svelte-package --input ./src",
     "build:license": "node ./scripts/appendBlockComments.mjs",
-    "test": "pnpm build:icons && vitest run",
+    "test": "pnpm copy:license && pnpm build:icons && vitest run",
     "test:watch": "vitest watch",
     "version": "pnpm version --git-tag-version=false"
   },

diff --git a/packages/lucide-svelte/scripts/appendBlockComments.mjs b/packages/lucide-svelte/scripts/appendBlockComments.mjs
@@ -4,7 +4,7 @@ import path from 'path';
 import { getCurrentDirPath } from '@lucide/helpers';
 import { getJSBanner } from './license.mjs';
 
-const currentDir = getCurrentDirPath(import.meta.url);
+const currentDir = await getCurrentDirPath(import.meta.url);
 const targetDirectory = path.join(currentDir, '../dist');
 
 const files = await readdir(targetDirectory, {

diff --git a/packages/lucide-svelte/scripts/exportTemplate.mjs b/packages/lucide-svelte/scripts/exportTemplate.mjs
@@ -2,8 +2,15 @@
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 import { getJSBanner } from './license.mjs';
 
-export default ({ iconName, children, componentName, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  iconName,
+  children,
+  componentName,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `\

diff --git a/packages/lucide-vue-next/scripts/exportTemplate.mjs b/packages/lucide-vue-next/scripts/exportTemplate.mjs
@@ -1,8 +1,15 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  componentName,
+  iconName,
+  children,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `

diff --git a/packages/lucide-vue/scripts/exportTemplate.mjs b/packages/lucide-vue/scripts/exportTemplate.mjs
@@ -1,8 +1,15 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs';
 
-export default ({ componentName, iconName, children, getSvg, deprecated, deprecationReason }) => {
-  const svgContents = getSvg();
+export default async ({
+  componentName,
+  iconName,
+  children,
+  getSvg,
+  deprecated,
+  deprecationReason,
+}) => {
+  const svgContents = await getSvg();
   const svgBase64 = base64SVG(svgContents);
 
   return `
Original file line number	Diff line number	Diff line change
Expand Up		@@ -44,4 +44,4 @@ const output = JSON.stringify(vercelRouteConfig, null, 2);

		const vercelOutputJSON = path.resolve(currentDir, '.vercel/output/config.json');

		fs.writeFileSync(vercelOutputJSON, output, 'utf-8');
		await fs.promises.writeFile(vercelOutputJSON, output, 'utf-8');