smartbundle 0.3.2 → 0.4.0-alpha.0

package/README.md

@@ -0,0 +1,41 @@
+# SmartBundle - zero-config bundler for npm packages
+
+## How to use
+1) Create package.json like
+```json
+{
+  "name": "my-package",
+  "version": "1.0.0",
+  "private": true, // required for avoiding the accidental publishing
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts" // entrypoint list for building the package
+  }
+}
+```
+2) Run
+```bash
+npx smartbundle
+```
+3) Go to the `dist` folder and publish your package to the npm registry. The total package.json will be generated automatically.
+
+## 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
+
+## 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.
+
+## Motivation
+
+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.
+
+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.
+
+So I decided to create my own project to automate the build pipeline and save the developer's time for building packages.

package/__do_not_import_directly__/copyStaticFiles.cjs

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const path = require("node:path");
+const fs = require("node:fs/promises");
+async function copyStaticFiles({
+  sourceDir,
+  outDir,
+  relativeFiles
+}) {
+  const copiedFiles = new Array();
+  const dirFiles = new Map(
+    (await fs.readdir(sourceDir, { recursive: true })).map(
+      (f) => [f.toLowerCase(), f]
+    )
+  );
+  for (const file of relativeFiles) {
+    try {
+      const matchingFile = dirFiles.get(file.toLowerCase());
+      if (matchingFile) {
+        const outFilePath = path.join(outDir, matchingFile);
+        const filePath = path.join(sourceDir, matchingFile);
+        await fs.copyFile(filePath, outFilePath);
+        copiedFiles.push(matchingFile);
+      }
+    } catch {
+    }
+  }
+  return copiedFiles;
+}
+exports.copyStaticFiles = copyStaticFiles;

package/__do_not_import_directly__/copyStaticFiles.js

@@ -0,0 +1,30 @@
+import { join } from "node:path";
+import { readdir, copyFile } from "node:fs/promises";
+async function copyStaticFiles({
+  sourceDir,
+  outDir,
+  relativeFiles
+}) {
+  const copiedFiles = new Array();
+  const dirFiles = new Map(
+    (await readdir(sourceDir, { recursive: true })).map(
+      (f) => [f.toLowerCase(), f]
+    )
+  );
+  for (const file of relativeFiles) {
+    try {
+      const matchingFile = dirFiles.get(file.toLowerCase());
+      if (matchingFile) {
+        const outFilePath = join(outDir, matchingFile);
+        const filePath = join(sourceDir, matchingFile);
+        await copyFile(filePath, outFilePath);
+        copiedFiles.push(matchingFile);
+      }
+    } catch {
+    }
+  }
+  return copiedFiles;
+}
+export {
+  copyStaticFiles
+};

package/__do_not_import_directly__/index.cjs

@@ -29,6 +29,7 @@ const writePackageJson = require("./writePackageJson.cjs");
 const errors = require("./errors.cjs");
 const buildTypes = require("./buildTypes.cjs");
 const buildVite = require("./buildVite.cjs");
+const copyStaticFiles = require("./copyStaticFiles.cjs");
 function myResolve(path1, path2) {
   if (path.isAbsolute(path2)) {
     return path2;
@@ -127,6 +128,17 @@ async function run(args) {
       });
     }
   }
+  const copiedFiles = await copyStaticFiles.copyStaticFiles({
+    relativeFiles: /* @__PURE__ */ new Set(["readme.md", "package.json"]),
+    sourceDir,
+    outDir
+  });
+  for (const copiedFile of copiedFiles) {
+    setExports(exportsMap, "./" + copiedFile, (entry) => {
+      entry.raw = "./" + copiedFile;
+      return entry;
+    });
+  }
   await writePackageJson.writePackageJson(outDir, packageJson$1, {
     exportsMap
   });

package/__do_not_import_directly__/index.js

@@ -5,6 +5,7 @@ import { writePackageJson } from "./writePackageJson.js";
 import { errors } from "./errors.js";
 import { buildTypes } from "./buildTypes.js";
 import { buildVite } from "./buildVite.js";
+import { copyStaticFiles } from "./copyStaticFiles.js";
 function myResolve(path1, path2) {
   if (isAbsolute(path2)) {
     return path2;
@@ -103,6 +104,17 @@ async function run(args) {
       });
     }
   }
