vite-plugin-lib 1.4.0 → 2.0.0

package/README.md

@@ -44,10 +44,11 @@ import { library } from 'vite-plugin-lib'
 export default defineConfig({
   plugins: [
     library({
-      entry: 'src/index.ts', // file name determines output file names
-      formats: ['es', 'umd'], // optional, default is ['es', 'umd']
-      name: 'YourGlobalUMDName',
+      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
+      manifest: 'package.json', // relative path to package.json, default is package.json
     }),
   ],
 })

package/dist/index.d.mts

@@ -2,14 +2,24 @@ import { LibraryFormats, Plugin } from 'vite';
 import * as vitePluginDts from 'vite-plugin-dts';
 export { vitePluginDts as dts };
 
+declare const coverage: {
+    enabled: boolean;
+    all: boolean;
+    include: string[];
+    provider: "v8";
+};
 interface Options {
-    name: string;
+    /** Defaults to 'src/index.ts' */
     entry: string;
-    formats?: LibraryFormats[];
     externalPackages?: (string | RegExp)[];
+    /** Defaults to ['es'] */
+    formats?: LibraryFormats[];
+    /** Defaults to 'package.json' */
+    manifest: string;
+    name?: string;
     verbose?: boolean;
 }
-declare function tsconfigPaths({ verbose }?: Partial<Options>): Plugin;
-declare function library(options: Options): Plugin[];
+declare function tsconfigPaths(options?: Partial<Options>): Plugin;
+declare function library(options?: Partial<Options>): Plugin[];
 
-export { Options, library, tsconfigPaths };
+export { type Options, coverage, library, tsconfigPaths };

package/dist/index.d.ts

@@ -2,14 +2,24 @@ import { LibraryFormats, Plugin } from 'vite';
 import * as vitePluginDts from 'vite-plugin-dts';
 export { vitePluginDts as dts };
 
+declare const coverage: {
+    enabled: boolean;
+    all: boolean;
+    include: string[];
+    provider: "v8";
+};
 interface Options {
-    name: string;
+    /** Defaults to 'src/index.ts' */
     entry: string;
-    formats?: LibraryFormats[];
     externalPackages?: (string | RegExp)[];
+    /** Defaults to ['es'] */
+    formats?: LibraryFormats[];
+    /** Defaults to 'package.json' */
+    manifest: string;
+    name?: string;
     verbose?: boolean;
 }
-declare function tsconfigPaths({ verbose }?: Partial<Options>): Plugin;
-declare function library(options: Options): Plugin[];
+declare function tsconfigPaths(options?: Partial<Options>): Plugin;
+declare function library(options?: Partial<Options>): Plugin[];
 
-export { Options, library, tsconfigPaths };
+export { type Options, coverage, library, tsconfigPaths };

package/dist/index.mjs

@@ -1,7 +1,8 @@
-import { existsSync } from 'node:fs';
-import { readdir, readFile, writeFile } from 'node:fs/promises';
+import { existsSync, readFileSync } from 'node:fs';
+import { unlink, readdir, readFile, writeFile } from 'node:fs/promises';
 import { builtinModules } from 'node:module';
 import path from 'node:path';
+import process from 'node:process';
 import c from 'picocolors';
 import ts from 'typescript';
 import dts__default from 'vite-plugin-dts';
@@ -19,10 +20,13 @@ function logError(text) {
   console.error(`${c.red("[vite:lib]")} ${text}`);
 }
 
