dtsroll 1.2.0 → 1.4.0

package/README.md

@@ -1,4 +1,10 @@
-# dtsroll
+<p align="center">
+    <img width="150" src="./.github/logo.webp">
+</p>
+
+<h2 align="center">
+dtsroll
+</h2>
 
 _dtsroll_ is a CLI tool for bundling TypeScript declaration (`.d.ts`) files.
 
@@ -16,6 +22,11 @@ _dtsroll_ is a CLI tool for bundling TypeScript declaration (`.d.ts`) files.
 
 	Flattens multiple files into one, reducing TypeScript's file resolution for type checking.
 
+<p align="center">
+    <img width="600" src="./.github/screenshot.webp">
+</p>
+
+
 ## Install
 ```
 npm install --save-dev dtsroll
@@ -82,6 +93,13 @@ To fix this, _dtsroll_ will display a warning suggesting you move the `@types/*`
 
 ## CLI
 
+### Usage
+```sh
+dtsroll [-flags] [...entry dts files]
+```
+
+The default usage is to run `dtsroll` without any flags/arguments in a directory containing a `package.json` file. This allows the configuration to be inferred automatically.
+
 ### --help, -h
 Display usage instructions.
 

package/dist/cli.mjs

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 import { cli } from 'cleye';
-import { b as bgYellow, a as black, d as dtsroll } from './index--BBQtOEp.mjs';
-import { l as logOutput } from './log-output-CwMUFOmQ.mjs';
+import { b as bgYellow, a as black, d as dtsroll, l as logOutput } from './index-BR0PvbQA.mjs';
 import 'node:path';
 import 'node:fs/promises';
 import 'rollup';
@@ -10,7 +9,7 @@ import '@rollup/plugin-node-resolve';
 import 'byte-size';
 
 var name = "dtsroll";
-var version = "1.2.0";
+var version = "1.4.0";
 var description = "Bundle dts files";
 
 const argv = cli({

package/dist/{index--BBQtOEp.mjs → index-BR0PvbQA.mjs}

@@ -3,6 +3,7 @@ import fs from 'node:fs/promises';
 import { rollup } from 'rollup';
 import { dts } from 'rollup-plugin-dts';
 import nodeResolve from '@rollup/plugin-node-resolve';
+import byteSize from 'byte-size';
 
 let enabled = true;
 // Support both browser and node environments
@@ -90,8 +91,116 @@ const magenta = kolorist(35, 39);
 const lightYellow = kolorist(93, 39);
 const bgYellow = kolorist(43, 49);
 
-const dtsExtension = ".d.ts";
+const cwd = process.cwd();
+
+const isPath = (filePath) => filePath[0] === "." || path.isAbsolute(filePath);
+const normalizePath = (filepath) => filepath.replaceAll("\\", "/");
+
 const warningSignUnicode = "\u26A0";
+const warningPrefix = yellow("Warning:");
+const logOutput = (dtsOutput) => {
+  console.log(underline("dtsroll"));
+  const { inputs } = dtsOutput;
+  const isCliInput = inputs[0]?.[1] === void 0;
+  console.log(bold(`
+\u{1F4E5} Entry points${isCliInput ? "" : " in package.json"}`));
+  console.log(
+    inputs.map(([inputFile, inputSource, error]) => {
+      const relativeInputFile = path.relative(cwd, inputFile);
+      const logPath2 = normalizePath(
+        relativeInputFile.length < inputFile.length ? relativeInputFile : inputFile
+      );
+      if (error) {
+        return ` ${lightYellow(`${warningSignUnicode} ${logPath2} ${dim(error)}`)}`;
+      }
+      return ` \u2192 ${green(logPath2)}${inputSource ? ` ${dim(`from ${inputSource}`)}` : ""}`;
+    }).join("\n")
+  );
+  if ("error" in dtsOutput) {
+    console.error(`${red("Error:")} ${dtsOutput.error}`);
+    return;
+  }
+  const {
+    outputDirectory,
+    output: {
+      entries: outputEntries,
+      chunks: outputChunks
+    },
+    size,
+    externals
+  } = dtsOutput;
+  const outputDirectoryRelative = path.relative(cwd, outputDirectory);
+  const logPath = `${normalizePath(
+    outputDirectoryRelative.length < outputDirectory.length ? outputDirectoryRelative : outputDirectory
+  )}/`;
+  const logChunk = ({
+    file,
+    indent,
+    bullet,
+    color
+  }) => {
+    const sizeFormatted = byteSize(file.size).toString();
+    let log = `${indent}${bullet} ${dim(color(logPath))}${color(file.fileName)} ${sizeFormatted}`;
+    const { moduleIds, moduleToPackage } = file;
+    log += `
+${moduleIds.sort().map((moduleId, index) => {
+      const isLast = index === moduleIds.length - 1;
+      const prefix = `${indent}   ${isLast ? "\u2514\u2500 " : "\u251C\u2500 "}`;
+      const relativeModuleId = path.relative(cwd, moduleId);
+      const logModuleId = normalizePath(
+        relativeModuleId.length < moduleId.length ? relativeModuleId : moduleId
+      );
+      const bareSpecifier = moduleToPackage[moduleId];
+      if (bareSpecifier) {
+        return `${prefix}${dim(`${magenta(bareSpecifier)} (${logModuleId})`)}`;
+      }
+      return `${prefix}${dim(logModuleId)}`;
+    }).join("\n")}`;
+    return log;
+  };
+  console.log(bold("\n\u{1F4A0} Bundled output"));
+  console.log(
+    outputEntries.map((file) => logChunk({
+      file,
+      indent: " ",
+      bullet: "\u25CF",
+      color: green
+    })).join("\n\n")
+  );
+  if (outputChunks.length > 0) {
+    console.log(bold("\n Chunks"));
+    console.log(
+      outputChunks.map((file) => logChunk({
+        file,
+        indent: "   ",
+        bullet: "\u25A0",
+        color: yellow
+      })).join("\n\n")
+    );
+  }
+  console.log(bold("\n\u2696\uFE0F Size savings"));
+  const difference = size.input - size.output;
+  const direction = difference > 0 ? "decrease" : "increase";
+  const percentage = (Math.abs(difference / size.input) * 100).toFixed(0);
+  console.log(`   Input source size:   ${byteSize(size.input).toString()}`);
+  console.log(`   Bundled output size: ${byteSize(size.output).toString()}${difference === 0 ? "" : ` (${percentage}% ${direction})`}`);
+  if (externals.length > 0) {
+    console.log(bold("\n\u{1F4E6} External packages"));
+    console.log(
+      externals.map(([packageName, reason, devTypePackage]) => {
+        let stdout = ` \u2500 ${magenta(packageName)} ${dim(`externalized ${reason}`)}`;
+        if (devTypePackage) {
+          stdout += `
+   ${warningPrefix} ${magenta(devTypePackage)} should not be in devDependencies if ${magenta(packageName)} is externalized`;
+        }
+        return stdout;
+      }).sort().join("\n")
+    );
+  }
+};
+
+const dtsExtensions = [".d.ts", ".d.cts", ".d.mts"];
+const isDts = (fileName) => dtsExtensions.some((extension) => fileName.endsWith(extension));
 
 const isValidIdentifier = /^[$_\p{ID_Start}][$\u200C\u200D\p{ID_Continue}]*$/u;
 const reservedWords = /* @__PURE__ */ new Set([
@@ -182,14 +291,44 @@ const getPackageName = (id) => {
   return id.slice(0, indexOfSlash);
 };
 
+const getAllFiles = async (directoryPath, dontShortenPath) => {
+  const directoryFiles = await fs.readdir(directoryPath, { withFileTypes: true });
+  const fileTree = await Promise.all(
+    directoryFiles.map(async (entry) => {
+      const filePath = path.join(directoryPath, entry.name);
+      if (entry.isDirectory()) {
+        const files = await getAllFiles(filePath, true);
+        return dontShortenPath ? files : files.map((file) => `./${path.relative(directoryPath, file)}`);
+      }
+      return dontShortenPath ? filePath : `./${path.relative(directoryPath, filePath)}`;
+    })
+  );
+  return fileTree.flat();
+};
+
 const readPackageJson = async (filePath) => {
   const packageJsonString = await fs.readFile(filePath, "utf8");
   return JSON.parse(packageJsonString);
 };
-const getDtsEntryPoints = (packageJson, packageJsonDirectory) => {
+const traverseExports = (exportValue, propertyPath) => {
+  if (typeof exportValue === "string") {
+    return [[exportValue, propertyPath]];
+  }
+  if (Array.isArray(exportValue)) {
+    return exportValue.flatMap((value, index) => traverseExports(value, `${propertyPath}[${index}]`));
+  }
+  if (typeof exportValue === "object" && exportValue !== null) {
+    return Object.entries(exportValue).flatMap(([property, value]) => {
+      const newProperty = propertyNeedsQuotes(property) ? `["${property}"]` : `.${property}`;
+      return traverseExports(value, propertyPath + newProperty);
+    });
+  }
+  return [];
+};
+const getDtsEntryPoints = async (packageJson, packageJsonDirectory) => {
   const entryPoints = {};
   const addEntry = (subpath, from) => {
-    if (!subpath.endsWith(dtsExtension)) {
+    if (!isDts(subpath)) {
       return;
     }
     const entryPath = path.join(packageJsonDirectory, subpath);
@@ -204,19 +343,23 @@ const getDtsEntryPoints = (packageJson, packageJsonDirectory) => {
     addEntry(packageJson.typings, "typings");
   }
   if (packageJson.exports) {
-    (function gather(exportValue, propertyPath) {
-      if (typeof exportValue === "string") {
-        addEntry(exportValue, propertyPath);
-      } else if (Array.isArray(exportValue)) {
-        exportValue.forEach((value, index) => gather(value, `${propertyPath}[${index}]`));
+    const subpaths = traverseExports(packageJson.exports, "exports");
+    let packageFiles;
+    for (const [subpath, fromProperty] of subpaths) {
+      if (!subpath.includes("*")) {
+        addEntry(subpath, fromProperty);
+        continue;
+      }
+      if (!packageFiles) {
+        packageFiles = await getAllFiles(packageJsonDirectory);
       }
-      if (typeof exportValue === "object" && exportValue) {
-        for (const [property, value] of Object.entries(exportValue)) {
-          const newProperty = propertyNeedsQuotes(property) ? `["${property}"]` : `.${property}`;
-          gather(value, propertyPath + newProperty);
+      const [prefix, suffix] = subpath.split("*", 2);
+      for (const file of packageFiles) {
+        if (file.startsWith(prefix) && file.endsWith(suffix)) {
+          addEntry(file, fromProperty);
         }
       }
-    })(packageJson.exports, "exports");
+    }
   }
   return entryPoints;
 };
@@ -282,8 +425,7 @@ const validateInput = async (inputFiles) => {
   const inputNormalized = isCliInput ? inputFiles.map((i) => [i]) : Object.entries(inputFiles);
   return await Promise.all(inputNormalized.map(
     async ([inputFile, inputSource]) => {
-      const notDts = !inputFile.endsWith(dtsExtension);
-      if (notDts) {
+      if (!isDts(inputFile)) {
         return [inputFile, inputSource, "Ignoring non-d.ts input"];
       }
       const exists = await pathExists(inputFile);
@@ -295,8 +437,6 @@ const validateInput = async (inputFiles) => {
   ));
 };
 
-const isPath = ([firstCharacter]) => firstCharacter === "." || firstCharacter === path.sep;
-
 const createExternalizePlugin = (configuredExternals) => {
   const resolvedBareSpecifiers = /* @__PURE__ */ new Map();
   const importPath = /* @__PURE__ */ new Map();
@@ -330,11 +470,11 @@ const createExternalizePlugin = (configuredExternals) => {
       }
       if (packageName) {
         externalized.set(packageName, "because unresolvable");
+        return {
+          id,
+          external: true
+        };
       }
-      return {
-        id,
-        external: true
-      };
     }
   };
   const getPackageEntryPoint = (subpackagePath) => {
@@ -371,17 +511,15 @@ const removeBundledModulesPlugin = (outputDirectory, sizeRef) => {
     },
     async generateBundle(options, bundle) {
       const modules = Object.values(bundle);
-      const bundledSourceFiles = Array.from(new Set(
-        modules.flatMap(({ moduleIds }) => moduleIds).filter((moduleId) => (
-          // To avoid deleting files from symlinked dependencies
-          moduleId.startsWith(outputDirectory) && !moduleId.includes(nodeModules)
-        ))
-      ));
-      const fileSizes = bundledSourceFiles.map((moduleId) => this.getModuleInfo(moduleId).meta);
+      const bundledFiles = Array.from(new Set(modules.flatMap(({ moduleIds }) => moduleIds)));
+      const fileSizes = bundledFiles.map((moduleId) => this.getModuleInfo(moduleId).meta);
       const totalSize = fileSizes.reduce((total, { size }) => total + size, 0);
       sizeRef.value = totalSize;
       const outputFiles = new Set(modules.map(({ fileName }) => path.join(options.dir, fileName)));
-      deleteFiles = bundledSourceFiles.filter((moduleId) => !outputFiles.has(moduleId));
+      deleteFiles = bundledFiles.filter((moduleId) => (
+        // To avoid deleting files from symlinked dependencies
+        moduleId.startsWith(outputDirectory) && !moduleId.includes(nodeModules) && !outputFiles.has(moduleId)
+      ));
     },
     writeBundle: async () => {
       await Promise.all(
@@ -393,7 +531,7 @@ const removeBundledModulesPlugin = (outputDirectory, sizeRef) => {
 
 const createInputMap = (input, outputDirectory) => Object.fromEntries(
   input.map((inputFile) => [
-    inputFile.slice(outputDirectory.length + 1).slice(0, -dtsExtension.length),
+    inputFile.slice(outputDirectory.length + 1),
     inputFile
   ])
 );
@@ -409,13 +547,14 @@ const build = async (input, outputDirectory, externals, mode, conditions) => {
     output: {
       // sourcemap: true,
       dir: outputDirectory,
+      entryFileNames: "[name]",
       chunkFileNames: "_dtsroll-chunks/[name].ts"
     },
     plugins: [
       externalizePlugin,
       removeBundledModulesPlugin(outputDirectory, sizeRef),
       nodeResolve({
-        extensions: [".ts", dtsExtension],
+        extensions: [".ts", ...dtsExtensions],
         exportConditions: conditions
       }),
       dts({
@@ -452,7 +591,7 @@ const dtsroll = async ({
   const externals = pkgJson ? pkgJson.getExternals() : /* @__PURE__ */ new Map();
   if (external && external.length > 0) {
     if (pkgJson) {
-      console.warn(`${yellow("Warning:")} The --external flag is only supported when there is no package.json`);
+      console.warn(`${warningPrefix} The --external flag is only supported when there is no package.json`);
     } else {
       for (const externalDependency of external) {
         externals.set(externalDependency, "by --external flag");
@@ -461,7 +600,7 @@ const dtsroll = async ({
   }
   const manualInput = inputs && inputs.length > 0;
   const validatedInputs = await validateInput(
-    manualInput ? inputs.map((file) => path.resolve(file)) : pkgJson?.getDtsEntryPoints()
+    manualInput ? inputs.map((file) => path.resolve(file)) : await pkgJson?.getDtsEntryPoints()
   );
   const inputFiles = validatedInputs.filter((input) => !input[2]).map(([file]) => file);
   if (inputFiles.length === 0) {
@@ -532,4 +671,4 @@ const dtsroll = async ({
   };
 };
 
-export { black as a, bgYellow as b, bold as c, dtsroll as d, dim as e, green as g, lightYellow as l, magenta as m, red as r, underline as u, warningSignUnicode as w, yellow as y };
+export { black as a, bgYellow as b, dtsroll as d, logOutput as l };

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import 'node:path';
-export { d as dtsroll } from './index--BBQtOEp.mjs';
+export { d as dtsroll } from './index-BR0PvbQA.mjs';
 import 'node:fs/promises';
 import 'rollup';
 import 'rollup-plugin-dts';
 import '@rollup/plugin-node-resolve';
+import 'byte-size';

package/dist/vite.mjs

@@ -1,21 +1,22 @@
-import { l as logOutput } from './log-output-CwMUFOmQ.mjs';
-import { d as dtsroll } from './index--BBQtOEp.mjs';
+import { d as dtsroll, l as logOutput } from './index-BR0PvbQA.mjs';
 import 'node:path';
-import 'byte-size';
 import 'node:fs/promises';
 import 'rollup';
 import 'rollup-plugin-dts';
 import '@rollup/plugin-node-resolve';
+import 'byte-size';
 
 const dtsrollPlugin = (options) => {
   let built = false;
   let cwd;
+  let noLog = false;
   return {
     name: "dtsroll",
     apply: "build",
     enforce: "post",
-    config: ({ root }) => {
+    config: ({ root, logLevel }) => {
       cwd = root;
+      noLog = logLevel === "silent";
     },
     writeBundle: {
       sequential: true,
@@ -24,12 +25,15 @@ const dtsrollPlugin = (options) => {
         if (built) {
           return;
         }
-        logOutput(await dtsroll({
+        const output = await dtsroll({
           cwd,
           ...options
-        }));
-        console.log();
+        });
         built = true;
+        if (!noLog) {
+          logOutput(output);
+          console.log();
+        }
       }
     }
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dtsroll",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Bundle dts files",
   "keywords": [
     "bundle",

package/dist/log-output-CwMUFOmQ.mjs

@@ -1,100 +0,0 @@
-import path from 'node:path';
-import byteSize from 'byte-size';
-import { u as underline, c as bold, l as lightYellow, w as warningSignUnicode, e as dim, g as green, r as red, m as magenta, y as yellow } from './index--BBQtOEp.mjs';
-
-const cwd = process.cwd();
-
-const logOutput = (dtsOutput) => {
-  console.log(underline("dtsroll"));
-  const { inputs } = dtsOutput;
-  const isCliInput = inputs[0]?.[1] === void 0;
-  console.log(bold(`
-\u{1F4E5} Entry points${isCliInput ? "" : " in package.json"}`));
-  console.log(
-    inputs.map(([inputFile, inputSource, error]) => {
-      const relativeInputFile = path.relative(cwd, inputFile);
-      const logPath2 = relativeInputFile.length < inputFile.length ? relativeInputFile : inputFile;
-      if (error) {
-        return ` ${lightYellow(`${warningSignUnicode} ${logPath2} ${dim(error)}`)}`;
-      }
-      return ` \u2192 ${green(logPath2)}${inputSource ? ` ${dim(`from ${inputSource}`)}` : ""}`;
-    }).join("\n")
-  );
-  if ("error" in dtsOutput) {
-    console.error(`${red("Error:")} ${dtsOutput.error}`);
-    return;
-  }
-  const {
-    outputDirectory,
-    output: {
-      entries: outputEntries,
-      chunks: outputChunks
-    },
-    size,
-    externals
-  } = dtsOutput;
-  const outputDirectoryRelative = path.relative(cwd, outputDirectory);
-  const logPath = (outputDirectoryRelative.length < outputDirectory.length ? outputDirectoryRelative : outputDirectory) + path.sep;
-  const logChunk = ({
-    file,
-    indent,
-    bullet,
-    color
-  }) => {
-    const sizeFormatted = byteSize(file.size).toString();
-    let log = `${indent}${bullet} ${dim(color(logPath))}${color(file.fileName)} ${sizeFormatted}`;
-    const { moduleIds, moduleToPackage } = file;
-    log += `
-${moduleIds.sort().map((moduleId, index) => {
-      const isLast = index === moduleIds.length - 1;
-      const prefix = `${indent}   ${isLast ? "\u2514\u2500 " : "\u251C\u2500 "}`;
-      const relativeModuleId = path.relative(cwd, moduleId);
-      const logModuleId = relativeModuleId.length < moduleId.length ? relativeModuleId : moduleId;
-      const bareSpecifier = moduleToPackage[moduleId];
-      if (bareSpecifier) {
-        return `${prefix}${dim(`${magenta(bareSpecifier)} (${logModuleId})`)}`;
-      }
-      return `${prefix}${dim(logModuleId)}`;
-    }).join("\n")}`;
-    return log;
-  };
-  console.log(bold("\n\u{1F4A0} Bundled output"));
-  console.log(
-    outputEntries.map((file) => logChunk({
-      file,
-      indent: " ",
-      bullet: "\u25CF",
-      color: green
-    })).join("\n\n")
-  );
-  if (outputChunks.length > 0) {
-    console.log(bold("\n Chunks"));
-    console.log(
-      outputChunks.map((file) => logChunk({
-        file,
-        indent: "   ",
-        bullet: "\u25A0",
-        color: yellow
-      })).join("\n\n")
-    );
-  }
-  console.log(bold("\n\u2696\uFE0F Size savings"));
-  const percentage = ((size.input - size.output) / size.input * 100).toFixed(0);
-  console.log(`   Input source size:   ${byteSize(size.input).toString()}`);
-  console.log(`   Bundled output size: ${byteSize(size.output).toString()} (${percentage}% decrease)`);
-  if (externals.length > 0) {
-    console.log(bold("\n\u{1F4E6} External packages"));
-    console.log(
-      externals.map(([packageName, reason, devTypePackage]) => {
-        let stdout = ` \u2500 ${magenta(packageName)} ${dim(`externalized ${reason}`)}`;
-        if (devTypePackage) {
-          stdout += `
-   ${yellow("Warning:")} ${magenta(devTypePackage)} should not be in devDependencies if ${magenta(packageName)} is externalized`;
-        }
-        return stdout;
-      }).sort().join("\n")
-    );
-  }
-};
-
-export { logOutput as l };