Build tooling and packaging updates (#46)

- Remove DeviceVersion exported const enum in favour of a union (breaking change due for code like `DeviceVersion.V1` but not expected to have wide impact. The values are unchanged.).
- Remove UMD build. Stop offering a browser oriented bundle.
    - If we know of any real-world script-tag-only users then I'm open to reinstating this but I'm really dubious it's worth it.
- CJS now uses dependencies rather than bundles to aid use alongside microbit-connection (avoiding duplicating nrf-intel-hex in that scenario).
- Fix ES module so it works with Node's ES module support (exports in package.json, .js file extensions on imports)
- Emit more modern JavaScript (ES2021, consistent with microbit-connection).
- Consolidate documentation into typedoc 
    - Move the markdown content into typedoc's build so we don't have separation and simplify
    - Drop the unmaintained theme
    - Move to GHA publishing it to GitHub pages
    - This is now simple enough I can imaging rolling it out to other libraries
- Update linting, TypeScript etc.
    - Intending to port most of this to typescript-library-starter, but hopefully using NodeNext there.
- Stuck on "node10" TypeScript bundleResolution for the same reason as microbit-foundation/microbit-connection#51

Other than DeviceVersion there's no code-level behaviour change but it's likely also a breaking change due to the ES2020 emit and the packaging changes so bumping version to 0.10.0. I think it should generally be easier to consume in modern projects while still working in CJS/webpack 5 type setups.

Author: microbit-matt-hillsdon

.github/workflows/build-docs.yml

@@ -0,0 +1,38 @@
+name: build-docs
+on:
+  release:
+    types: [created]
+  push:
+    branches:
+      - master
+    tags:
+      - '**'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - run: npm ci
+      - name: Build docs
+        run: npm run docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/build
+
+  deploy:
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/build.yml

@@ -18,8 +18,7 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
           cache: npm
       - run: npm ci
-      - run: npm run test:coverage
-      - run: npm run build
+      - run: npm run ci
       - run: npm publish
         if: github.event_name == 'release' && github.event.action == 'created'
         env:

.gitignore

@@ -13,11 +13,13 @@ lib-fesm
 fesm
 umd
 bundles
-dist
+dist/
 
 ## this is generated by `npm pack`
 *.tgz
 package
 
+docs/build/
+
 # This is just for personal use
 ignore/

.npmignore

@@ -30,3 +30,5 @@ examples
 ## this is generated by `npm pack`
 *.tgz
 package
+
+**/__tests__/**

.vscode/settings.json

@@ -8,7 +8,5 @@
   "typescript.implementationsCodeLens.enabled": true,
   "typescript.referencesCodeLens.enabled": true,
   "javascript.referencesCodeLens.enabled": true,
-  "editor.rulers": [
-    80,100
-  ]
+  "editor.rulers": [80, 100]
 }

CONTRIBUTING.md

@@ -1,10 +1,8 @@
 Thanks for looking here! We'd love your help. The micro:bit project is only
 possible through contributions of companies and individuals around the world.
 
-This project is managed on GitHub, and the best way to contribute is to jump in
-and fix/file issues.
-
-https://github.com/microbit-foundation/microbit-fs
+This project is managed [in this GitHub project](https://github.com/microbit-foundation/microbit-fs), and the best way to contribute
+is to jump in and fix/file issues.
 
 If you're interested in working on any of these items, please file an issue
 and mention @microbit-carlos.