vite-plugin-lucide-preprocess 1.0.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 WarningImHack3r <43064022+WarningImHack3r@users.noreply.github.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# vite-plugin-lucide-preprocess
+
+![NPM Version](https://img.shields.io/npm/v/vite-plugin-lucide-preprocess)
+![NPM Downloads](https://img.shields.io/npm/dw/vite-plugin-lucide-preprocess)
+![NPM Type Definitions](https://img.shields.io/npm/types/vite-plugin-lucide-preprocess)
+![NPM License](https://img.shields.io/npm/l/vite-plugin-lucide-preprocess)
+
+A [Vite](https://vitejs.dev) plugin to replace imports for [Lucide icons](https://lucide.dev).
+
+## What is this?
+
+This plugin is a follow-up to [this PR on Lucide](https://github.com/lucide-icons/lucide/pull/1707).  
+If you want to import Lucide icons in your project, you can use two methods:
+
+```js
+import { IconName } from "lucide-svelte";
+// or, since PR #1707 (at least for lucide-svelte):
+import IconName from "lucide-svelte/icons/icon-name";
+```
+
+While the first method is more convenient (and may be the one used by auto-import features in your editor), it is not tree-shakeable. In fact, a single import from `"lucide-<library>"` will import all icons, which is not ideal for performance.
+
+This plugin will replace the first method with the second one, so you can keep the convenience of the first method while benefiting from tree-shaking optimizations. “Correct” imports will be kept as-is.
+
+> [!NOTE]
+> It is primarily intended for `lucide-svelte`, but it should work with any Lucide package using Vite, if they follow the same structure.
+
+## Installation
+
+Install the plugin with your package manager of choice:
+
+```bash
+pnpm i -D vite-plugin-lucide-preprocess
+```
+
+Then, add it to your `vite.config.js`/`.ts`:
+
+```js
+import { defineConfig } from "vite";
+import lucidePreprocess from "vite-plugin-lucide-preprocess";
+
+export default defineConfig({
+  plugins: [lucidePreprocess(), ...]
+});
+```
+
+> [!WARNING]
+> Make sure to add the plugin **before** any other preprocessors in the `plugins` array.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The Vite plugin that preprocesses imports to optimize Lucide icons
+ * @return {import("vite").Plugin}
+ */
+export default function _default(): import("vite").Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AAEA;;;GAGG;AACH,oCAFY,OAAO,MAAM,EAAE,MAAM,CAyChC"}

package/dist/index.js

@@ -0,0 +1,41 @@
+const ignoredPaths = ["/node_modules/", "/.svelte-kit/"];
+/**
+ * The Vite plugin that preprocesses imports to optimize Lucide icons
+ * @return {import("vite").Plugin}
+ */
+export default function () {
+    return {
+        name: "vite-plugin-lucide-preprocess",
+        enforce: "pre",
+        transform: (code, path) => {
+            if (ignoredPaths.some(p => path.includes(p))) {
+                return;
+            }
+            return {
+                code: code.replace(/^(\s*)import\s+\{([^}]*)}\s+from\s+(["'])lucide-(.*?)["'](.*)$/gm, 
+                /**
+                 * @param _ The whole matched string
+                 * @param initialSpacing {string} The spacing before the matched import statement
+                 * @param modulesStr {string} The imported icons as a raw string
+                 * @param quote {string} The quote used in the import statement (either ' or ")
+                 * @param framework {string} The framework the icons are imported for
+                 * @param lineEnding {string} The end of the line of the matched import statement (often a semicolon)
+                 * @return The optimized import statement(s)
+                 */
+                (_, initialSpacing, modulesStr, quote, framework, lineEnding) => {
+                    const modules = modulesStr
+                        .split(",")
+                        .map(m => m.trim())
+                        .filter(m => !m.startsWith("type"));
+                    return modules
+                        .map(m => {
+                        const dashedModule = m.replace(/[A-Z]/g, (match, offset) => (offset > 0 ? "-" : "") + match.toLowerCase());
+                        return `${initialSpacing}import ${m} from ${quote}lucide-${framework}/icons/${dashedModule}${quote}${lineEnding.trimEnd()}`;
+                    })
+                        .join("\n");
+                })
+            };
+        }
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAAG,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,CAAC,OAAO;IACb,OAAO;QACN,IAAI,EAAE,+BAA+B;QACrC,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACzB,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9C,OAAO;YACR,CAAC;YACD,OAAO;gBACN,IAAI,EAAE,IAAI,CAAC,OAAO,CACjB,kEAAkE;gBAClE;;;;;;;;mBAQG;gBACH,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE;oBAC/D,MAAM,OAAO,GAAG,UAAU;yBACxB,KAAK,CAAC,GAAG,CAAC;yBACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;yBAClB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;oBACrC,OAAO,OAAO;yBACZ,GAAG,CAAC,CAAC,CAAC,EAAE;wBACR,MAAM,YAAY,GAAG,CAAC,CAAC,OAAO,CAC7B,QAAQ,EACR,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,CAChE,CAAC;wBACF,OAAO,GAAG,cAAc,UAAU,CAAC,SAAS,KAAK,UAAU,SAAS,UAAU,YAAY,GAAG,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC7H,CAAC,CAAC;yBACD,IAAI,CAAC,IAAI,CAAC,CAAC;gBACd,CAAC,CACD;aACD,CAAC;QACH,CAAC;KACD,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "vite-plugin-lucide-preprocess",
+  "version": "1.0.0",
+  "author": {
+    "url": "https://github.com/WarningImHack3r",
+    "name": "WarningImHack3r"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/WarningImHack3r/vite-plugin-lucide-preprocess"
+  },
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "lucide",
+    "preprocessor"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*"
+  ],
+  "peerDependencies": {
+    "vite": "^5"
+  },
+  "devDependencies": {
+    "prettier": "^3.3.3",
+    "publint": "^0.2.9",
+    "typescript": "^5.5.4",
+    "vite": "^5.4.0"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "tsc",
+    "lint": "prettier --check . && publint",
+    "format": "prettier --write ."
+  }
+}