From e71a776acc3c066f8b0a1dbf90c24a699472e4af Mon Sep 17 00:00:00 2001 From: CokaKoala <31664583+AdrianGonz97@users.noreply.github.com> Date: Sun, 24 Dec 2023 06:45:57 -0500 Subject: [PATCH] Fixed export maps, types, and packaging for `lucide-svelte` (#1707) * add extensions for `NodeNext` support * fixed exports map and replaced the packaging system for `@sveltejs/pacakge` * lockfile * ignore generated `.svelte-kit` dir * no longer needed * fixed main export * fixed IconNode and IconProps types * have icon props extend svg attributes * build script for prepending the license to each `dist` file * Update packages/lucide-svelte/scripts/addLicense.mjs --------- Co-authored-by: Eric Fennis --- packages/lucide-svelte/.gitignore | 1 + packages/lucide-svelte/package.json | 27 ++-- packages/lucide-svelte/rollup.config.mjs | 84 ------------- packages/lucide-svelte/scripts/addLicense.mjs | 55 ++++++++ .../lucide-svelte/scripts/exportTemplate.mjs | 4 +- packages/lucide-svelte/src/lucide-svelte.ts | 8 +- packages/lucide-svelte/src/types.ts | 16 ++- pnpm-lock.yaml | 119 ++++++++---------- 8 files changed, 138 insertions(+), 176 deletions(-) delete mode 100644 packages/lucide-svelte/rollup.config.mjs create mode 100644 packages/lucide-svelte/scripts/addLicense.mjs diff --git a/packages/lucide-svelte/.gitignore b/packages/lucide-svelte/.gitignore index b2f3f64dd..f550ccc4b 100644 --- a/packages/lucide-svelte/.gitignore +++ b/packages/lucide-svelte/.gitignore @@ -1 +1,2 @@ src/icons/*.svelte +.svelte-kit \ No newline at end of file diff --git a/packages/lucide-svelte/package.json b/packages/lucide-svelte/package.json index b7412fd9b..a3a5dd68c 100644 --- a/packages/lucide-svelte/package.json +++ b/packages/lucide-svelte/package.json @@ -23,20 +23,20 @@ ], "author": "Eric Fennis", "type": "module", - "main": "dist/esm/lucide-svelte.js", + "main": "dist/lucide-svelte.js", "exports": { ".": { - "svelte": "./dist/svelte/lucide-svelte.js", "types": "./dist/lucide-svelte.d.ts", - "default": "./dist/esm/lucide-svelte.js" + "svelte": "./dist/lucide-svelte.js", + "default": "./dist/lucide-svelte.js" }, "./icons": { - "svelte": "./dist/svelte/icons/index.js", - "default": "./dist/esm/icons/index.js" + "types": "./dist/lucide-svelte.d.ts", + "svelte": "./dist/lucide-svelte.js" }, "./icons/*": { - "svelte": "./dist/svelte/icons/*.svelte", - "default": "./dist/esm/icons/*.js" + "types": "./dist/icons/*.svelte.d.ts", + "svelte": "./dist/icons/*.svelte" } }, "typings": "dist/lucide-svelte.d.ts", @@ -45,31 +45,26 @@ "dist" ], "scripts": { - "build": "pnpm clean && pnpm copy:license && pnpm build:icons && pnpm build:bundles && pnpm build:strip && pnpm build:types", + "build": "pnpm clean && pnpm copy:license && pnpm build:icons && pnpm build:package && pnpm build:license", "copy:license": "cp ../../LICENSE ./LICENSE", "clean": "rm -rf dist && rm -rf stats && rm -rf ./src/icons/*.svelte && rm -f index.js", "build:icons": "build-icons --output=./src --templateSrc=./scripts/exportTemplate.mjs --exportFileName=index.ts --iconFileExtension=.svelte --importImportFileExtension=.svelte --withAliases --aliasesFileExtension=.ts --aliasImportFileExtension=.svelte --pretty=false", - "build:types": "node ./scripts/buildTypes.mjs", - "build:bundles": "rollup -c ./rollup.config.mjs", - "build:strip": "svelte-strip strip src/ dist/svelte", + "build:package": "svelte-package --input ./src", + "build:license": "node ./scripts/addLicense.mjs", "test": "vitest run", "version": "pnpm version --git-tag-version=false" }, "devDependencies": { "@lucide/build-icons": "workspace:*", - "@lucide/rollup-plugins": "workspace:*", - "@rollup/plugin-node-resolve": "^15.1.0", + "@sveltejs/package": "^2.2.3", "@sveltejs/vite-plugin-svelte": "^2.4.2", "@testing-library/jest-dom": "^6.1.4", "@testing-library/svelte": "^4.0.2", "@tsconfig/svelte": "^5.0.0", "jsdom": "^20.0.3", - "rollup": "^3.25.3", - "rollup-plugin-svelte": "^7.1.6", "svelte": "^4.0.1", "svelte-check": "^3.4.4", "svelte-preprocess": "^5.0.4", - "svelte-strip": "^2.0.0", "typescript": "^5.1.6", "vite": "^4.4.12", "vitest": "^0.32.2" diff --git a/packages/lucide-svelte/rollup.config.mjs b/packages/lucide-svelte/rollup.config.mjs deleted file mode 100644 index 69a21a449..000000000 --- a/packages/lucide-svelte/rollup.config.mjs +++ /dev/null @@ -1,84 +0,0 @@ -/* eslint-disable import/no-extraneous-dependencies */ -import svelte from 'rollup-plugin-svelte'; -import pkg from './package.json' assert { type: 'json' }; -import plugins from '@lucide/rollup-plugins'; -import resolve from '@rollup/plugin-node-resolve'; -import svelteConfig from './svelte.config.js'; - -const packageName = 'LucideSvelte'; -const outputFileName = 'lucide-svelte'; -const outputDir = 'dist'; -const inputs = ['./src/lucide-svelte.ts']; -const bundles = [ - { - format: 'esm', - inputs, - outputDir, - preserveModules: true, - preserveModulesRoot: 'src', - }, - { - format: 'svelte', - inputs, - outputDir, - preserveModules: true, - }, -]; - -const configs = bundles - .map(({ inputs, outputDir, format, minify, preserveModules, preserveModulesRoot }) => - inputs.map(input => ({ - input, - plugins: [ - ...(format !== 'svelte' ? [ - svelte({ - ...svelteConfig, - include: 'src/**/*.svelte', - compilerOptions: { - dev: false, - css: 'external', - hydratable: true, - }, - emitCss: false, - }), - resolve({ - browser: true, - exportConditions: ['svelte'], - extensions: ['.svelte'] - }), - ] : []), - ...plugins(pkg, minify), - ], - external: format === 'svelte' ? [/\.svelte/] : ['svelte', 'svelte/internal'], - output: { - name: packageName, - ...(preserveModules - ? { - dir: `${outputDir}/${format}`, - } - : { - file: `${outputDir}/${format}/${outputFileName}${minify ? '.min' : ''}.js`, - }), - preserveModules, - preserveModulesRoot, - format: format === 'svelte' ? 'esm' : format, - sourcemap: true, - globals: { - svelte: 'svelte', - }, - entryFileNames: (chunkInfo) => { - if (chunkInfo.name.includes('node_modules')) { - const [pathToReplace, directory] = chunkInfo.name.match(/.*\/([^\/]+)\//); - const fileName = chunkInfo.name.replace(pathToReplace, ''); - - return `external/${directory}/${fileName}.js`; - } - - return '[name].js'; - } - }, - })), - ) - .flat(); - -export default configs; diff --git a/packages/lucide-svelte/scripts/addLicense.mjs b/packages/lucide-svelte/scripts/addLicense.mjs new file mode 100644 index 000000000..c00a7287c --- /dev/null +++ b/packages/lucide-svelte/scripts/addLicense.mjs @@ -0,0 +1,55 @@ +import { getCurrentDirPath } from '../../../scripts/helpers.mjs'; +import { lstatSync } from 'fs'; +import { readdir, readFile, writeFile } from 'fs/promises'; +import path from 'path'; +import pkg from '../package.json' assert { type: 'json' }; + +const BANNER = `@license ${pkg.name} v${pkg.version} - ${pkg.license} + +This source code is licensed under the ${pkg.license} license. +See the LICENSE file in the root directory of this source tree.`; + +const currentDir = getCurrentDirPath(import.meta.url); +const targetDirectory = path.join(currentDir, '../dist'); + +const files = await readdir(targetDirectory, { + recursive: true, + encoding: 'utf-8', +}); + +for (const file of files) { + const filepath = path.join(targetDirectory, file); + const filestat = lstatSync(filepath); + + if (filestat.isFile() === false || filestat.isDirectory()) continue; + + const contents = await readFile(filepath, { encoding: 'utf-8' }); + const ext = path.extname(filepath); + let license; + + if (/\.(js|mjs|cjs|ts)/.test(ext)) { + license = getJSBanner(); + } + + if (/\.svelte/.test(ext)) { + license = getSvelteBanner(); + } + + if (license) { + await writeFile(filepath, license + contents, { encoding: 'utf-8' }); + } +} + +function getJSBanner() { + return `/** + * ${BANNER} + */ +\n`; +} + +function getSvelteBanner() { + return ` +\n`; +} diff --git a/packages/lucide-svelte/scripts/exportTemplate.mjs b/packages/lucide-svelte/scripts/exportTemplate.mjs index da2f1e055..ec40bdd8e 100644 --- a/packages/lucide-svelte/scripts/exportTemplate.mjs +++ b/packages/lucide-svelte/scripts/exportTemplate.mjs @@ -3,7 +3,9 @@ export default ({ iconName, children }) => `\ diff --git a/packages/lucide-svelte/src/lucide-svelte.ts b/packages/lucide-svelte/src/lucide-svelte.ts index 8de8d514a..173f8b4bb 100644 --- a/packages/lucide-svelte/src/lucide-svelte.ts +++ b/packages/lucide-svelte/src/lucide-svelte.ts @@ -1,4 +1,4 @@ -export * from './icons'; -export * as icons from './icons'; -export * from './aliases'; -export { default as defaultAttributes } from './defaultAttributes' +export * from './icons/index.js'; +export * as icons from './icons/index.js'; +export * from './aliases.js'; +export { default as defaultAttributes } from './defaultAttributes.js'; diff --git a/packages/lucide-svelte/src/types.ts b/packages/lucide-svelte/src/types.ts index e58615e32..f289a905a 100644 --- a/packages/lucide-svelte/src/types.ts +++ b/packages/lucide-svelte/src/types.ts @@ -1,5 +1,13 @@ -/// -/// +import type { SVGAttributes, SvelteHTMLElements } from 'svelte/elements'; -export type Attrs = svelte.JSX.SVGProps -export type IconNode = [elementName: keyof svelte.JSX.IntrinsicElements, attrs: Attrs][] +type SVGAttrs = SVGAttributes; + +export type IconNode = [elementName: keyof SvelteHTMLElements, attrs: SVGAttrs][]; + +export interface IconProps extends SVGAttrs { + color?: string; + size?: number | string; + strokeWidth?: number | string; + absoluteStrokeWidth?: boolean; + class?: string; +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 297981c60..aa36efe66 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -550,12 +550,9 @@ importers: '@lucide/build-icons': specifier: workspace:* version: link:../../tools/build-icons - '@lucide/rollup-plugins': - specifier: workspace:* - version: link:../../tools/rollup-plugins - '@rollup/plugin-node-resolve': - specifier: ^15.1.0 - version: 15.1.0(rollup@3.27.0) + '@sveltejs/package': + specifier: ^2.2.3 + version: 2.2.3(svelte@4.1.2)(typescript@5.1.6) '@sveltejs/vite-plugin-svelte': specifier: ^2.4.2 version: 2.4.3(svelte@4.1.2)(vite@4.5.0) @@ -571,12 +568,6 @@ importers: jsdom: specifier: ^20.0.3 version: 20.0.3 - rollup: - specifier: ^3.25.3 - version: 3.27.0 - rollup-plugin-svelte: - specifier: ^7.1.6 - version: 7.1.6(rollup@3.27.0)(svelte@4.1.2) svelte: specifier: ^4.0.1 version: 4.1.2 @@ -586,9 +577,6 @@ importers: svelte-preprocess: specifier: ^5.0.4 version: 5.0.4(svelte@4.1.2)(typescript@5.1.6) - svelte-strip: - specifier: ^2.0.0 - version: 2.0.0(svelte@4.1.2) typescript: specifier: ^5.1.6 version: 5.1.6 @@ -8510,6 +8498,23 @@ packages: resolution: {integrity: sha512-Gfkvwk9o9kE9r9XNBmJRfV8zONvXThnm1tcuojL04Uy5uRyqg93DC83lDebl0rocZCfKSjUv+fWYtMQmEDJldg==} dev: false + /@sveltejs/package@2.2.3(svelte@4.1.2)(typescript@5.1.6): + resolution: {integrity: sha512-iZEC5qw+2RIjfIAHR3O+IeokJIjVM/ieoxPxj6YmZCwu5JKFADtC4jzjSUJ7GkCMUQ4HqE7u4/3cCxXBocxi8A==} + engines: {node: ^16.14 || >=18} + hasBin: true + peerDependencies: + svelte: ^3.44.0 || ^4.0.0 + dependencies: + chokidar: 3.5.3 + kleur: 4.1.5 + sade: 1.8.1 + semver: 7.5.4 + svelte: 4.1.2 + svelte2tsx: 0.6.27(svelte@4.1.2)(typescript@5.1.6) + transitivePeerDependencies: + - typescript + dev: true + /@sveltejs/vite-plugin-svelte-inspector@1.0.3(@sveltejs/vite-plugin-svelte@2.4.3)(svelte@4.1.2)(vite@4.5.0): resolution: {integrity: sha512-Khdl5jmmPN6SUsVuqSXatKpQTMIifoQPDanaxC84m9JxIibWvSABJyHpyys0Z+1yYrxY5TTEQm+6elh0XCMaOA==} engines: {node: ^14.18.0 || >= 16} @@ -12696,6 +12701,10 @@ packages: resolution: {integrity: sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==} engines: {node: '>=0.10'} + /dedent-js@1.0.1: + resolution: {integrity: sha512-OUepMozQULMLUmhxS95Vudo0jb0UchLimi3+pQ2plj61Fcy8axbP9hbiD4Sz6DPqn6XG3kfmziVfQ1rSys5AJQ==} + dev: true + /deep-eql@4.1.3: resolution: {integrity: sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw==} engines: {node: '>=6'} @@ -15339,16 +15348,6 @@ packages: minimatch: 5.1.6 once: 1.4.0 - /glob@9.3.5: - resolution: {integrity: sha512-e1LleDykUz2Iu+MTYdkSsuWX8lvAjAcs0Xef0lNIu0S2wOAzuTxCJtcd9S3cijlwYF18EsU3rzb8jPVobxDh9Q==} - engines: {node: '>=16 || 14 >=14.17'} - dependencies: - fs.realpath: 1.0.0 - minimatch: 8.0.4 - minipass: 4.2.8 - path-scurry: 1.10.1 - dev: true - /global@4.4.0: resolution: {integrity: sha512-wv/LAoHdRE3BeTGz53FAamhGlPLhlssK45usmGFThIi4XqnBmjKQ16u+RNbP7WvigRZDxUsM0J3gcQ5yicaL0w==} dependencies: @@ -17578,6 +17577,12 @@ packages: get-func-name: 2.0.2 dev: true + /lower-case@2.0.2: + resolution: {integrity: sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==} + dependencies: + tslib: 2.6.1 + dev: true + /lru-cache@10.0.3: resolution: {integrity: sha512-B7gr+F6MkqB3uzINHXNctGieGsRTMwIBgxkp0yq/5BwcuDzD4A8wQpHQW6vDAm1uKSLQghmRdD9sKqf2vJ1cEg==} engines: {node: 14 || >=16.14} @@ -18307,20 +18312,6 @@ packages: dependencies: brace-expansion: 2.0.1 - /minimatch@7.4.6: - resolution: {integrity: sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw==} - engines: {node: '>=10'} - dependencies: - brace-expansion: 2.0.1 - dev: true - - /minimatch@8.0.4: - resolution: {integrity: sha512-W0Wvr9HyFXZRGIDgCicunpQ299OKXs9RgZfaukz4qAW/pJhcpUfupc9c+OObPOFueNy8VSrZgEmDtk6Kh4WzDA==} - engines: {node: '>=16 || 14 >=14.17'} - dependencies: - brace-expansion: 2.0.1 - dev: true - /minimatch@9.0.1: resolution: {integrity: sha512-0jWhJpD/MdhPXwPuiRkCbfYfSKp2qnn2eOc279qI7f+osl/l+prKSrvhg157zSYvx/1nmgn2NqdT6k2Z7zSH9w==} engines: {node: '>=16 || 14 >=14.17'} @@ -18408,11 +18399,6 @@ packages: dependencies: yallist: 4.0.0 - /minipass@4.2.8: - resolution: {integrity: sha512-fNzuVyifolSLFL4NzpF+wEF4qrgqaaKX0haXPQEdQ7NKAN+WecoKMHV09YcuL/DHxrUsYQOK3MiuDf7Ip2OXfQ==} - engines: {node: '>=8'} - dev: true - /minipass@5.0.0: resolution: {integrity: sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==} engines: {node: '>=8'} @@ -18420,6 +18406,7 @@ packages: /minipass@7.0.3: resolution: {integrity: sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==} engines: {node: '>=16 || 14 >=14.17'} + dev: false /minisearch@6.3.0: resolution: {integrity: sha512-ihFnidEeU8iXzcVHy74dhkxh/dn8Dc08ERl0xwoMMGqp4+LvRSCgicb+zGqWthVokQKvCSxITlh3P08OzdTYCQ==} @@ -18741,6 +18728,13 @@ packages: - supports-color dev: true + /no-case@3.0.4: + resolution: {integrity: sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==} + dependencies: + lower-case: 2.0.2 + tslib: 2.6.1 + dev: true + /nocache@3.0.4: resolution: {integrity: sha512-WDD0bdg9mbq6F4mRxEYcPWwfA1vxd0mrvKOyxI7Xj/atfRHVeutzuWByG//jfm4uPzp0y4Kj051EORCBSQMycw==} engines: {node: '>=12.0.0'} @@ -19554,6 +19548,13 @@ packages: engines: {node: '>= 0.8'} dev: true + /pascal-case@3.1.2: + resolution: {integrity: sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==} + dependencies: + no-case: 3.0.4 + tslib: 2.6.1 + dev: true + /pascalcase@0.1.1: resolution: {integrity: sha512-XHXfu/yOQRy9vYOtUDVMN60OEJjW013GoObG1o+xwQTpB9eYJX/BjXMsdW13ZDPruFhYYn0AG22w0xgQMwl3Nw==} engines: {node: '>=0.10.0'} @@ -19599,6 +19600,7 @@ packages: dependencies: lru-cache: 10.0.3 minipass: 7.0.3 + dev: false /path-to-regexp@0.1.7: resolution: {integrity: sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==} @@ -21247,11 +21249,6 @@ packages: resolution: {integrity: sha512-ZuF55hVUQaaczgOIwqWzkEcEidmlD/xl44x1UZnhOXcYuFN2S6+rcxpG+C1N3So0wvNI3DmJICUFfu2SxhBmvg==} deprecated: https://github.com/lydell/resolve-url#deprecated - /resolve.exports@2.0.2: - resolution: {integrity: sha512-X2UW6Nw3n/aMgDVy+0rSqgHlv39WZAlZrXCdnbyEiKm17DSqHX4MmQMaST3FbeWR5FTuRcUwYAziZajji0Y7mg==} - engines: {node: '>=10'} - dev: true - /resolve@1.22.0: resolution: {integrity: sha512-Hhtrw0nLeSrFQ7phPp4OOcVjLPIeMnRlr5mcnVuMe7M/7eBn98A3hmFRLoFo3DLZkivSYwhRUJTyPyWAk56WLw==} hasBin: true @@ -22834,28 +22831,16 @@ packages: typescript: 5.1.6 dev: true - /svelte-strip@2.0.0(svelte@4.1.2): - resolution: {integrity: sha512-RZ8swt0ddE22ebZvFpMhW/x9rLIAwCZtWWnb5oohQEYcyuxzvzXwxImjFQ8DINXXMbvw6PB/NfnzDmHqMVrdbw==} - hasBin: true + /svelte2tsx@0.6.27(svelte@4.1.2)(typescript@5.1.6): + resolution: {integrity: sha512-E1uPW1o6VsbRz+nUk3fznZ2lSmCITAJoNu8AYefWSvIwE2pSB01i5sId4RMbWNzfcwCQl1DcgGShCPcldl4rvg==} peerDependencies: - svelte: ^3.0.0 + svelte: ^3.55 || ^4.0.0-next.0 || ^4.0 || ^5.0.0-next.0 + typescript: ^4.9.4 || ^5.0.0 dependencies: - glob: 9.3.5 - minimatch: 7.4.6 + dedent-js: 1.0.1 + pascal-case: 3.1.2 svelte: 4.1.2 - svelte-preprocess: 5.0.4(svelte@4.1.2)(typescript@5.1.6) typescript: 5.1.6 - yargs: 17.7.2 - transitivePeerDependencies: - - '@babel/core' - - coffeescript - - less - - postcss - - postcss-load-config - - pug - - sass - - stylus - - sugarss dev: true /svelte@4.1.2: