smartbundle 0.7.3 → 0.8.0-alpha.1

package/README.md

@@ -1,47 +1,81 @@
-# SmartBundle - zero-config bundler for npm packages
+# SmartBundle
+SmartBundle is a zero-config bundler tailored for library authors and package maintainers looking for simplicity and broad compatibility without the need for complex setup.
+
+## Features
+`SmartBundle` aims to make the build process seamless and distraction-free. Key features include:
+- Configuration-free setup via `package.json`
+- Compatibility with popular bundlers and runtimes
+- Support for ESM and CJS compatibility
+- TypeScript typings generation
+- Harmless bin scripts
+- Source maps generation for easier debugging
+
+We've also optimized several aspects to ensure the resulting package is as smooth to use as possible.
 
 ## How to use
-1) Create package.json like
-```json
+1) Create a `package.json` file like the following:
+```json5
 {
   "name": "my-package",
   "version": "1.0.0",
-  "private": true, // required for avoiding the accidental publishing
+  "private": true, // prevents accidental publishing
   "type": "module",
-  "exports": {
-    ".": "./src/index.ts" // entrypoint list for building the package
-  }
+  "exports": "./src/index.ts" // entrypoint for building the package
 }
 ```
 2) Run
 ```bash
-npx smartbundle
+npx smartbundle@latest
 ```
-3) Go to the `dist` folder and publish your package to the npm registry. The total package.json will be generated automatically.
+The built files will appear in the `./dist` folder, including an auto-generated `package.json` file.
+3) Navigate to the `./dist` folder and publish your package to the npm registry.
 
 ## Supported targets
-- Bun 1+
-- Node ^18.0.0, ^20.0.0, ^22.0.0, ^23.0.0
-- Webpack ^4.47.0, ^5.95.0
-- Rspack ^1.0.0
+| Target                    | Supported | Tested  |
+|---------------------------|-----------|---------|
+| Bun ^1.0.0                | ✔         | ✔       |
+| Node ^18.0.0              | ✔         | ✔       |
+| Node ^20.0.0              | ✔         | ✔       |
+| Node ^22.0.0              | ✔         | ✔       |
+| Node ^23.0.0              | ✔         | ✔       |
+| Webpack ^4.47.0           | ✔         | ✔       |
+| Webpack ^5.95.0           | ✔         | ✔       |
+| Rspack ^1.0.0             | ✔         | ✔       |
+| Vite ^5.0.0               | ✔         | not yet |
+| Rollup ^4.0.0             | ✔         | not yet |
+| Deno ^2.0.0               | ✔         | not yet |
+| Parcel ^2.0.0             | ✔         | not yet |
+| Browserify ^17.0.0        | ✔         | not yet |
+| Esbuild ^0.24.0           | ✔         | not yet |
+| Metro ^0.81.0             | ✔         | ✔       |
+| Next.js/Turbopack ^13.0.0 | ✔         | not yet |
 
-## Features
-- generate the most compatible package.json for any bundlers(webpack, rollup, esbuild, vite, etc) or runtimes(node, bun, deno, etc)
-- validate package.json for common errors
-- do not require any configuration files like tsconfig.json, eslintrc.json, etc
-- but if you need to use them, you can use them by creating them manually like for the parcel bundler
-- generate esm and cjs entrypoints for the package
-- generate typescript typings for the package
-- require only minimal package.json fields
+We aim to support as many bundlers and runtimes as possible. If the bundled package doesn't work with your bundler, please let us know.
+
+## `package.json` limitations
+To reduce potential errors and ensure smooth package generation, we follow a stricter configuration for `package.json`.
 
-## Known issues:
-  - does not generate fully compatible cjs typings for the entrypoints (#9)
-  - supports only `type: module` right now. It will be fixed before `v1.0.0` release.
+### Banned fields
+#### `files`
+SmartBundle calculates the import graph and includes all necessary files, making `files` unnecessary and potentially confusing.
+#### `main`, `module`, `browser`, `types`
+We rely on the `exports` field for entry points. These fields are redundant and automatically generated in `./dist/package.json`.
 
-## Motivation
+### Required fields
+#### `private`
+Setting `"private": true` avoids accidental publishing of the source package by ensuring it is not mistakenly published to npm.
 
-Almost every npm package have the same build pipeline: build code, generate typescript typings, validate package.json, generate correct package.json for the bundlers and runtimes, blah-blah, etc.
+### Stricter fields
+#### `type`
+We currently support only the `module` type for packages, with plans to support `commonjs` in future releases.
+#### `exports`
+Only ESM/TS entry points are currently supported in exports. While [conditional exports](https://nodejs.org/api/packages.html#conditional-exports) are not yet available, they’re planned for an upcoming release.
+#### `bin`
+Currently, we support all `bin` [specifications](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin) except for `sh` files. Also, we guarantee that the bin files will execute as expected.
 
-I really like the [microbundle](https://github.com/developit/microbundle) project, but it requires a lot of extra configuration and is not zero-config. And more, the project is not maintained and does not support a lot of modern js features.
+### FAQ
+#### Why don't you minify the output?
+Minification is typically needed only for production. During development, readable, unminified output helps with debugging.
 
-So I decided to create my own project to automate the build pipeline and save the developer's time for building packages.
+#### Why do you require third-party tools for building?
+We prioritize keeping the `node_modules` size manageable and avoid unnecessary dependencies. If your package does not require TypeScript, for instance, you don’t need to install those specific tools.

package/__bin__/smartbundle.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import("../__do_not_import_directly__/smartbundle.js");
+import("../__do_not_import_directly__/smartbundle.mjs");

package/__do_not_import_directly__/args.js

@@ -1,6 +1,25 @@
-import yargs from "yargs";
-import * as process from "node:process";
-const args = yargs(process.argv.slice(2)).option("sourceDir", {
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const yargs = require("yargs");
+const process = require("node:process");
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const process__namespace = /* @__PURE__ */ _interopNamespaceDefault(process);
+const args = yargs(process__namespace.argv.slice(2)).option("sourceDir", {
   alias: "s",
   type: "string",
   describe: "path to the project directory. Default: current working directory"
@@ -13,6 +32,4 @@ const args = yargs(process.argv.slice(2)).option("sourceDir", {
   type: "string",
   describe: "path to the output directory. Default: cwd()/dist"
 }).help("help").parseSync();
-export {
-  args
-};
+exports.args = args;

package/__do_not_import_directly__/args.mjs

@@ -0,0 +1,18 @@
+import yargs from "yargs";
+import * as process from "node:process";
+const args = yargs(process.argv.slice(2)).option("sourceDir", {
+  alias: "s",
+  type: "string",
+  describe: "path to the project directory. Default: current working directory"
+}).option("packagePath", {
+  alias: "p",
+  type: "string",
+  describe: "path to the package.json. Default: cwd()/package.json"
+}).option("outputDir", {
+  alias: "o",
+  type: "string",
+  describe: "path to the output directory. Default: cwd()/dist"
+}).help("help").parseSync();
+export {
+  args
+};

package/__do_not_import_directly__/buildVite.js

@@ -1,13 +1,15 @@
-import { build } from "vite";
-import { errors } from "./errors.js";
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const vite = require("vite");
+const errors = require("./errors.js");
 async function buildVite({
   viteConfig
 }) {
-  const outputs = await build(viteConfig);
+  const outputs = await vite.build(viteConfig);
   if (!Array.isArray(outputs)) {
     return {
       error: true,
-      errors: [errors.rollupError]
+      errors: [errors.errors.rollupError]
     };
   }
   return {
@@ -15,6 +17,4 @@ async function buildVite({
     output: outputs.flatMap((x) => x.output.filter((x2) => x2.type === "chunk"))
   };
 }
-export {
-  buildVite
-};
+exports.buildVite = buildVite;

package/__do_not_import_directly__/buildVite.mjs

@@ -0,0 +1,20 @@
+import { build } from "vite";
+import { errors } from "./errors.mjs";
+async function buildVite({
+  viteConfig
+}) {
+  const outputs = await build(viteConfig);
+  if (!Array.isArray(outputs)) {
+    return {
+      error: true,
+      errors: [errors.rollupError]
+    };
+  }
+  return {
+    error: false,
+    output: outputs.flatMap((x) => x.output.filter((x2) => x2.type === "chunk"))
+  };
+}
+export {
+  buildVite
+};

package/__do_not_import_directly__/createViteConfig.js

@@ -1,7 +1,9 @@
-import { join, relative } from "node:path";
-import "node:fs/promises";
-import "zod";
-import { defineConfig } from "vite";
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const path = require("node:path");
+require("node:fs/promises");
+require("zod");
+const vite = require("vite");
 function mapToObject(map, bins) {
   const obj = {};
   for (const [key, value] of map) {
@@ -45,18 +47,18 @@ function createViteConfig({ dirs, packageJson }) {
   const entrypoints = /* @__PURE__ */ new Map();
   if (packageJson.exports) {
     for (const [key, value] of packageJson.exports) {
-      const entry = join(sourceDir, value);
+      const entry = path.join(sourceDir, value);
       entrypoints.set(key, entry);
     }
   }
   const bins = /* @__PURE__ */ new Map();
   if (packageJson.bin) {
     for (const [key, value] of packageJson.bin) {
-      bins.set(key, join(sourceDir, value));
+      bins.set(key, path.join(sourceDir, value));
     }
   }
   const depsValidator = createExternalDepValidator(packageJson);
-  const viteConfig = defineConfig({
+  const viteConfig = vite.defineConfig({
     publicDir: false,
     build: {
       outDir,
@@ -75,15 +77,15 @@ function createViteConfig({ dirs, packageJson }) {
           const entrypoint = entrypoints.get(entryName);
           if (!entrypoint) {
             const noExt2 = entryName.replace(/\.[^.]+$/, "");
-            return "__do_not_import_directly__/" + noExt2 + (format === "es" ? ".js" : ".cjs");
+            return "__do_not_import_directly__/" + noExt2 + (format === "es" ? ".mjs" : ".js");
           }
-          const relativePath = relative(sourceDir, entrypoint);
+          const relativePath = path.relative(sourceDir, entrypoint);
           const noExt = relativePath.replace(/\.[^.]+$/, "");
           if (format === "es") {
-            return `${noExt}.js`;
+            return `${noExt}.mjs`;
           }
           if (format === "cjs") {
-            return `${noExt}.cjs`;
+            return `${noExt}.js`;
           }
           return noExt;
         }
@@ -99,6 +101,4 @@ function createViteConfig({ dirs, packageJson }) {
   });
   return { viteConfig, entrypoints, bins };
 }
-export {
-  createViteConfig
-};
+exports.createViteConfig = createViteConfig;

package/__do_not_import_directly__/{createViteConfig.cjs → createViteConfig.mjs}

@@ -1,9 +1,7 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const path = require("node:path");
-require("node:fs/promises");
-require("zod");
-const vite = require("vite");
+import { join, relative } from "node:path";
+import "node:fs/promises";
+import "zod";
+import { defineConfig } from "vite";
 function mapToObject(map, bins) {
   const obj = {};
   for (const [key, value] of map) {
@@ -47,18 +45,18 @@ function createViteConfig({ dirs, packageJson }) {
   const entrypoints = /* @__PURE__ */ new Map();
   if (packageJson.exports) {
     for (const [key, value] of packageJson.exports) {
-      const entry = path.join(sourceDir, value);
+      const entry = join(sourceDir, value);
       entrypoints.set(key, entry);
     }
   }
   const bins = /* @__PURE__ */ new Map();
   if (packageJson.bin) {
     for (const [key, value] of packageJson.bin) {
-      bins.set(key, path.join(sourceDir, value));
+      bins.set(key, join(sourceDir, value));
     }
   }
   const depsValidator = createExternalDepValidator(packageJson);
-  const viteConfig = vite.defineConfig({
+  const viteConfig = defineConfig({
     publicDir: false,
     build: {
       outDir,
@@ -77,15 +75,15 @@ function createViteConfig({ dirs, packageJson }) {
           const entrypoint = entrypoints.get(entryName);
           if (!entrypoint) {
             const noExt2 = entryName.replace(/\.[^.]+$/, "");
-            return "__do_not_import_directly__/" + noExt2 + (format === "es" ? ".js" : ".cjs");
+            return "__do_not_import_directly__/" + noExt2 + (format === "es" ? ".mjs" : ".js");
           }
-          const relativePath = path.relative(sourceDir, entrypoint);
+          const relativePath = relative(sourceDir, entrypoint);
           const noExt = relativePath.replace(/\.[^.]+$/, "");
           if (format === "es") {
-            return `${noExt}.js`;
+            return `${noExt}.mjs`;
           }
           if (format === "cjs") {
-            return `${noExt}.cjs`;
+            return `${noExt}.js`;
           }
           return noExt;
         }
@@ -101,4 +99,6 @@ function createViteConfig({ dirs, packageJson }) {
   });
   return { viteConfig, entrypoints, bins };
 }
-exports.createViteConfig = createViteConfig;
+export {
+  createViteConfig
+};

package/__do_not_import_directly__/error.js

@@ -1,9 +1,9 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 class BuildError extends Error {
   constructor(error) {
     super(error);
     this.error = error;
   }
 }
-export {
-  BuildError
-};
+exports.BuildError = BuildError;

package/__do_not_import_directly__/error.mjs

@@ -0,0 +1,9 @@
+class BuildError extends Error {
+  constructor(error) {
+    super(error);
+    this.error = error;
+  }
+}
+export {
+  BuildError
+};

package/__do_not_import_directly__/errors.js

@@ -1,3 +1,5 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const errors = {
   exportsRequired: "The `exports` field is string or Record<string, string>. Please, verify the value. More info: https://nodejs.org/api/packages.html#package-entry-points",
   exportsInvalid: "The `exports` field must be a path to entrypoint. Please, verify the value. More info: https://nodejs.org/api/packages.html#package-entry-points",
@@ -26,6 +28,4 @@ const errors = {
   osInvalid: "The `os` field must be an array of strings. Please, verify the value. More info: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#os",
   cpuInvalid: "The `cpu` field must be an array of strings. Please, verify the value. More info: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#cpu"
 };
-export {
-  errors
-};
+exports.errors = errors;

package/__do_not_import_directly__/{errors.cjs → errors.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const errors = {
   exportsRequired: "The `exports` field is string or Record<string, string>. Please, verify the value. More info: https://nodejs.org/api/packages.html#package-entry-points",
   exportsInvalid: "The `exports` field must be a path to entrypoint. Please, verify the value. More info: https://nodejs.org/api/packages.html#package-entry-points",
@@ -28,4 +26,6 @@ const errors = {
   osInvalid: "The `os` field must be an array of strings. Please, verify the value. More info: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#os",
   cpuInvalid: "The `cpu` field must be an array of strings. Please, verify the value. More info: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#cpu"
 };
-exports.errors = errors;
+export {
+  errors
+};

package/__do_not_import_directly__/packageJson.js

@@ -1,10 +1,29 @@
-import * as fs from "node:fs/promises";
-import z from "zod";
-import { errors } from "./errors.js";
-import { join } from "node:path";
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const fs = require("node:fs/promises");
+const z = require("zod");
+const errors = require("./errors.js");
+const path = require("node:path");
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
+  if (e) {
+    for (const k in e) {
+      if (k !== "default") {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+const fs__namespace = /* @__PURE__ */ _interopNamespaceDefault(fs);
 async function fileExists(filePath) {
   try {
-    const stats = await fs.stat(filePath);
+    const stats = await fs__namespace.stat(filePath);
     return stats.isFile();
   } catch (error) {
     return false;
@@ -14,8 +33,8 @@ function dependencies(errorText) {
   return z.record(z.string({ message: errorText }), { message: errorText }).optional();
 }
 function createPathValidator(sourceDir) {
-  return (path) => {
-    const finalPath = join(sourceDir, path);
+  return (path$1) => {
+    const finalPath = path.join(sourceDir, path$1);
     return fileExists(finalPath);
   };
 }
@@ -34,12 +53,12 @@ function createPackageJsonSchema(sourceDir) {
   return z.object({
     exports: z.union(
       [
-        z.string().transform((path) => /* @__PURE__ */ new Map([[".", path]])),
+        z.string().transform((path2) => /* @__PURE__ */ new Map([[".", path2]])),
         z.record(z.string()).transform((obj) => new Map(Object.entries(obj)))
       ],
       {
         errorMap() {
-          return { message: errors.exportsRequired };
+          return { message: errors.errors.exportsRequired };
         }
       }
     ).refine(async (obj) => {
@@ -49,16 +68,16 @@ function createPackageJsonSchema(sourceDir) {
         }
       }
       return true;
-    }, errors.exportsInvalid).optional(),
-    name: z.string({ message: errors.nameRequired }).min(1, errors.nameMinLength).max(214, errors.nameMaxLength).refine(
+    }, errors.errors.exportsInvalid).optional(),
+    name: z.string({ message: errors.errors.nameRequired }).min(1, errors.errors.nameMinLength).max(214, errors.errors.nameMaxLength).refine(
       (name) => ["_", "."].every((start) => !name.startsWith(start)),
-      errors.nameStartsIllegalChars
+      errors.errors.nameStartsIllegalChars
     ),
-    version: z.string({ message: errors.versionRequired }),
-    private: z.boolean({ message: errors.privateIsTrue }).refine((value) => value, errors.privateIsTrue),
-    description: z.string({ message: errors.descriptionString }).optional(),
-    dependencies: dependencies(errors.dependenciesInvalid),
-    optionalDependencies: dependencies(errors.optionalDependenciesInvalid),
+    version: z.string({ message: errors.errors.versionRequired }),
+    private: z.boolean({ message: errors.errors.privateIsTrue }).refine((value) => value, errors.errors.privateIsTrue),
+    description: z.string({ message: errors.errors.descriptionString }).optional(),
+    dependencies: dependencies(errors.errors.dependenciesInvalid),
+    optionalDependencies: dependencies(errors.errors.optionalDependenciesInvalid),
     bin: z.union(
       [
         z.string().transform((value) => /* @__PURE__ */ new Map([[PackageJsonNameField, value]])),
@@ -66,7 +85,7 @@ function createPackageJsonSchema(sourceDir) {
       ],
       {
         errorMap() {
-          return { message: errors.binFiled };
+          return { message: errors.errors.binFiled };
         }
       }
     ).refine(
@@ -78,33 +97,33 @@ function createPackageJsonSchema(sourceDir) {
         }
         return true;
       },
-      { message: errors.binFiled }
+      { message: errors.errors.binFiled }
     ).optional(),
     repository: z.any().optional(),
-    keywords: z.array(z.string(), { message: errors.keywordsInvalid }).optional(),
+    keywords: z.array(z.string(), { message: errors.errors.keywordsInvalid }).optional(),
     author: z.any().optional(),
     maintainers: z.any().optional(),
     contributors: z.array(
       z.union([
-        z.string({ message: errors.contributorsInvalid }),
-        z.object({}, { message: errors.contributorsInvalid })
+        z.string({ message: errors.errors.contributorsInvalid }),
+        z.object({}, { message: errors.errors.contributorsInvalid })
       ])
     ).optional(),
     license: z.any().optional(),
-    devDependencies: dependencies(errors.devDependenciesInvalid),
-    peerDependencies: dependencies(errors.peerDependenciesInvalid),
-    engines: z.record(z.string(), { message: errors.enginesInvalid }).optional(),
+    devDependencies: dependencies(errors.errors.devDependenciesInvalid),
+    peerDependencies: dependencies(errors.errors.peerDependenciesInvalid),
+    engines: z.record(z.string(), { message: errors.errors.enginesInvalid }).optional(),
     browser: z.union([
-      z.string({ message: errors.browserInvalid }),
-      z.record(z.string(), { message: errors.browserInvalid })
+      z.string({ message: errors.errors.browserInvalid }),
+      z.record(z.string(), { message: errors.errors.browserInvalid })
     ]).optional(),
     bugs: z.any().optional(),
     funding: z.union([
-      z.string({ message: errors.fundingInvalid }),
-      z.object({}, { message: errors.fundingInvalid })
+      z.string({ message: errors.errors.fundingInvalid }),
+      z.object({}, { message: errors.errors.fundingInvalid })
     ]).optional(),
-    os: z.array(z.string(), { message: errors.osInvalid }).optional(),
-    cpu: z.array(z.string(), { message: errors.cpuInvalid }).optional(),
+    os: z.array(z.string(), { message: errors.errors.osInvalid }).optional(),
+    cpu: z.array(z.string(), { message: errors.errors.cpuInvalid }).optional(),
     sideEffects: z.any().optional(),
     unpkg: z.any().optional(),
     homepage: z.any().optional()
@@ -114,7 +133,7 @@ async function parsePackageJson({
   sourceDir,
   packagePath
 }) {
-  const packageString = await fs.readFile(packagePath, "utf-8");
+  const packageString = await fs__namespace.readFile(packagePath, "utf-8");
   const rawJson = JSON.parse(packageString);
   const packageJsonSchema = createPackageJsonSchema(sourceDir);
   const packageJson = await packageJsonSchema.safeParseAsync(rawJson);
@@ -124,6 +143,4 @@ async function parsePackageJson({
   fillPackageJson(packageJson.data);
   return packageJson.data;
 }
-export {
-  parsePackageJson
-};
+exports.parsePackageJson = parsePackageJson;