vite-plugin-lib 2.2.1 → 3.0.1

package/README.md

@@ -24,6 +24,7 @@ This highly opinionated all-in one Vite plugin enables automatic alias configura
 
 ```ts
 import { defineConfig } from 'vite'
+
 import { tsconfigPaths } from 'vite-plugin-lib'
 
 export default defineConfig({
@@ -37,6 +38,7 @@ The `library` plugin includes the `alias` plugin, configures build settings, and
 
 ```ts
 import { defineConfig } from 'vite'
+
 import { library } from 'vite-plugin-lib'
 
 export default defineConfig({
@@ -45,7 +47,16 @@ export default defineConfig({
       entry: 'src/index.ts', // file name determines output file names, default is 'src/index.ts'
       formats: ['es'], // optional, default is ['es']
       name: 'YourGlobalUMDName', // optional if format does not include 'umd' or 'iife'
-      external: ['some-package'], // optional, default is all node_modules and builtin modules
+      // optional, default externalizes all builtin modules, node_modules, dependencies, and peerDependencies
+      bundle: {
+        builtin: false,
+        dependencies: false,
+        devDependencies: true,
+        peerDependencies: false,
+        exclude: [], // individual packages or modules to externalize
+        include: [], // override the default externalization for individual packages or modules
+        nodeModules: false,
+      },
       manifest: 'package.json', // relative path to package.json, default is package.json,
       tsconfig: 'tsconfig.json', // relative path to tsconfig.json, default is tsconfig.json
     }),

package/dist/index.d.mts

@@ -8,26 +8,48 @@ declare const coverage: {
     include: string[];
     provider: "v8";
 };
-interface Options {
+interface CommonOptions {
+    verbose: boolean;
+}
+interface TSConfigPathsOptions extends CommonOptions {
+    /** Path to the tsconfig file (relative to the project root). Defaults to `./tsconfig.json` */
+    tsconfig: string;
+}
+interface BundleOptions {
+    /** If `false`, all builtin modules will be externalized. Defaults to `false`. */
+    builtin: boolean;
+    /** If `false`, all dependencies will be externalized. Defaults to `false`. */
+    dependencies: boolean;
+    /** If `false`, all devDependencies will be externalized. Defaults to `true`. */
+    devDependencies: boolean;
+    /** If `false`, all dependencies will be externalized. Defaults to `false`. */
+    peerDependencies: boolean;
+    /** List of packages or modules to externalize. Defaults to `[]`. */
+    exclude: (string | RegExp)[];
+    /** List of packages or modules to bundle. Acts as an override and defaults to `[]`. */
+    include: (string | RegExp)[];
+    /** If `false`, all direct imports from `node_modules` will be externalized. Defaults to `false`. */
+    nodeModules: boolean;
+}
+interface LibraryOptions extends TSConfigPathsOptions {
     /** Defaults to `src/index.ts`. */
     entry: string;
-    externalPackages?: (string | RegExp)[];
+    /** Bundle configuration for packages and modules. See {@link BundleOptions} for defaults. */
+    bundle: Partial<BundleOptions>;
     /** Defaults to `['es']`. */
-    formats?: LibraryFormats[];
+    formats: LibraryFormats[];
     /** Defaults to `package.json`. */
     manifest: string;
     name?: string;
-    verbose?: boolean;
     /** Remove any temporary build files. Defaults to `true`. */
-    cleanup?: boolean;
-    /** Path to the tsconfig file (relative to the project root). Defaults to `./tsconfig.json` */
-    tsconfig: string;
+    cleanup: boolean;
 }
-declare function tsconfigPaths(options?: Partial<Options>): Plugin;
-declare function library(options?: Partial<Options>): Plugin[];
+declare function tsconfigPaths(options?: Partial<TSConfigPathsOptions>): Plugin;
+declare function library(options?: Partial<LibraryOptions>): Plugin[];
 /**
  * Remove any temporary `vite.config.ts.timestamp-*` files.
  */
-declare function cleanup(): Plugin;
+declare function cleanup(options?: Partial<CommonOptions>): Plugin;
 
-export { type Options, cleanup, coverage, library, tsconfigPaths };
+export { cleanup, coverage, library, tsconfigPaths };
+export type { BundleOptions, CommonOptions, LibraryOptions, TSConfigPathsOptions };

package/dist/index.d.ts

@@ -8,26 +8,48 @@ declare const coverage: {
     include: string[];
     provider: "v8";
 };
-interface Options {
+interface CommonOptions {
+    verbose: boolean;
+}
+interface TSConfigPathsOptions extends CommonOptions {
+    /** Path to the tsconfig file (relative to the project root). Defaults to `./tsconfig.json` */
+    tsconfig: string;
+}
+interface BundleOptions {
+    /** If `false`, all builtin modules will be externalized. Defaults to `false`. */
+    builtin: boolean;
+    /** If `false`, all dependencies will be externalized. Defaults to `false`. */
+    dependencies: boolean;
+    /** If `false`, all devDependencies will be externalized. Defaults to `true`. */
+    devDependencies: boolean;
+    /** If `false`, all dependencies will be externalized. Defaults to `false`. */
+    peerDependencies: boolean;
+    /** List of packages or modules to externalize. Defaults to `[]`. */
+    exclude: (string | RegExp)[];
+    /** List of packages or modules to bundle. Acts as an override and defaults to `[]`. */
+    include: (string | RegExp)[];
+    /** If `false`, all direct imports from `node_modules` will be externalized. Defaults to `false`. */
+    nodeModules: boolean;
+}
+interface LibraryOptions extends TSConfigPathsOptions {
     /** Defaults to `src/index.ts`. */
     entry: string;
-    externalPackages?: (string | RegExp)[];
+    /** Bundle configuration for packages and modules. See {@link BundleOptions} for defaults. */
+    bundle: Partial<BundleOptions>;
     /** Defaults to `['es']`. */
-    formats?: LibraryFormats[];
+    formats: LibraryFormats[];
     /** Defaults to `package.json`. */
     manifest: string;
     name?: string;
-    verbose?: boolean;
     /** Remove any temporary build files. Defaults to `true`. */
-    cleanup?: boolean;
-    /** Path to the tsconfig file (relative to the project root). Defaults to `./tsconfig.json` */
-    tsconfig: string;
+    cleanup: boolean;
 }
-declare function tsconfigPaths(options?: Partial<Options>): Plugin;
-declare function library(options?: Partial<Options>): Plugin[];
+declare function tsconfigPaths(options?: Partial<TSConfigPathsOptions>): Plugin;
+declare function library(options?: Partial<LibraryOptions>): Plugin[];
 /**
  * Remove any temporary `vite.config.ts.timestamp-*` files.
  */
-declare function cleanup(): Plugin;
+declare function cleanup(options?: Partial<CommonOptions>): Plugin;
 
-export { type Options, cleanup, coverage, library, tsconfigPaths };
+export { cleanup, coverage, library, tsconfigPaths };
+export type { BundleOptions, CommonOptions, LibraryOptions, TSConfigPathsOptions };

package/dist/index.mjs

@@ -104,21 +104,39 @@ const coverage = {
   include: ["src/**/*.*"],
   provider: "v8"
 };
-const defaults = {
+const COMMON_DEFAULTS = {
+  verbose: false
+};
+const TS_CONFIG_PATHS_OPTIONS = {
+  ...COMMON_DEFAULTS,
+  tsconfig: "./tsconfig.json"
+};
+const BUNDLE_DEFAULTS = {
+  builtin: false,
+  dependencies: false,
+  devDependencies: true,
+  peerDependencies: false,
+  exclude: [],
+  include: [],
+  nodeModules: false
+};
+const LIBRARY_DEFAULTS = {
+  ...TS_CONFIG_PATHS_OPTIONS,
+  cleanup: true,
   entry: "src/index.ts",
+  bundle: {},
   formats: ["es"],
-  manifest: "package.json",
-  cleanup: true,
-  tsconfig: "./tsconfig.json"
+  manifest: "package.json"
 };
 function mergeWithDefaults(options) {
   return {
-    ...defaults,
+    ...LIBRARY_DEFAULTS,
     ...options
   };
 }
 function tsconfigPaths(options = {}) {
-  const { verbose, tsconfig } = mergeWithDefaults(options);
+  const tsconfig = options.tsconfig ?? TS_CONFIG_PATHS_OPTIONS.tsconfig;
+  const verbose = options.verbose ?? TS_CONFIG_PATHS_OPTIONS.verbose;
   return {
     name: "vite-plugin-lib:alias",
     enforce: "pre",
@@ -150,10 +168,20 @@ function buildConfig({
   formats,
   manifest,
   name,
-  externalPackages
+  bundle,
+  verbose
 }) {
-  if (!externalPackages) {
-    log("Externalized all packages.");
+  const bundleWithDefaults = { ...BUNDLE_DEFAULTS, ...bundle };
+  const packagesToExternalize = [
+    ...getBuiltinModules(bundleWithDefaults),
+    ...getDependencies(manifest, bundleWithDefaults, verbose),
+    ...bundleWithDefaults.exclude
+  ];
+  if (!bundleWithDefaults.nodeModules) {
+    packagesToExternalize.push(/node_modules/);
+    if (verbose) {
+      log(`Externalized node_modules.`);
+    }
   }
   return {
     name: "vite-plugin-lib:build",
@@ -171,29 +199,60 @@ function buildConfig({
             fileName: (format) => formatToFileName(entry, format)
           },
           rollupOptions: {
-            external: externalPackages ?? [
-              /node_modules/,
-              ...builtinModules,
-              /node:/,
-              ...getDependencies(manifest)
-            ]
+            external: (source, _importer, _isResolved) => {
+              const shouldBeExternalized = packagesToExternalize.some((rule) => matchesRule(source, rule));
+              const shouldBeBundled = bundleWithDefaults.include.some((rule) => matchesRule(source, rule));
+              return shouldBeExternalized && !shouldBeBundled;
+            }
           }
         }
       };
     }
   };
 }
-function getDependencies(manifest) {
+function matchesRule(source, rule) {
+  return typeof rule === "string" ? rule === source : rule.test(source);
+}
+function getDependencies(manifest, bundle, verbose) {
   try {
     const content = readFileSync(manifest, { encoding: "utf-8" });
-    const { dependencies = {}, peerDependencies = {} } = JSON.parse(content);
-    return Object.keys({ ...dependencies, ...peerDependencies });
+    const { dependencies = {}, devDependencies = {}, peerDependencies = {} } = JSON.parse(content);
+    const dependenciesToExternalize = [];
+    if (!bundle.dependencies) {
+      const names = Object.keys(dependencies);
+      dependenciesToExternalize.push(...names);
+      if (verbose) {
+        log(`Externalized ${names.length} dependencies.`);
+      }
+    }
+    if (!bundle.devDependencies) {
+      const names = Object.keys(devDependencies);
+      dependenciesToExternalize.push(...names);
+      if (verbose) {
+        log(`Externalized ${names.length} devDependencies.`);
+      }
+    }
+    if (!bundle.peerDependencies) {
+      const names = Object.keys(peerDependencies);
+      dependenciesToExternalize.push(...names);
+      if (verbose) {
+        log(`Externalized ${names.length} peerDependencies.`);
+      }
+    }
+    return dependenciesToExternalize;
   } catch (error) {
     const message = getErrorMessage(error);
     logError(`Could not read ${c.green(manifest)}: ${message}`);
     throw error;
   }
 }
+function getBuiltinModules(bundle) {
+  if (bundle.builtin) {
+    return [];
+  }
+  log("Externalized builtin modules.");
+  return [...builtinModules, /node:/, /bun:/, /deno:/];
+}
 function logInjectedAliases(aliasOptions, config, verbose) {
   log(`Injected ${c.green(aliasOptions.length)} aliases.`);
   if (!verbose) {
@@ -201,7 +260,7 @@ function logInjectedAliases(aliasOptions, config, verbose) {
   }
   const base = `${path.resolve(config.root ?? ".")}/`;
   aliasOptions.map(
-    ({ find, replacement }) => `${c.gray(">")} ${c.green(find.toString())} ${c.gray(
+    ({ find, replacement }) => `  ${c.gray(">")} ${c.green(find.toString())} ${c.gray(
       c.bold("->")
     )} ${c.green(replacement.replace(base, ""))}`
   ).forEach(log);
@@ -287,7 +346,7 @@ function library(options = {}) {
     })
   ];
   if (mergedOptions.cleanup) {
-    plugins.push(cleanup());
+    plugins.push(cleanup(mergedOptions));
   }
   return plugins;
 }
@@ -326,7 +385,8 @@ function getErrorMessage(error) {
   const isObject = typeof error === "object" && error !== null && "message" in error;
   return isObject ? error.message : String(error);
 }
-function cleanup() {
+function cleanup(options = {}) {
+  const verbose = options.verbose ?? COMMON_DEFAULTS.verbose;
   return {
     name: "vite-plugin-lib:cleanup",
     enforce: "post",
@@ -339,7 +399,9 @@ function cleanup() {
         rmSync(`./${file}`);
         deletedCount++;
       });
-      log(`Removed ${deletedCount} temporary files.`);
+      if (verbose) {
+        log(`Removed ${deletedCount} temporary files.`);
+      }
     }
   };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-lib",
   "type": "module",
-  "version": "2.2.1",
+  "version": "3.0.1",
   "description": "Vite plugin for build configuration, automatic aliases, and type declarations.",
   "author": "Jan Müller <janmueller3698@gmail.com>",
   "license": "MIT",
@@ -36,18 +36,18 @@
   ],
   "peerDependencies": {
     "typescript": "*",
-    "vite": "^2.0.0 || ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0"
+    "vite": "2.0.0 || ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0"
   },
   "dependencies": {
     "picocolors": "1.1.1",
-    "vite-plugin-dts": "4.5.3"
+    "vite-plugin-dts": "4.5.4"
   },
   "devDependencies": {
-    "@types/node": "22.14.1",
+    "@types/node": "22.15.29",
     "typescript": "5.8.3",
     "unbuild": "3.5.0",
-    "vite": "6.2.6",
-    "@yeger/tsconfig": "2.1.0"
+    "vite": "6.3.5",
+    "@yeger/tsconfig": "2.1.1"
   },
   "publishConfig": {
     "access": "public"