package-build-javascript/README.md at feb63620f13a90c16a1e3358cb30561aaf3dfe53 · cabify/package-build-javascript

@cabify/package-build

Package build configuration based on Rollup to compile JS packages.

Install this package as a dev dependency in your package, then create scripts in your package.json invoking it like this:

  "dist": "package-build",
  "dist:watch": "package-build -w",

NOTICE: this package doesn't clean your build directories in each run, so you'd probably want to append something like rimraf to your dependencies.

-w to watch the files.
-p to define a different tsconfig.ts file. p.eg: package-build -p tsconfig.build.json.
-m or --preserve-modules to enable tree-shaking optimization (see below).

For libraries with many exports (like icon libraries), use the --preserve-modules flag to generate individual files instead of a single bundle:

package-build --preserve-modules
package-build -m

This enables effective tree-shaking for consumers using modern bundlers. When enabled:

Recommended package.json configuration for tree-shakable libraries:

{
  "sideEffects": false,
  "exports": {
    ".": {
      "import": "./es2015/index.js",
      "require": "./dist/index.js"
    }
  }
}

Update CHANGELOG with new features, breaking changes, etc
Check you're in main branch and everything is up-to-date.
Run yarn publish:<major|minor|patch> or yarn publish:canary for canary versions.
Run git push && git push --tags
Check all test actions triggered after previous push are ✔️.
Go to create a new release, select previously pushed tag and write a Title.
Check the action for publish the npm has finished with success.
Check on npm package webpage, the version has been published successfully under latest tag.

Thanks goes to these wonderful people (emoji key):

_Alejandro 💻	_{Alejandro Gallardo Escobar} 💻	_{Alejandro León} 💻	_{Alex Temina} 💻	_{Arian Zargaran} 💻	_Crismmgg 💻	_{Francisco Sánchez} 💻
_{Javier López} 💻	_{Valentin Berlin} 💻