From b7f742f5a19cccd2813413c383b605d3e9825579 Mon Sep 17 00:00:00 2001 From: Chris Hager Date: Mon, 19 Apr 2021 16:38:19 +0200 Subject: [PATCH] cleanup --- README.md | 5 +++-- package.json | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5286aec..82a003b 100644 --- a/README.md +++ b/README.md @@ -55,11 +55,12 @@ yarn esbuild-node:dev yarn esbuild-node:watch ``` -You can generate a full build with both `tsc` and `esbuild` with `yarn build-all`. +You can generate a full clean build with `yarn build-all` (which uses both `tsc` and `esbuild`). -* The `package.json` includes `scripts` for various esbuild commands: [see here](https://github.com/metachris/typescript-boilerplate/blob/master/package.json#L23) +* `package.json` includes `scripts` for various esbuild commands: [see here](https://github.com/metachris/typescript-boilerplate/blob/master/package.json#L23) * `esbuild` has a `--global-name=xyz` flag, to store the exports from the entry point in a global variable. See also the [esbuild "Global name" docs](https://esbuild.github.io/api/#global-name). * Read more about the esbuild setup [here](https://www.metachris.com/2021/04/starting-a-typescript-project-in-2021/#esbuild). +* esbuild for the browser uses the IIFE (immediately-invoked function expression) format, which executes the bundled code on load (see also https://github.com/evanw/esbuild/issues/29) ## Tests with Jest diff --git a/package.json b/package.json index a06354c..fa213bd 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "typescript-boilerplate-2021", "version": "0.4.1", - "description": "Boilerplate for a TypeScript library", + "description": "Boilerplate for TypeScript projects (Node.js and browser modules)", "author": "Chris Hager ", "repository": "https://github.com/metachris/typescript-boilerplate", "license": "MIT",