+  const copiedFiles = await copyStaticFiles({
+    relativeFiles: /* @__PURE__ */ new Set(["readme.md", "package.json"]),
+    sourceDir,
+    outDir
+  });
+  for (const copiedFile of copiedFiles) {
+    setExports(exportsMap, "./" + copiedFile, (entry) => {
+      entry.raw = "./" + copiedFile;
+      return entry;
+    });
+  }
   await writePackageJson(outDir, packageJson, {
     exportsMap
   });

package/__do_not_import_directly__/writePackageJson.cjs

@@ -2,12 +2,16 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const fs = require("node:fs/promises");
 async function writePackageJson(outDir, parsed, { exportsMap }) {
-  var _a, _b, _c;
+  var _a;
   const allExports = {};
   for (const [key, value] of exportsMap) {
     if (key === "__bin__") {
       continue;
     }
+    if (value.raw) {
+      allExports[key] = value.raw;
+      continue;
+    }
     const anExport = {};
     if (value.dts) {
       anExport.types = value.dts;
@@ -29,13 +33,14 @@ async function writePackageJson(outDir, parsed, { exportsMap }) {
     anExport.default = value.mjs;
     allExports[key] = anExport;
   }
+  const rootExport = typeof allExports["."] === "object" ? allExports["."] : void 0;
   const res = {
     name: parsed.name,
     type: "module",
     version: parsed.version,
     bin: (_a = exportsMap.get("__bin__")) == null ? void 0 : _a.mjs,
-    types: (_b = allExports["."]) == null ? void 0 : _b.types,
-    module: (_c = allExports["."]) == null ? void 0 : _c.default,
+    types: rootExport == null ? void 0 : rootExport.types,
+    module: rootExport == null ? void 0 : rootExport.default,
     description: parsed.description ?? "",
     exports: allExports,
     dependencies: parsed.dependencies ?? void 0,

package/__do_not_import_directly__/writePackageJson.js

@@ -1,11 +1,15 @@
 import { writeFile } from "node:fs/promises";
 async function writePackageJson(outDir, parsed, { exportsMap }) {
-  var _a, _b, _c;
+  var _a;
   const allExports = {};
   for (const [key, value] of exportsMap) {
     if (key === "__bin__") {
       continue;
     }
+    if (value.raw) {
+      allExports[key] = value.raw;
+      continue;
+    }
     const anExport = {};
     if (value.dts) {
       anExport.types = value.dts;
@@ -27,13 +31,14 @@ async function writePackageJson(outDir, parsed, { exportsMap }) {
     anExport.default = value.mjs;
     allExports[key] = anExport;
   }
+  const rootExport = typeof allExports["."] === "object" ? allExports["."] : void 0;
   const res = {
     name: parsed.name,
     type: "module",
     version: parsed.version,
     bin: (_a = exportsMap.get("__bin__")) == null ? void 0 : _a.mjs,
-    types: (_b = allExports["."]) == null ? void 0 : _b.types,
-    module: (_c = allExports["."]) == null ? void 0 : _c.default,
+    types: rootExport == null ? void 0 : rootExport.types,
+    module: rootExport == null ? void 0 : rootExport.default,
     description: parsed.description ?? "",
     exports: allExports,
     dependencies: parsed.dependencies ?? void 0,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "smartbundle",
   "type": "module",
-  "version": "0.3.2",
+  "version": "0.4.0-alpha.0",
   "bin": "./src/bin.js",
   "types": "./src/run.d.ts",
   "module": "./src/run.js",
@@ -18,7 +18,9 @@
         "default": "./src/run.cjs"
       },
       "default": "./src/run.js"
-    }
+    },
+    "./README.md": "./README.md",
+    "./package.json": "./package.json"
   },
   "dependencies": {
     "vite": "^5.3.4",

package/src/copyStaticFiles.d.ts

@@ -0,0 +1,7 @@
+type CopyStaticFilesOptions = {
+    relativeFiles: Set<string>;
+    sourceDir: string;
+    outDir: string;
+};
+export declare function copyStaticFiles({ sourceDir, outDir, relativeFiles, }: CopyStaticFilesOptions): Promise<string[]>;
+export {};

package/src/writePackageJson.d.ts

@@ -3,6 +3,7 @@ export type ExportsObject = {
     mjs?: string;
     dts?: string;
     cjs?: string;
+    raw?: string;
 };
 type BuildResult = {
     exportsMap: Map<string, ExportsObject>;