diff --git a/icon.schema.json b/icon.schema.json index 2adb2c700..075930077 100644 --- a/icon.schema.json +++ b/icon.schema.json @@ -47,6 +47,10 @@ }, "minItems": 1, "uniqueItems": true + }, + "deprecated": { + "type": "boolean", + "default": false } }, "description": "A JSON Schema for icons defined by Lucide Icons." diff --git a/icons/chrome.json b/icons/chrome.json index ff9515a4c..e07964cf5 100644 --- a/icons/chrome.json +++ b/icons/chrome.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "ericfennis" @@ -11,4 +12,4 @@ "categories": [ "brands" ] -} \ No newline at end of file +} diff --git a/icons/codepen.json b/icons/codepen.json index e0e8fa2ba..05382b3df 100644 --- a/icons/codepen.json +++ b/icons/codepen.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "ericfennis" @@ -11,4 +12,4 @@ "brands", "development" ] -} \ No newline at end of file +} diff --git a/icons/codesandbox.json b/icons/codesandbox.json index 68ae126d6..e09a3e3c4 100644 --- a/icons/codesandbox.json +++ b/icons/codesandbox.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -12,4 +13,4 @@ "brands", "development" ] -} \ No newline at end of file +} diff --git a/icons/dribbble.json b/icons/dribbble.json index 0179199c0..41b57423f 100644 --- a/icons/dribbble.json +++ b/icons/dribbble.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "ahtohbi4", "karsa-mistmere" @@ -13,4 +14,4 @@ "social", "design" ] -} \ No newline at end of file +} diff --git a/icons/facebook.json b/icons/facebook.json index 03db54294..67852e58f 100644 --- a/icons/facebook.json +++ b/icons/facebook.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -14,4 +15,4 @@ "social", "brands" ] -} \ No newline at end of file +} diff --git a/icons/figma.json b/icons/figma.json index 2c452b3c4..b75bf2ba0 100644 --- a/icons/figma.json +++ b/icons/figma.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -15,4 +16,4 @@ "brands", "design" ] -} \ No newline at end of file +} diff --git a/icons/framer.json b/icons/framer.json index 2c452b3c4..b75bf2ba0 100644 --- a/icons/framer.json +++ b/icons/framer.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -15,4 +16,4 @@ "brands", "design" ] -} \ No newline at end of file +} diff --git a/icons/github.json b/icons/github.json index 935104a20..0111ffd98 100644 --- a/icons/github.json +++ b/icons/github.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -14,4 +15,4 @@ "brands", "development" ] -} \ No newline at end of file +} diff --git a/icons/gitlab.json b/icons/gitlab.json index 935104a20..0111ffd98 100644 --- a/icons/gitlab.json +++ b/icons/gitlab.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -14,4 +15,4 @@ "brands", "development" ] -} \ No newline at end of file +} diff --git a/icons/instagram.json b/icons/instagram.json index 8e8c9364e..f8f9dc404 100644 --- a/icons/instagram.json +++ b/icons/instagram.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -15,4 +16,4 @@ "social", "photography" ] -} \ No newline at end of file +} diff --git a/icons/pocket.json b/icons/pocket.json index b23a8cf0d..f2df830a5 100644 --- a/icons/pocket.json +++ b/icons/pocket.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -13,4 +14,4 @@ "brands", "development" ] -} \ No newline at end of file +} diff --git a/icons/slack.json b/icons/slack.json index d3aa1068c..93a1ff1aa 100644 --- a/icons/slack.json +++ b/icons/slack.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "ashygee", @@ -17,4 +18,4 @@ "brands", "development" ] -} \ No newline at end of file +} diff --git a/icons/trello.json b/icons/trello.json index 9d41a4a2b..bdda0eeff 100644 --- a/icons/trello.json +++ b/icons/trello.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "bdbch", "csandman", @@ -15,4 +16,4 @@ "brands", "development" ] -} \ No newline at end of file +} diff --git a/icons/twitch.json b/icons/twitch.json index f3d6e502d..fe163ceb1 100644 --- a/icons/twitch.json +++ b/icons/twitch.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "ahtohbi4", "johnletey" @@ -14,4 +15,4 @@ "account", "gaming" ] -} \ No newline at end of file +} diff --git a/icons/twitter.json b/icons/twitter.json index 0f81517a5..52003f200 100644 --- a/icons/twitter.json +++ b/icons/twitter.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -15,4 +16,4 @@ "social", "account" ] -} \ No newline at end of file +} diff --git a/icons/youtube.json b/icons/youtube.json index cea2740af..ead7e1d03 100644 --- a/icons/youtube.json +++ b/icons/youtube.json @@ -1,5 +1,6 @@ { "$schema": "../icon.schema.json", + "deprecated": true, "contributors": [ "colebemis", "csandman", @@ -20,4 +21,4 @@ "text", "brands" ] -} \ No newline at end of file +} diff --git a/packages/lucide-angular/scripts/exportTemplate.mjs b/packages/lucide-angular/scripts/exportTemplate.mjs index 67ecb12d5..064d70ecb 100644 --- a/packages/lucide-angular/scripts/exportTemplate.mjs +++ b/packages/lucide-angular/scripts/exportTemplate.mjs @@ -1,8 +1,26 @@ -export default ({ componentName, children }) => ` +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return `\ import { LucideIconData } from './types'; -/* eslint-disable no-shadow-restricted-names */ -const ${componentName}: LucideIconData = ${JSON.stringify(children)}; +/** + * @component @name ${componentName} + * @description Lucide SVG icon component, renders SVG Element with children. + * + * @preview ![img](data:image/svg+xml;base64,${svgBase64}) - https://lucide.dev/icons/${iconName} + * @see https://lucide.dev/guide/packages/lucide-vue-next - Documentation + * + * @param {Object} props - Lucide icons props and any valid SVG attribute + * @returns {FunctionalComponent} Vue component + * ${deprecated ? '@deprecated' : ''} +*/ +const ${componentName}: LucideIconData = ${JSON.stringify(children)}; //eslint-disable-line no-shadow-restricted-names export default ${componentName}; -`; +` +}; diff --git a/packages/lucide-preact/scripts/exportTemplate.mjs b/packages/lucide-preact/scripts/exportTemplate.mjs index ee09feaab..857ce67cc 100644 --- a/packages/lucide-preact/scripts/exportTemplate.mjs +++ b/packages/lucide-preact/scripts/exportTemplate.mjs @@ -1,7 +1,26 @@ -export default ({ componentName, children }) => ` +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return ` import createLucideIcon from '../createLucideIcon'; +/** + * @component @name ${componentName} + * @description Lucide SVG icon component, renders SVG Element with children. + * + * @preview ![img](data:image/svg+xml;base64,${svgBase64}) - https://lucide.dev/icons/${iconName} + * @see https://lucide.dev/guide/packages/lucide-preact - Documentation + * + * @param {Object} props - Lucide icons props and any valid SVG attribute + * @returns {JSX.Element} JSX Element + * ${deprecated ? '@deprecated' : ''} + */ const ${componentName} = createLucideIcon('${componentName}', ${JSON.stringify(children)}); export default ${componentName}; `; +}; diff --git a/packages/lucide-react-native/scripts/exportTemplate.mjs b/packages/lucide-react-native/scripts/exportTemplate.mjs index ee09feaab..ad1051c2a 100644 --- a/packages/lucide-react-native/scripts/exportTemplate.mjs +++ b/packages/lucide-react-native/scripts/exportTemplate.mjs @@ -1,7 +1,26 @@ -export default ({ componentName, children }) => ` +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return ` import createLucideIcon from '../createLucideIcon'; +/** + * @component @name ${componentName} + * @description Lucide SVG icon component, renders SVG Element with children. + * + * @preview ![img](data:image/svg+xml;base64,${svgBase64}) - https://lucide.dev/icons/${iconName} + * @see https://lucide.dev/guide/packages/lucide-react-native - Documentation + * + * @param {Object} props - Lucide icons props and any valid SVG attribute + * @returns {JSX.Element} JSX Element + * ${deprecated ? '@deprecated' : ''} + */ const ${componentName} = createLucideIcon('${componentName}', ${JSON.stringify(children)}); export default ${componentName}; `; +}; diff --git a/packages/lucide-react/scripts/exportTemplate.mjs b/packages/lucide-react/scripts/exportTemplate.mjs index b9c3d35af..7ccb638e7 100644 --- a/packages/lucide-react/scripts/exportTemplate.mjs +++ b/packages/lucide-react/scripts/exportTemplate.mjs @@ -1,16 +1,9 @@ -export default ({ componentName, iconName, children, getSvg }) => { +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { const svgContents = getSvg(); - - const svgBase64 = Buffer.from( - svgContents - .replace('\n', '') - .replace( - 'stroke="currentColor"', - 'stroke="#000" style="background-color: #fff; border-radius: 2px"', - ), - ).toString('base64'); - - // declarationFileContent += `\ + const svgBase64 = base64SVG(svgContents); return ` import createLucideIcon from '../createLucideIcon'; @@ -24,7 +17,7 @@ import createLucideIcon from '../createLucideIcon'; * * @param {Object} props - Lucide icons props and any valid SVG attribute * @returns {JSX.Element} JSX Element - * + * ${deprecated ? '@deprecated' : ''} */ const ${componentName} = createLucideIcon('${componentName}', ${JSON.stringify(children)}); diff --git a/packages/lucide-react/scripts/getAliasesEntryNames.mjs b/packages/lucide-react/scripts/getAliasesEntryNames.mjs index 0930d61fa..e67c535ab 100644 --- a/packages/lucide-react/scripts/getAliasesEntryNames.mjs +++ b/packages/lucide-react/scripts/getAliasesEntryNames.mjs @@ -1,11 +1,11 @@ import path from 'path'; // eslint-disable-next-line import/no-extraneous-dependencies -import getAliases from '@lucide/build-icons/utils/getAliases.mjs'; +import getIconMetaData from '@lucide/build-icons/utils/getIconMetaData.mjs'; const ICONS_DIR = path.resolve(process.cwd(), '../../icons'); export default async function getAliasesEntryNames() { - const metaJsonFiles = await getAliases(ICONS_DIR); + const metaJsonFiles = await getIconMetaData(ICONS_DIR); const iconWithAliases = Object.values(metaJsonFiles).filter(({ aliases }) => aliases != null); diff --git a/packages/lucide-react/src/createLucideIcon.ts b/packages/lucide-react/src/createLucideIcon.ts index daf73e7e3..b7c2b7c1f 100644 --- a/packages/lucide-react/src/createLucideIcon.ts +++ b/packages/lucide-react/src/createLucideIcon.ts @@ -35,8 +35,9 @@ export const toKebabCase = (string: string) => const createLucideIcon = (iconName: string, iconNode: IconNode): LucideIcon => { const Component = forwardRef( - ({ color = 'currentColor', size = 24, strokeWidth = 2, absoluteStrokeWidth, className = '', children, ...rest }, ref) => - createElement( + ({ color = 'currentColor', size = 24, strokeWidth = 2, absoluteStrokeWidth, className = '', children, ...rest }, ref) =>{ + + return createElement( 'svg', { ref, @@ -53,6 +54,7 @@ const createLucideIcon = (iconName: string, iconNode: IconNode): LucideIcon => { ...(Array.isArray(children) ? children : [children]), ] ) + } ); Component.displayName = `${iconName}`; diff --git a/packages/lucide-solid/scripts/exportTemplate.mjs b/packages/lucide-solid/scripts/exportTemplate.mjs index 715f47719..72385eb33 100644 --- a/packages/lucide-solid/scripts/exportTemplate.mjs +++ b/packages/lucide-solid/scripts/exportTemplate.mjs @@ -1,12 +1,31 @@ -export default ({ componentName, children }) => ` +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return ` import Icon from '../Icon'; import type { IconNode, LucideProps } from '../types'; const iconNode: IconNode = ${JSON.stringify(children)}; +/** + * @component @name ${componentName} + * @description Lucide SVG icon component, renders SVG Element with children. + * + * @preview ![img](data:image/svg+xml;base64,${svgBase64}) - https://lucide.dev/icons/${iconName} + * @see https://lucide.dev/guide/packages/lucide-solid - Documentation + * + * @param {Object} props - Lucide icons props and any valid SVG attribute + * @returns {JSX.Element} JSX Element + * ${deprecated ? '@deprecated' : ''} + */ const ${componentName} = (props: LucideProps) => ( ) export default ${componentName}; `; +}; diff --git a/packages/lucide-static/package.json b/packages/lucide-static/package.json index 6723e5325..f3aacac13 100644 --- a/packages/lucide-static/package.json +++ b/packages/lucide-static/package.json @@ -22,17 +22,27 @@ "Fontawesome", "Font Awesome" ], - "main": "lib/index.js", + "source": "src/lucide-static.js", + "main": "dist/cjs/lucide-static.js", + "module": "dist/esm/lucide-static.js", + "typings": "dist/lucide-static.d.ts", + "sideEffects": false, "scripts": { "copy:license": "cp ../../LICENSE ./LICENSE", + "build": "pnpm clean && pnpm copy:license && pnpm build:icons && pnpm build:bundles && pnpm build:lib && pnpm build:tags", "build:tags": "node ../../scripts/migrateIconsToTags.mjs", - "build": "pnpm clean && pnpm copy:license && pnpm build:lib && pnpm build:tags", + "build:icons": "build-icons --output=./src --templateSrc=./scripts/exportTemplate.mjs --iconFileExtension=.ts --withAliases --aliasNamesOnly --aliasesFileExtension=.ts --exportFileName=index.ts", "build:lib": "node ./scripts/buildLib.mjs", + "build:bundles": "rollup -c rollup.config.mjs", "clean": "rm -rf lib && rm -rf build && rm -rf icons && rm -f sprite.svg", "version": "pnpm version --git-tag-version=false" }, "devDependencies": { "prettier": "^2.3.2", - "svgson": "^5.2.1" + "svgson": "^5.2.1", + "@lucide/build-icons": "workspace:*", + "@lucide/rollup-plugins": "workspace:*", + "rollup": "^4.9.2", + "rollup-plugin-dts": "^6.1.0" } } diff --git a/packages/lucide-static/rollup.config.mjs b/packages/lucide-static/rollup.config.mjs new file mode 100644 index 000000000..fd90a5299 --- /dev/null +++ b/packages/lucide-static/rollup.config.mjs @@ -0,0 +1,59 @@ +import plugins from '@lucide/rollup-plugins'; +import dts from 'rollup-plugin-dts'; +import pkg from './package.json' assert { type: 'json' }; + +const outputFileName = pkg.name; +const outputDir = 'dist'; +const inputs = ['src/lucide-static.ts']; +const bundles = [ + { + format: 'cjs', + inputs, + outputDir, + }, + { + format: 'esm', + inputs, + outputDir, + preserveModules: true, + }, +]; + +const configs = bundles + .map(({ inputs, outputDir, format, minify, preserveModules }) => + inputs.map(input => ({ + input, + plugins: plugins(pkg, minify), + output: { + name: outputFileName, + ...(preserveModules + ? { + dir: `${outputDir}/${format}`, + } + : { + file: `${outputDir}/${format}/${outputFileName}${minify ? '.min' : ''}.js`, + }), + format, + sourcemap: true, + preserveModules, + }, + })), + ) + .flat(); + +const typesFileConfig = { + input: inputs[0], + output: [ + { + file: `${outputDir}/${outputFileName}.d.ts`, + format: 'esm', + }, + ], + plugins: [ + dts({ + include: ['src'], + }), + ], +}; + +export default [...configs, typesFileConfig]; diff --git a/packages/lucide-static/scripts/buildLib.mjs b/packages/lucide-static/scripts/buildLib.mjs index aa28c6169..7c5beb08b 100644 --- a/packages/lucide-static/scripts/buildLib.mjs +++ b/packages/lucide-static/scripts/buildLib.mjs @@ -5,9 +5,7 @@ import getArgumentOptions from 'minimist'; import { parseSync } from 'svgson'; import { - appendFile, readSvgDirectory, - toCamelCase, getCurrentDirPath, } from '../../../scripts/helpers.mjs'; import readSvgs from './readSvgs.mjs'; @@ -39,22 +37,6 @@ createDirectory(ICON_MODULE_DIR); const svgFiles = readSvgDirectory(ICONS_DIR); const svgs = readSvgs(svgFiles, ICONS_DIR); -const jsLicense = `/**\n * ${license}\n */\n`; - -appendFile(jsLicense, `index.js`, LIB_DIR); - -svgs.forEach(({ name, contents }) => { - const componentName = toCamelCase(name); - const importString = `module.exports.${componentName} = require('./icons/${name}');\n`; - appendFile(importString, `index.js`, LIB_DIR); - - const svgContent = contents.replace(' ({ name, contents, diff --git a/packages/lucide-static/scripts/exportTemplate.mjs b/packages/lucide-static/scripts/exportTemplate.mjs new file mode 100644 index 000000000..42e7a5f5f --- /dev/null +++ b/packages/lucide-static/scripts/exportTemplate.mjs @@ -0,0 +1,32 @@ +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + let svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + svgContents = svgContents.replace( + ' {/; + + if (exportClassRegex.test(newContents)) { + newContents = newContents.replace(exportClassRegex, `${blockComment}\nexport default class $1 extends SvelteComponentTyped<$2> {`); + } + } + } + + if(newContents !== contents) { + await writeFile(filepath, newContents, { encoding: 'utf-8' }); } } @@ -48,8 +73,8 @@ function getJSBanner() { } function getSvelteBanner() { - return ` \n`; } diff --git a/packages/lucide-svelte/scripts/exportTemplate.mjs b/packages/lucide-svelte/scripts/exportTemplate.mjs index ec40bdd8e..6b76f64bc 100644 --- a/packages/lucide-svelte/scripts/exportTemplate.mjs +++ b/packages/lucide-svelte/scripts/exportTemplate.mjs @@ -1,6 +1,11 @@ -// eslint-disable-next-line import/no-extraneous-dependencies -export default ({ iconName, children }) => - `\ +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ iconName, children, componentName, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return `\ `; +}; diff --git a/packages/lucide-vue-next/scripts/exportTemplate.mjs b/packages/lucide-vue-next/scripts/exportTemplate.mjs index 97b973100..1c22ec9b1 100644 --- a/packages/lucide-vue-next/scripts/exportTemplate.mjs +++ b/packages/lucide-vue-next/scripts/exportTemplate.mjs @@ -1,7 +1,26 @@ -export default ({ componentName, children }) => ` +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return ` import createLucideIcon from '../createLucideIcon'; +/** + * @component @name ${componentName} + * @description Lucide SVG icon component, renders SVG Element with children. + * + * @preview ![img](data:image/svg+xml;base64,${svgBase64}) - https://lucide.dev/icons/${iconName} + * @see https://lucide.dev/guide/packages/lucide-vue-next - Documentation + * + * @param {Object} props - Lucide icons props and any valid SVG attribute + * @returns {FunctionalComponent} Vue component + * ${deprecated ? '@deprecated' : ''} + */ const ${componentName} = createLucideIcon('${componentName}Icon', ${JSON.stringify(children)}); export default ${componentName}; `; +}; diff --git a/packages/lucide-vue/scripts/exportTemplate.mjs b/packages/lucide-vue/scripts/exportTemplate.mjs index 650b41782..b58291f79 100644 --- a/packages/lucide-vue/scripts/exportTemplate.mjs +++ b/packages/lucide-vue/scripts/exportTemplate.mjs @@ -1,7 +1,26 @@ -export default ({ componentName, children }) => ` -import createVueComponent from '../createVueComponent'; +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; -const ${componentName} = createVueComponent('${componentName}Icon', ${JSON.stringify(children)}); +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return ` +import createLucideIcon from '../createLucideIcon'; + +/** + * @component @name ${componentName} + * @description Lucide SVG icon component, renders SVG Element with children. + * + * @preview ![img](data:image/svg+xml;base64,${svgBase64}) - https://lucide.dev/icons/${iconName} + * @see https://lucide.dev/guide/packages/lucide-vue - Documentation + * + * @param {Object} props - Lucide icons props and any valid SVG attribute + * @returns {Component} Vue Component + * ${deprecated ? '@deprecated' : ''} + */ +const ${componentName} = createLucideIcon('${componentName}Icon', ${JSON.stringify(children)}); export default ${componentName}; `; +}; diff --git a/packages/lucide-vue/src/createVueComponent.ts b/packages/lucide-vue/src/createLucideIcon.ts similarity index 100% rename from packages/lucide-vue/src/createVueComponent.ts rename to packages/lucide-vue/src/createLucideIcon.ts diff --git a/packages/lucide/scripts/exportTemplate.mjs b/packages/lucide/scripts/exportTemplate.mjs index 282b62bae..bcd2ee942 100644 --- a/packages/lucide/scripts/exportTemplate.mjs +++ b/packages/lucide/scripts/exportTemplate.mjs @@ -1,7 +1,24 @@ -export default ({ componentName, children }) => ` +/* eslint-disable import/no-extraneous-dependencies */ +import base64SVG from '@lucide/build-icons/utils/base64SVG.mjs'; + +export default ({ componentName, iconName, children, getSvg, deprecated }) => { + const svgContents = getSvg(); + const svgBase64 = base64SVG(svgContents); + + return ` import defaultAttributes from '../defaultAttributes'; import type { IconNode } from '../types'; +/** + * @name ${iconName} + * @description Lucide SVG icon node. + * + * @preview ![img](data:image/svg+xml;base64,${svgBase64}) - https://lucide.dev/icons/${iconName} + * @see https://lucide.dev/guide/packages/lucide - Documentation + * + * @returns {Array} + * ${deprecated ? '@deprecated' : ''} + */ const ${componentName}: IconNode = [ 'svg', defaultAttributes, @@ -10,3 +27,4 @@ const ${componentName}: IconNode = [ export default ${componentName}; `; +}; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 71775bf47..35e4ddbdf 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -547,9 +547,21 @@ importers: packages/lucide-static: devDependencies: + '@lucide/build-icons': + specifier: workspace:* + version: link:../../tools/build-icons + '@lucide/rollup-plugins': + specifier: workspace:* + version: link:../../tools/rollup-plugins prettier: specifier: ^2.3.2 version: 2.8.8 + rollup: + specifier: ^4.9.2 + version: 4.9.2 + rollup-plugin-dts: + specifier: ^6.1.0 + version: 6.1.0(rollup@4.9.2)(typescript@4.9.5) svgson: specifier: ^5.2.1 version: 5.3.1 @@ -13790,8 +13802,8 @@ packages: duplexer: 0.1.2 dev: true - /h3-nightly@1.10.0-1701948668.39f9434: - resolution: {integrity: sha512-ZgDOpzAr8BO/sFzWYvLZLhg3d/NRbDeff+rA6vnoog0530NPEVfO3nIzCwY3nT+Z0faROooaiCyKaAPYbo7b9A==} + /h3-nightly@1.10.1-1704400265.ae91fc8: + resolution: {integrity: sha512-R2kWa+PpzYWLel4wSyJxS3DH8GSOs515uf72bW10uo5rbR0qvLw3esTnSYQLgDiOaqiFRP56kFFK7ClTfqko0g==} dependencies: cookie-es: 1.0.0 defu: 6.1.3 @@ -16817,7 +16829,7 @@ packages: fs-extra: 11.2.0 globby: 13.2.2 gzip-size: 7.0.0 - h3: /h3-nightly@1.10.0-1701948668.39f9434 + h3: /h3-nightly@1.10.1-1704400265.ae91fc8 hookable: 5.5.3 httpxy: 0.1.5 is-primitive: 3.0.1 diff --git a/tools/build-icons/building/generateAliasesFile.mjs b/tools/build-icons/building/generateAliasesFile.mjs index 47e7a3181..73517281c 100644 --- a/tools/build-icons/building/generateAliasesFile.mjs +++ b/tools/build-icons/building/generateAliasesFile.mjs @@ -10,7 +10,7 @@ export default async function generateAliasesFile({ outputDirectory, fileExtension, iconFileExtension = '.js', - aliases, + iconMetaData, aliasImportFileExtension, aliasNamesOnly = false, separateAliasesFile = false, @@ -27,7 +27,7 @@ export default async function generateAliasesFile({ await Promise.all( icons.map(async (iconName, index) => { const componentName = toPascalCase(iconName); - const iconAliases = aliases[iconName]?.aliases; + const iconAliases = iconMetaData[iconName]?.aliases; let importString = ''; diff --git a/tools/build-icons/building/generateIconFiles.mjs b/tools/build-icons/building/generateIconFiles.mjs index 954043293..b4f04b6bd 100644 --- a/tools/build-icons/building/generateIconFiles.mjs +++ b/tools/build-icons/building/generateIconFiles.mjs @@ -11,6 +11,7 @@ export default ({ iconFileExtension = '.js', pretty = true, iconsDir, + iconMetaData, }) => { const icons = Object.keys(iconNodes); const iconsDistDirectory = path.join(outputDirectory, `icons`); @@ -27,8 +28,9 @@ export default ({ children = children.map(({ name, attributes }) => [name, attributes]); const getSvg = () => readSvg(`${iconName}.svg`, iconsDir); + const { deprecated = false } = iconMetaData[iconName]; - const elementTemplate = template({ componentName, iconName, children, getSvg }); + const elementTemplate = template({ componentName, iconName, children, getSvg, deprecated }); const output = pretty ? prettier.format(elementTemplate, { singleQuote: true, diff --git a/tools/build-icons/index.mjs b/tools/build-icons/index.mjs index 923e98a8c..3f7ddaca9 100644 --- a/tools/build-icons/index.mjs +++ b/tools/build-icons/index.mjs @@ -1,2 +1,2 @@ // eslint-disable-next-line import/prefer-default-export -export { default as getAliases } from './utils/getAliases.mjs'; +export { default as getIconMetaData } from './utils/getIconMetaData.mjs'; diff --git a/tools/build-icons/main.mjs b/tools/build-icons/main.mjs index ff0e34b46..a5143ac2c 100755 --- a/tools/build-icons/main.mjs +++ b/tools/build-icons/main.mjs @@ -9,7 +9,7 @@ import generateExportsFile from './building/generateExportsFile.mjs'; import { readSvgDirectory, getCurrentDirPath } from '../../scripts/helpers.mjs'; import generateAliasesFile from './building/generateAliasesFile.mjs'; -import getAliases from './utils/getAliases.mjs'; +import getIconMetaData from './utils/getIconMetaData.mjs'; import generateDynamicImports from './building/generateDynamicImports.mjs'; const cliArguments = getArgumentOptions(process.argv.slice(2)); @@ -50,6 +50,8 @@ async function buildIcons() { const { default: iconFileTemplate } = await import(path.resolve(process.cwd(), templateSrc)); + const iconMetaData = await getIconMetaData(ICONS_DIR); + // Generates iconsNodes files for each icon generateIconFiles({ iconNodes: icons, @@ -59,14 +61,13 @@ async function buildIcons() { iconFileExtension, pretty: JSON.parse(pretty), iconsDir: ICONS_DIR, + iconMetaData, }); if (withAliases) { - const aliases = await getAliases(ICONS_DIR); - await generateAliasesFile({ iconNodes: icons, - aliases, + iconMetaData, aliasNamesOnly, iconFileExtension, outputDirectory: OUTPUT_DIR, diff --git a/tools/build-icons/utils/base64SVG.mjs b/tools/build-icons/utils/base64SVG.mjs new file mode 100644 index 000000000..b883d0fff --- /dev/null +++ b/tools/build-icons/utils/base64SVG.mjs @@ -0,0 +1,11 @@ +const base64SVG = (svgContents) => + Buffer.from( + svgContents + .replace('\n', '') + .replace( + 'stroke="currentColor"', + 'stroke="#000" style="background-color: #fff; border-radius: 2px"', + ), + ).toString('base64'); + +export default base64SVG; diff --git a/tools/build-icons/utils/getAliases.mjs b/tools/build-icons/utils/getIconMetaData.mjs similarity index 85% rename from tools/build-icons/utils/getAliases.mjs rename to tools/build-icons/utils/getIconMetaData.mjs index 91cc37989..e1ae610b0 100644 --- a/tools/build-icons/utils/getAliases.mjs +++ b/tools/build-icons/utils/getIconMetaData.mjs @@ -1,7 +1,7 @@ import path from 'path'; import { readSvgDirectory } from '../../../scripts/helpers.mjs'; -async function getAliases(iconDirectory) { +async function getIconMetaData(iconDirectory) { const iconJsons = readSvgDirectory(iconDirectory, '.json'); const aliasesEntries = await Promise.all( iconJsons.map(async (jsonFile) => { @@ -13,4 +13,4 @@ async function getAliases(iconDirectory) { return Object.fromEntries(aliasesEntries); } -export default getAliases +export default getIconMetaData