@normed/bundle 2.0.6 → 2.1.0

package/CHANGELOG.md

@@ -1,18 +1,32 @@
+This file follows SEMVER.
+
+Given a version number MAJOR.MINOR.PATCH, increment the:
+
+1. MAJOR version when you make incompatible API changes,
+2. MINOR version when you add functionality in a backwards compatible manner, and
+3. PATCH version when you make backwards compatible bug fixes.
+
+# 2.1.0
+
+* MINOR: Adds the 'library' platform, to automatically output without dependencies.
+* MINOR: Adds support for not including any dependencies in the bundle via the '*' option.
+* MINOR: Improves the README.md by documenting configuration options for the CLI and package.json.
+* MINOR: Syncs the programming API and the CLI, allowing features previously unique to each to be used from either.
 # 2.0.5
 
 * MINOR: Uses pnpify as a hail mary
 
 # 2.0.4
 
-* MINOR: Fixes builds to actually use the normal compiler and not tsc
-* MINOR: declarations now work for typescript
 * MINOR: metafiles can be output with --analyse
+* PATCH: Fixes builds to actually use the normal compiler and not tsc
+* PATCH: declarations now work for typescript
 
 # 2.0.3
 
 * MINOR: Adds color
 * MINOR: Bumps dependencies
 * MINOR: Uses bundle's own log function for logging in cli rather than console.log/error
-* MINOR: Fixes build to support ES202 and less types
-* MINOR: Correctly handles escaping Windows paths during substitution
-* MINOR: Alters build logs to have relative paths only
+* PATCH: Fixes build to support ES2020 and less types
+* PATCH: Correctly handles escaping Windows paths during substitution
+* PATCH: Alters build logs to have relative paths only

package/README.md

@@ -28,8 +28,109 @@ The following additional variables provided by `@normed/bundle`, and do not exis
 
 The current version of `@normed/bundle` is built on top of es-build for speed.
 
+# Configuration
+
+Specify your configuration in your `package.json` by adding the `"bundle"` entry.
+
+```ts
+{
+  "bundle"?: {
+    "entrypoints"?: string[], // Manually specify entrypoints here.
+    "analyse"?: boolean, // When true, outputs bundle analysis files.
+    "typescript"?: {
+      "external"?: 'all' | string[], // Which dependencies not to include in the bundle.
+      "declarations"?: boolean, // emit typescript declarations.
+    }
+  }
+}
+```
+
+Or if calling via the command line:
+```sh
+bundle --tsc-external
+
+bundle --tsc-declarations
+
+bundle --indir <directory>
+
+bundle --outdir <directory>
+
+bundle --platform <browser | web | node | server | library>
+```
+### bundling
+
+By default this utility exports the `bundle` command; this command defaults to building mode, but it can be explicitly set if desired.
+
+```sh
+# These two commands are equivalent
+yarn bundle
+yarn bundle --build
+```
+
+### cleaning
+
+If you want bundle to delete the contents of the output directory, you can tell it to clean it:
+
+```sh
+yarn bundle --clean
+```
+
+### Logging
+
+Increase logging with the `--verbose` and `--debug` flags. Decrease logging with the `--quiet` flag.
+
+```sh
+yarn bundle --verbose
+yarn bundle -v
+
+yarn bundle --debug
+
+yarn bundle --quiet
+yarn bundle -q
+```
+
+### entrypoints
+
+All files ending in `.static.<ext>`, `.node.<ext>`, and `.web.<ext>` are automatically picked up as entrypoints.
+
+Any files you don't want to name with such a suffix can be added manually. To add the files `anchovies.ts` and `pics/cartoons.png` manually:
+
+*via `package.json`:*
+```json
+{
+  "bundle": {
+    "entrypoints": [ "anchovies.ts", "pics/cartoons.png" ]
+  }
+}
+```
+
+*via cli:*
+```sh
+yarn bundle --entrypoint anchovies.ts --entrypoint pics/cartoons.png
+```
+
+### analyse
+
+To get a report on bundle content and size enable analysis:
+
+*`package.json`*:
+```json
+{
+  "bundle": {
+    "analyse": true
+  }
+}
+```
+
+*via cli:*
+```sh
+bundle --analyse
+```
+
 # Development
 
+Feel free to contribute to the codebase, issues and code welcome.
+
 ## build pipeline
 
-`@normed/bundle` is bootstrapped by being built from typescript to javascript first (using `tsc`, output to `dist`), then using the javascript output to build the original source (output to `bundles-a`), then using that output to build the original source again (output to `bundles`), and finally the last two outputs are compared to ensure they are the same.
+`@normed/bundle` is bootstrapped by being built from typescript to javascript first (using `tsc`, output to `dist`), then using the javascript output to build the original source (output to `bundles-a`), then using that output to build the original source again (output to `bundles`), and finally the last two outputs are compared to ensure they are the same. This acts as a nice little test to check some of the functionality of `@normed/bundle`.