release: v0.0.4

NickKelly1 · Jul 30, 2021 · 733c237 · 733c237
1 parent bc8152c
commit 733c237
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 19 deletions.
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -28,7 +28,6 @@ jobs:
           node-version: 14
           registry-url: https://registry.npmjs.org/
       - run: npm ci
-      - run: npm run build
-      - run: npm publish --access public
+      - run: npm publish dist --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
diff --git a/README.md b/README.md
@@ -1,8 +1,34 @@
 # @nkp/error
 
-Coerce an unknown error into an instance of the Error class
+[![npm version](https://badge.fury.io/js/%40nkp%2Ferror.svg)](https://badge.fury.io/js/%40nkp%2Ferror)
+[![Node.js Package](https://github.com/NickKelly1/nkp-error/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/NickKelly1/nkp-error/actions/workflows/npm-publish.yml)
+![snyk](https://snyk-widget.herokuapp.com/badge/npm/%40nkp%2Ferror/badge.svg)
 
-## Examples
+Coerce an unknown error into an instance of the Error class.
+
+## Installation
+
+This package exports as CommonJS (default), ES Modules, and UMD.
+
+For ES Modules and tree shaking use a bundler that supports ES modules such as [rollup](https://rollupjs.org/guide/en/) or [webpack](https://webpack.js.org/).
+
+### With npm
+
+```sh
+npm install @nkp/error
+```
+
+### With script tags
+
+```html
+<head>
+  <!-- insert your desired version -->
+  <script src="https://unpkg.com/browse/@nkp/[email protected]/"></script>
+</head>
+
+```
+
+## Usage
 
 ```ts
 try {
@@ -26,12 +52,12 @@ catch(error) { assert(typeof error === 'string')
 
 in this case, since a `string` is thrown and not an `Error` instance, there is no way to obtain the stack trace from the thrown point. Instead, `coerceError` will start the stack trace in the `catch` block.
 
-## Releasing a new version
+## Publishing
 
 To a release a new version:
 
 1. Update the version number in package.json
 2. Push the new version to the `master` branch on GitHub
 3. Create a `new release` on GitHub for the latest version
 
-This will trigger a GitHub action that tests and publishes the npm package.
+A GitHub action will test and publishes the npm package. Note, the `dist` folder is published.
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.0.4 - 2021-06-29
+
+### Added
+
+- UMD exports
+
+### Changed
+
+- Instead of the root folder, the `dist` folder is now published. The published project structure is now:
+  - d: dist (published)
+    - f: LICENSE
+    - f: package.json
+    - d: es (project as es modules)
+    - d: cjs (project as cjs)
+    - d: umd (project as umd)
+- Updated readme with badges and more information.
+- Temporarily disabled terser rollup plugin. Builds will temporarily not minified.
+
 ## 0.0.2 - 2021-06-29
 
 Re-release

diff --git a/config/rollup.config.js b/config/rollup.config.js
@@ -12,23 +12,29 @@ export default [
     input: 'src/index.ts',
     output: [
       {
-        file: packageJson.main,
+        file: `dist/${packageJson.main}`,
         format: 'cjs',
         sourcemap: true,
       },
       {
-        file: packageJson.module,
+        file: `dist/${packageJson.module}`,
         format: 'es',
         exports: 'named',
         sourcemap: true,
       },
+      {
+        name: '$nkp',
+        file: `dist/${packageJson.umd}`,
+        format: 'umd',
+        sourcemap: true,
+      },
     ],
     plugins: [
       peerDepsExternal(),
       resolve(),
       commonjs(),
       typescript({ tsconfig: 'config/tsconfig.build.json', }),
-      terser(),
+      // terser(),
     ],
   },
 ];
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,9 +1,10 @@
 {
   "name": "@nkp/error",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Coerce an unknown error into an instance of the JavaScript Error class",
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
+  "main": "cjs/index.js",
+  "module": "es/index.js",
+  "umd": "umd/index.js",
   "author": "Nick Kelly",
   "homepage": "https://github.com/NickKelly1/nkp-error#readme",
   "readme": "https://github.com/NickKelly1/nkp-error#readme",
@@ -20,15 +21,11 @@
     "TypeScript",
     "JavaScript"
   ],
-  "files": [
-    "dist",
-    "LICENSE"
-  ],
   "scripts": {
     "test": "jest -c config/jest.config.ts",
     "build": "rimraf dist && rollup -c config/rollup.config.js",
     "test:watch": "jest -c config/jest.config.ts --watch",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build && cp package.json dist/ && cp LICENSE dist/"
   },
   "devDependencies": {
     "@jest/types": "^26.6.2",