-async function generateMTSDeclarations(typesDir) {
+async function generateMTSDeclarations(typesDir, deleteSourceFiles) {
   const files = await collectFiles(typesDir);
   for (const file of files) {
     await createMTSImports(file);
+    if (deleteSourceFiles) {
+      unlink(file);
+    }
   }
   log(`Generated ${files.length} MTS declarations.`);
 }
@@ -41,24 +45,70 @@ async function collectFiles(dir) {
 async function createMTSImports(file) {
   const content = await readFile(file, "utf-8");
   const lines = content.split("\n");
-  const modified = lines.map(transformLine);
+  const modified = lines.map((line) => transformLine(file, line));
   const targetFile = file.replace(".d.ts", ".d.mts");
   await writeFile(targetFile, modified.join("\n"));
 }
-function transformLine(line) {
-  const isStaticImport = line.includes("import ") && line.includes(`from '.`);
-  if (isStaticImport) {
-    return `${line.substring(0, line.length - 2)}.d.mts';`;
+function transformLine(file, line) {
+  return transformStaticImport(file, line, "'") ?? transformStaticImport(file, line, '"') ?? transformExport(file, line, "'") ?? transformExport(file, line, '"') ?? line;
+}
+function transformStaticImport(file, line, quote) {
+  const importPathMarker = `from ${quote}`;
+  const isStaticImport = line.includes("import ") && line.includes(`${importPathMarker}.`);
+  if (!isStaticImport) {
+    return void 0;
+  }
+  const importStartIndex = line.lastIndexOf(importPathMarker);
+  const importPath = line.substring(
+    importStartIndex + importPathMarker.length,
+    line.length - 2
+  );
+  const resolvedImport = path.resolve(path.dirname(file), importPath);
+  if (existsSync(resolvedImport)) {
+    log(`got index import ${resolvedImport}`);
+    return `${line.substring(0, line.length - 2)}/index.mjs${quote};`;
+  }
+  return `${line.substring(0, line.length - 2)}.mjs${quote};`;
+}
+function transformExport(file, line, quote) {
+  const exportPathMarker = ` from ${quote}`;
+  const isStaticExport = line.includes("export ") && line.includes(`${exportPathMarker}.`);
+  if (!isStaticExport) {
+    return void 0;
   }
-  const isStaticExport = line.includes("export ") && line.includes(` from '.`);
-  if (isStaticExport) {
-    return `${line.substring(0, line.length - 2)}.mjs';`;
+  const exportStartIndex = line.lastIndexOf(exportPathMarker);
+  const exportPath = line.substring(
+    exportStartIndex + exportPathMarker.length,
+    line.length - 2
+  );
+  const resolvedExport = path.resolve(path.dirname(file), exportPath);
+  if (existsSync(resolvedExport)) {
+    log(`got index export ${resolvedExport}`);
+    return `${line.substring(0, line.length - 2)}/index.mjs${quote};`;
   }
-  return line;
+  return `${line.substring(0, line.length - 2)}.mjs${quote};`;
 }
 
 const typesDir = "dist/types";
-function tsconfigPaths({ verbose } = {}) {
+const coverage = {
+  enabled: !!process.env.COVERAGE,
+  all: true,
+  include: ["src/**/*.*"],
+  provider: "v8"
+};
+const defaults = {
+  entry: "src/index.ts",
+  formats: ["es"],
+  manifest: "package.json"
+};
+function mergeWithDefaults(options) {
+  return {
+    ...defaults,
+    ...options
+  };
+}
+function tsconfigPaths(options = {}) {
+  const { verbose } = mergeWithDefaults(options);
   return {
     name: "vite-plugin-lib:alias",
     enforce: "pre",
@@ -88,6 +138,7 @@ function tsconfigPaths({ verbose } = {}) {
 function buildConfig({
   entry,
   formats,
+  manifest,
   name,
   externalPackages
 }) {
@@ -110,13 +161,28 @@ function buildConfig({
             fileName: (format) => formatToFileName(entry, format)
           },
           rollupOptions: {
-            external: externalPackages ?? [/node_modules/, ...builtinModules]
+            external: externalPackages ?? [
+              /node_modules/,
+              ...builtinModules,
+              ...getDependencies(manifest)
+            ]
           }
         }
       };
     }
   };
 }
+function getDependencies(manifest) {
+  try {
+    const content = readFileSync(manifest, { encoding: "utf-8" });
+    const { dependencies = {} } = JSON.parse(content);
+    return Object.keys(dependencies);
+  } catch (error) {
+    const message = getErrorMessage(error);
+    logError(`Could not read ${c.green(manifest)}: ${message}`);
+    throw error;
+  }
+}
 function logInjectedAliases(aliasOptions, config, verbose) {
   log(`Injected ${c.green(aliasOptions.length)} aliases.`);
   if (!verbose) {
@@ -188,17 +254,18 @@ function formatToFileName(entry, format) {
   }
   return `${entryFileName}.${format}.js`;
 }
-function library(options) {
+function library(options = {}) {
+  const mergedOptions = mergeWithDefaults(options);
   return [
     tsconfigPaths(),
-    buildConfig(options),
+    buildConfig(mergedOptions),
     dts__default({
       cleanVueFileName: true,
       copyDtsFiles: true,
-      include: `${path.resolve(options.entry, "..")}/**`,
+      include: `${path.resolve(mergedOptions.entry, "..")}/**`,
       outDir: typesDir,
       staticImport: true,
-      afterBuild: includesESFormat(options.formats) ? () => generateMTSDeclarations(typesDir) : void 0
+      afterBuild: includesESFormat(options.formats) ? () => generateMTSDeclarations(typesDir, options.formats?.length === 1) : void 0
     })
   ];
 }
@@ -242,4 +309,4 @@ function getErrorMessage(error) {
   return isObject ? error.message : String(error);
 }
 
-export { library, tsconfigPaths };
+export { coverage, library, tsconfigPaths };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-lib",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "Vite plugin for build configuration, automatic aliases, and type declarations.",
   "author": "Jan Müller <janmueller3698@gmail.com>",
   "license": "MIT",
@@ -18,19 +18,13 @@
   ],
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
-      },
       "import": {
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       }
     }
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
+  "types": "dist/index.d.mts",
   "files": [
     "dist",
     "LICENSE"
@@ -41,14 +35,14 @@
   },
   "dependencies": {
     "picocolors": "1.0.0",
-    "vite-plugin-dts": "3.3.1"
+    "vite-plugin-dts": "3.5.2"
   },
   "devDependencies": {
-    "@types/node": "18.17.1",
-    "typescript": "5.1.6",
-    "unbuild": "v2.0.0-rc.0",
-    "vite": "4.4.7",
-    "@yeger/tsconfig": "1.1.2"
+    "@types/node": "18.17.11",
+    "typescript": "5.2.2",
+    "unbuild": "2.0.0",
+    "vite": "4.4.9",
+    "@yeger/tsconfig": "2.0.0"
   },
   "publishConfig": {
     "access": "public"

package/dist/index.cjs

@@ -1,267 +0,0 @@
-'use strict';
-
-const node_fs = require('node:fs');
-const promises = require('node:fs/promises');
-const node_module = require('node:module');
-const path = require('node:path');
-const c = require('picocolors');
-const ts = require('typescript');
-const dts = require('vite-plugin-dts');
-const vite = require('vite');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
-
-function _interopNamespaceCompat(e) {
-  if (e && typeof e === 'object' && 'default' in e) return e;
-  const n = Object.create(null);
-  if (e) {
-    for (const k in e) {
-      n[k] = e[k];
-    }
-  }
-  n.default = e;
-  return n;
-}
-
-const path__default = /*#__PURE__*/_interopDefaultCompat(path);
-const c__default = /*#__PURE__*/_interopDefaultCompat(c);
-const ts__default = /*#__PURE__*/_interopDefaultCompat(ts);
-const dts__default = /*#__PURE__*/_interopDefaultCompat(dts);
-const dts__namespace = /*#__PURE__*/_interopNamespaceCompat(dts);
-
-function log(text) {
-  console.log(`${c__default.cyan("[vite:lib]")} ${text}`);
-}
-function logWarn(text) {
-  console.warn(`${c__default.yellow("[vite:lib]")} ${text}`);
-}
-function logError(text) {
-  console.error(`${c__default.red("[vite:lib]")} ${text}`);
-}
-
-async function generateMTSDeclarations(typesDir) {
-  const files = await collectFiles(typesDir);
-  for (const file of files) {
-    await createMTSImports(file);
-  }
-  log(`Generated ${files.length} MTS declarations.`);
-}
-async function collectFiles(dir) {
-  const entries = await promises.readdir(dir, {
-    recursive: false,
-    // does not provide full path to nested files
-    withFileTypes: true
-  });
-  const files = entries.filter((entry) => entry.isFile());
-  const nestedFiles = await Promise.all(
-    entries.filter((entry) => entry.isDirectory()).map((entry) => collectFiles(vite.normalizePath(path__default.join(dir, entry.name))))
-  );
-  return files.map((file) => vite.normalizePath(path__default.join(dir, file.name))).concat(...nestedFiles);
-}
-async function createMTSImports(file) {
-  const content = await promises.readFile(file, "utf-8");
-  const lines = content.split("\n");
-  const modified = lines.map(transformLine);
-  const targetFile = file.replace(".d.ts", ".d.mts");
-  await promises.writeFile(targetFile, modified.join("\n"));
-}
-function transformLine(line) {
-  const isStaticImport = line.includes("import ") && line.includes(`from '.`);
-  if (isStaticImport) {
-    return `${line.substring(0, line.length - 2)}.d.mts';`;
-  }
-  const isStaticExport = line.includes("export ") && line.includes(` from '.`);
-  if (isStaticExport) {
-    return `${line.substring(0, line.length - 2)}.mjs';`;
-  }
-  return line;
-}
-
-const typesDir = "dist/types";
-function tsconfigPaths({ verbose } = {}) {
-  return {
-    name: "vite-plugin-lib:alias",
-    enforce: "pre",
-    config: async (config) => {
-      const tsconfigPath = path__default.resolve(config.root ?? ".", "tsconfig.json");
-      const { baseUrl, paths } = await readConfig(tsconfigPath);
-      if (!baseUrl || !paths) {
-        log("No paths found in tsconfig.json.");
-        return config;
-      }
-      const pathToAlias = pathToAliasFactory(tsconfigPath, baseUrl, verbose);
-      const aliasOptions = Object.entries(paths).map(pathToAlias).filter(Boolean);
-      if (aliasOptions.length > 0) {
-        logInjectedAliases(aliasOptions, config, verbose);
-      }
-      const existingAlias = transformExistingAlias(config.resolve?.alias);
-      return {
-        ...config,
-        resolve: {
-          ...config.resolve,
-          alias: [...existingAlias, ...aliasOptions]
-        }
-      };
-    }
-  };
-}
-function buildConfig({
-  entry,
-  formats,
-  name,
-  externalPackages
-}) {
-  if (!externalPackages) {
-    log("Externalized all packages.");
-  }
-  return {
-    name: "vite-plugin-lib:build",
-    enforce: "pre",
-    config: async (config) => {
-      return {
-        ...config,
-        build: {
-          ...config.build,
-          lib: {
-            ...config.build?.lib,
-            entry: path__default.resolve(config.root ?? ".", entry),
-            formats,
-            name,
-            fileName: (format) => formatToFileName(entry, format)
-          },
-          rollupOptions: {
-            external: externalPackages ?? [/node_modules/, ...node_module.builtinModules]
-          }
-        }
-      };
-    }
-  };
-}
-function logInjectedAliases(aliasOptions, config, verbose) {
-  log(`Injected ${c__default.green(aliasOptions.length)} aliases.`);
-  if (!verbose) {
-    return;
-  }
-  const base = `${path__default.resolve(config.root ?? ".")}/`;
-  aliasOptions.map(
-    ({ find, replacement }) => `${c__default.gray(">")} ${c__default.green(find.toString())} ${c__default.gray(
-      c__default.bold("->")
-    )} ${c__default.green(replacement.replace(base, ""))}`
-  ).forEach(log);
-}
-function pathToAliasFactory(tsconfigPath, baseUrl, verbose) {
-  return ([alias, replacements]) => {
-    if (replacements.length === 0) {
-      if (verbose) {
-        logWarn(`No replacements for alias ${c__default.green(alias)}.`);
-      }
-      return void 0;
-    }
-    if (verbose && replacements.length > 1) {
-      logWarn(`Found more than one replacement for alias ${c__default.green(alias)}.`);
-      logWarn("Using the first existing replacement.");
-    }
-    const find = alias.replace("/*", "");
-    const replacement = getFirstExistingReplacement(
-      tsconfigPath,
-      baseUrl,
-      replacements,
-      find
-    );
-    if (!replacement) {
-      if (verbose) {
-        logWarn(`No replacement found for alias ${c__default.green(alias)}.`);
-      }
-      return void 0;
-    }
-    return {
-      find,
-      replacement
-    };
-  };
-}
-function getFirstExistingReplacement(tsconfigPath, baseUrl, replacements, find, verbose) {
-  for (const replacement of replacements) {
-    const resolvedReplacement = path__default.resolve(
-      tsconfigPath,
-      baseUrl,
-      replacement.replace("/*", "") ?? find
-    );
-    if (node_fs.existsSync(resolvedReplacement)) {
-      return resolvedReplacement;
-    } else if (verbose) {
-      logWarn(`Path ${c__default.green(replacement)} does not exist.`);
-    }
-  }
-  return void 0;
-}
-function formatToFileName(entry, format) {
-  const entryFileName = entry.substring(
-    entry.lastIndexOf("/") + 1,
-    entry.lastIndexOf(".")
-  );
-  if (format === "es") {
-    return `${entryFileName}.mjs`;
-  }
-  if (format === "cjs") {
-    return `${entryFileName}.cjs`;
-  }
-  return `${entryFileName}.${format}.js`;
-}
-function library(options) {
-  return [
-    tsconfigPaths(),
-    buildConfig(options),
-    dts__default({
-      cleanVueFileName: true,
-      copyDtsFiles: true,
-      include: `${path__default.resolve(options.entry, "..")}/**`,
-      outDir: typesDir,
-      staticImport: true,
-      afterBuild: includesESFormat(options.formats) ? () => generateMTSDeclarations(typesDir) : void 0
-    })
-  ];
-}
-function transformExistingAlias(alias) {
-  if (!alias) {
-    return [];
-  }
-  if (Array.isArray(alias)) {
-    return alias;
-  }
-  return Object.entries(alias).map(([find, replacement]) => ({
-    find,
-    replacement
-  }));
-}
-async function readConfig(configPath) {
-  try {
-    const configFileText = await promises.readFile(configPath, { encoding: "utf-8" });
-    const { config } = ts__default.parseConfigFileTextToJson(configPath, configFileText);
-    if (!("baseUrl" in config?.compilerOptions)) {
-      throw new Error("No baseUrl provided in tsconfig.json.");
-    }
-    const { options } = ts__default.parseJsonConfigFileContent(
-      config,
-      // eslint-disable-next-line import/no-named-as-default-member
-      ts__default.sys,
-      path__default.dirname(configPath)
-    );
-    return options;
-  } catch (error) {
-    const message = getErrorMessage(error);
-    logError(`Could not read tsconfig.json: ${message}`);
-    throw error;
-  }
-}
-function includesESFormat(formats) {
-  return formats?.includes("es") ?? true;
-}
-function getErrorMessage(error) {
-  const isObject = typeof error === "object" && error !== null && "message" in error;
-  return isObject ? error.message : String(error);
-}
-
-exports.dts = dts__namespace;
-exports.library = library;
-exports.tsconfigPaths = tsconfigPaths;

package/dist/index.d.cts

@@ -1,15 +0,0 @@
-import { LibraryFormats, Plugin } from 'vite';
-import * as vitePluginDts from 'vite-plugin-dts';
-export { vitePluginDts as dts };
-
-interface Options {
-    name: string;
-    entry: string;
-    formats?: LibraryFormats[];
-    externalPackages?: (string | RegExp)[];
-    verbose?: boolean;
-}
-declare function tsconfigPaths({ verbose }?: Partial<Options>): Plugin;
-declare function library(options: Options): Plugin[];
-
-export { Options, library, tsconfigPaths };