prepare-package 2.0.1 → 2.0.4

package/dist/build.js

@@ -34,7 +34,7 @@ async function build(options) {
       build.onLoad({ filter: /\.js$/ }, async (args) => {
         let contents = fs.readFileSync(args.path, 'utf8');
         contents = contents.replace(/\{version\}/g, version);
-        return { contents, loader: 'js' };
+        return { contents, loader: 'js', watchFiles: [args.path] };
       });
     },
   };
@@ -124,13 +124,39 @@ async function createWatchContexts(options) {
   const entry = path.resolve(cwd, buildConfig.entry || path.join(config.input || './src', 'index.js'));
   const formats = buildConfig.formats || ['esm', 'cjs'];
 
-  const versionPlugin = {
-    name: 'version-replace',
+  // In watch mode, replace {version} in output files AFTER build (onEnd)
+  // instead of intercepting file loading (onLoad), so esbuild's native
+  // file watcher can detect source changes.
+  let isFirstBuild = true;
+  let rebuildTimer = null;
+
+  const watchVersionPlugin = {
+    name: 'version-replace-watch',
     setup(build) {
-      build.onLoad({ filter: /\.js$/ }, async (args) => {
-        let contents = fs.readFileSync(args.path, 'utf8');
-        contents = contents.replace(/\{version\}/g, version);
-        return { contents, loader: 'js' };
+      build.onEnd((result) => {
+        // Replace {version} in the output file
+        const outfile = build.initialOptions.outfile;
+        if (outfile && fs.existsSync(outfile)) {
+          const contents = fs.readFileSync(outfile, 'utf8');
+          if (contents.includes('{version}')) {
+            fs.writeFileSync(outfile, contents.replace(/\{version\}/g, version));
+          }
+        }
+
+        // Skip first build (the "Watching..." message covers it)
+        if (isFirstBuild) {
+          return;
+        }
+
+        // Debounce rebuild log across all format contexts
+        if (result.errors.length > 0) {
+          logger.error(chalk.red(`Build failed with ${result.errors.length} error(s)`));
+        } else if (!rebuildTimer) {
+          rebuildTimer = setTimeout(() => {
+            rebuildTimer = null;
+            logger.log(chalk.green(`Rebuilt ${packageJSON.name} v${version}`));
+          }, 50);
+        }
       });
     },
   };
@@ -139,7 +165,7 @@ async function createWatchContexts(options) {
     entryPoints: [entry],
     bundle: true,
     sourcemap: buildConfig.sourcemap || false,
-    plugins: [versionPlugin],
+    plugins: [watchVersionPlugin],
     external: buildConfig.external || [],
   };
 
@@ -195,6 +221,8 @@ async function createWatchContexts(options) {
   );
 
   await Promise.all(contexts.map(ctx => ctx.watch()));
+  // Delay flipping the flag so initial onEnd callbacks complete first
+  await new Promise(resolve => setTimeout(() => { isFirstBuild = false; resolve(); }, 100));
 
   const formatNames = formats.map(f => f.toUpperCase()).join(', ');
   logger.log(chalk.green(`Watching ${packageJSON.name} v${version} (${formatNames})...`));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prepare-package",
-  "version": "2.0.1",
+  "version": "2.0.4",
   "description": "Prepare a Node.js package before being published",
   "main": "dist/index.js",
   "bin": {
@@ -11,6 +11,9 @@
     ".": "./dist/index.js",
     "./watch": "./dist/watch.js"
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "test": "./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
     "start": "npm run prepare:watch",

package/CHANGELOG.md

@@ -1,20 +0,0 @@
-# CHANGELOG
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
-
-## Changelog Categories
-
-- `BREAKING` for breaking changes.
-- `Added` for new features.
-- `Changed` for changes in existing functionality.
-- `Deprecated` for soon-to-be removed features.
-- `Removed` for now removed features.
-- `Fixed` for any bug fixes.
-- `Security` in case of vulnerabilities.
-
----
-## [1.0.0] - 2024-06-19
-### Added
-- Initial release of the project 🚀

package/CLAUDE.md

@@ -1,76 +0,0 @@
-# prepare-package
-
-## Overview
-NPM build tool that prepares packages for distribution. Supports two modes: **copy** (file copy with version replacement) and **bundle** (esbuild multi-format builds).
-
-## Architecture
-
-### Two Modes via `preparePackage.type`
-- **`"copy"` (default)**: Copies `src/` to `dist/`, replaces `{version}` in the main file. Used by large projects that don't need bundling (e.g., UJM).
-- **`"bundle"`**: Uses esbuild to produce ESM (`index.mjs`), CJS (`index.js`), and/or IIFE (minified, for CDN `<script>` tags). Used by client-side libraries (e.g., chatsy).
-
-### Project Structure
-```
-src/
-  index.js    # Main entry: resolves config, branches copy vs bundle, safety checks, CDN purge
-  build.js    # Esbuild config generator, version plugin, build() and createWatchContexts()
-  watch.js    # Watch mode: chokidar for copy, esbuild contexts for bundle
-  cli.js      # Interactive CLI for project setup (npx pp / npx prepare-package)
-  logger.js   # Timestamped console logger with chalk colors
-dist/         # Copy-mode output of src/ (prepare-package builds itself with copy mode)
-```
-
-### CLI (`npx pp` / `npx prepare-package`)
-Interactive setup wizard that configures a project's `package.json`:
-1. Asks **copy** or **bundle** mode
-2. Asks source/output directories (defaults: `src`/`dist`)
-3. If bundle: asks formats, auto-derives `globalName` (TitleCase of package name) and `fileName` (`{name}.min.js`)
-4. Writes `preparePackage` config and `prepare`/`prepare:watch` scripts to `package.json`
-
-### How It Runs
-- **`prepare` script**: Runs on `npm install` and `npm publish` in the consumer's project
-- **`postinstall` script**: Runs when prepare-package itself is installed as a dependency. Skips bundle mode (esbuild may not be available yet during install)
-- **`prepare:watch` script**: Starts watch mode (chokidar for copy, esbuild `.watch()` for bundle)
-- **`bin` commands**: `prepare-package` and `pp` both point to `cli.js`
-
-### Consumer Configuration
-All config lives in `preparePackage` key in the consumer's `package.json`:
-
-```jsonc
-{
-  "preparePackage": {
-    "input": "src",           // Source directory
-    "output": "dist",         // Output directory
-    "type": "copy",           // "copy" (default) or "bundle"
-    "build": {                // Only used when type: "bundle"
-      "entry": "src/index.js",
-      "formats": ["esm", "cjs", "iife"],
-      "target": "es2020",
-      "platform": "neutral",
-      "external": [],
-      "sourcemap": false,
-      "iife": {
-        "globalName": "MyLib",      // Required for IIFE
-        "fileName": "my-lib.min.js" // Default: "{name}.min.js"
-      }
-    }
-  }
-}
-```
-
-### Publish Safety
-- Blocks publish if any local `file:` dependencies are found
-- Removes sensitive files (`.env`, `.DS_Store`, etc.) from the package
-- Purges jsDelivr CDN cache after publish
-
-### Key Details
-- esbuild is a direct dependency but only `require()`'d inside bundle code paths (lazy-loaded)
-- Bundle mode's version plugin replaces `{version}` in all `.js` files at build time
-- IIFE build auto-unwraps default export: `GlobalName=GlobalName.default||GlobalName.GlobalName||GlobalName;`
-- Copy mode's `{version}` replacement only applies to the main file
-- prepare-package builds itself using copy mode (it's both the tool and a consumer of itself)
-
-## Conventions
-- Self-hosting: prepare-package uses itself (copy mode) to build `src/` → `dist/`
-- No breaking changes to copy mode — existing consumers must keep working unchanged
-- Bundle mode is opt-in via `type: "bundle"`