1
0
mirror of https://github.com/simple-icons/simple-icons.git synced 2024-12-16 01:10:30 +02:00
simple-icons/scripts/build/package.js

164 lines
5.1 KiB
JavaScript
Raw Normal View History

2024-03-24 19:38:18 +02:00
#!/usr/bin/env node
/**
2024-06-06 14:40:35 +02:00
* @file
2023-04-19 15:23:13 +02:00
* Simple Icons package build script.
*/
2024-06-06 14:40:35 +02:00
/**
* @typedef {import('../../types.js').License} License
* @typedef {import('esbuild').TransformOptions} EsBuildTransformOptions
*/
2024-03-24 19:38:18 +02:00
import {promises as fs} from 'node:fs';
import path from 'node:path';
import util from 'node:util';
2024-03-24 19:38:18 +02:00
import {transform as esbuildTransform} from 'esbuild';
import {
2024-03-24 19:38:18 +02:00
collator,
getDirnameFromImportMeta,
getIconSlug,
2024-03-24 19:38:18 +02:00
getIconsData,
slugToVariableName,
svgToPath,
titleToHtmlFriendly,
2023-04-19 15:23:13 +02:00
} from '../../sdk.mjs';
const __dirname = getDirnameFromImportMeta(import.meta.url);
const UTF8 = 'utf8';
2024-03-24 19:38:18 +02:00
const rootDirectory = path.resolve(__dirname, '..', '..');
const iconsDirectory = path.resolve(rootDirectory, 'icons');
const indexJsFile = path.resolve(rootDirectory, 'index.js');
const indexMjsFile = path.resolve(rootDirectory, 'index.mjs');
const sdkJsFile = path.resolve(rootDirectory, 'sdk.js');
const sdkMjsFile = path.resolve(rootDirectory, 'sdk.mjs');
const indexDtsFile = path.resolve(rootDirectory, 'index.d.ts');
2024-03-24 19:38:18 +02:00
const templatesDirectory = path.resolve(__dirname, 'templates');
const iconObjectTemplateFile = path.resolve(
templatesDirectory,
'icon-object.js.template',
);
/**
* Merged type from icon data and icon JS object needed to build by reference
* to not decrease performance in the build process.
* @typedef {import('../../types.js').SimpleIcon & import('../../sdk.d.ts').IconData} IconDataAndObject
*/
/** @type {IconDataAndObject[]} */
// @ts-ignore
2024-06-06 14:40:35 +02:00
const icons = await getIconsData();
const iconObjectTemplate = await fs.readFile(iconObjectTemplateFile, UTF8);
/**
* @param {string} value The value to escape
* @returns {string} The escaped value
*/
const escape = (value) => {
return value.replaceAll(/(?<!\\)'/g, "\\'");
};
/**
* @param {License} license The license object or URL
* @returns {License} The license object with a URL
*/
const licenseToObject = (license) => {
if (license.url === undefined) {
license.url = `https://spdx.org/licenses/${license.type}`;
}
return license;
};
/**
* Converts an icon object to a JavaScript object.
* @param {IconDataAndObject} icon The icon object
* @returns {string} The JavaScript object
*/
2024-06-06 14:40:35 +02:00
const iconToJsObject = (icon) => {
return util.format(
iconObjectTemplate,
escape(icon.title),
escape(icon.slug),
escape(titleToHtmlFriendly(icon.title)),
escape(icon.path),
escape(icon.source),
escape(icon.hex),
icon.guidelines ? `\n guidelines: '${escape(icon.guidelines)}',` : '',
icon.license === undefined
? ''
: `\n license: ${JSON.stringify(licenseToObject(icon.license))},`,
);
};
/**
* @param {string} filepath The path to the file to write
* @param {string} rawJavaScript The raw JavaScript content to write to the file
* @param {EsBuildTransformOptions | null} options The options to pass to esbuild
*/
const writeJs = async (filepath, rawJavaScript, options = null) => {
options = options === null ? {minify: true} : options;
const {code} = await esbuildTransform(rawJavaScript, options);
await fs.writeFile(filepath, code);
};
/**
* @param {string} filepath The path to the file to write
* @param {string} rawTypeScript The raw TypeScript content to write to the file
*/
const writeTs = async (filepath, rawTypeScript) => {
await fs.writeFile(filepath, rawTypeScript);
};
const build = async () => {
2022-09-23 20:44:28 +02:00
const buildIcons = await Promise.all(
icons.map(async (icon) => {
const filename = getIconSlug(icon);
2024-03-24 19:38:18 +02:00
const svgFilepath = path.resolve(iconsDirectory, `${filename}.svg`);
icon.svg = await fs.readFile(svgFilepath, UTF8);
icon.path = svgToPath(icon.svg);
icon.slug = filename;
2024-06-06 14:40:35 +02:00
const iconObject = iconToJsObject(icon);
const iconExportName = slugToVariableName(icon.slug);
2024-03-24 19:38:18 +02:00
return {icon, iconObject, iconExportName};
}),
);
export bundled icons from one entry point and add types (#6767) * export all icons from a single file (#6189) * fix: revert formatting, add exports to package.json * feat: generate icons.js and add relevant exports field * add minifyAndWrite Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * fix: minifyAndWrite build * add type: commonjs Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * simplify exports Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * add "require" in exports * place objects directly in barrel file * write exports minified Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * fix formatting Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * refactor slugToVariableName code into a function * fix slugToVariableName * change prefix to "si" * move slugToVariableName to local helper functions * unignore icons.js and icons.mjs Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * feat: add types (#6580) * feat: add types * fix linting error * export default from types/index.d.ts * minify * revert formatting changes * revert formatting change * change paths from types/index.d.ts to index.d.ts * mark icons.get as deprecated * move type alias to another file * update readme * update readme.md Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * update typescript usage section Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * fix conflicts * Apply suggestions from code review Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * add writeTs function Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>
2021-10-29 01:16:34 +02:00
2022-09-23 20:44:28 +02:00
const iconsBarrelDts = [];
const iconsBarrelJs = [];
const iconsBarrelMjs = [];
buildIcons.sort((a, b) => collator.compare(a.icon.title, b.icon.title));
2024-03-24 19:38:18 +02:00
for (const {iconObject, iconExportName} of buildIcons) {
2022-09-23 20:44:28 +02:00
iconsBarrelDts.push(`export const ${iconExportName}:I;`);
iconsBarrelJs.push(`${iconExportName}:${iconObject},`);
iconsBarrelMjs.push(`export const ${iconExportName}=${iconObject}`);
}
2022-09-23 20:44:28 +02:00
2024-03-24 19:38:18 +02:00
// Constants used in templates to reduce package size
const constantsString = `const a='<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>',b='</title><path d="',c='"/></svg>';`;
2024-03-24 19:38:18 +02:00
// Write our file containing the exports of all icons in CommonJS ...
const rawIndexJs = `${constantsString}module.exports={${iconsBarrelJs.join(
'',
)}};`;
await writeJs(indexJsFile, rawIndexJs);
2024-03-24 19:38:18 +02:00
// ... and ESM
const rawIndexMjs = constantsString + iconsBarrelMjs.join('');
await writeJs(indexMjsFile, rawIndexMjs);
2024-03-24 19:38:18 +02:00
// ... and create a type declaration file
const rawIndexDts = `import {SimpleIcon} from "./types";export {SimpleIcon};type I=SimpleIcon;${iconsBarrelDts.join(
'',
)}`;
await writeTs(indexDtsFile, rawIndexDts);
2023-04-19 15:23:13 +02:00
2024-03-24 19:38:18 +02:00
// Create a CommonJS SDK file
2023-04-19 15:23:13 +02:00
await writeJs(sdkJsFile, await fs.readFile(sdkMjsFile, UTF8), {
format: 'cjs',
});
};
export bundled icons from one entry point and add types (#6767) * export all icons from a single file (#6189) * fix: revert formatting, add exports to package.json * feat: generate icons.js and add relevant exports field * add minifyAndWrite Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * fix: minifyAndWrite build * add type: commonjs Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * simplify exports Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * add "require" in exports * place objects directly in barrel file * write exports minified Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * fix formatting Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * refactor slugToVariableName code into a function * fix slugToVariableName * change prefix to "si" * move slugToVariableName to local helper functions * unignore icons.js and icons.mjs Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * feat: add types (#6580) * feat: add types * fix linting error * export default from types/index.d.ts * minify * revert formatting changes * revert formatting change * change paths from types/index.d.ts to index.d.ts * mark icons.get as deprecated * move type alias to another file * update readme * update readme.md Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * update typescript usage section Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * fix conflicts * Apply suggestions from code review Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com> * add writeTs function Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>
2021-10-29 01:16:34 +02:00
2024-03-24 19:38:18 +02:00
await build();