Build tooling, packaging updates, and documentation site (#42)

- Update tooling and build to generate ESM and CJS bundle (consistent with microbit-fs).
- Use "ESNext" as module and "type: module".
- Use TypeDoc to generate documentation site, simplify docs, and add GH workflow for it.

Co-authored-by: Matt Hillsdon <[email protected]>

Author: microbit-grace

.github/workflows/build-docs.yml

@@ -0,0 +1,39 @@
+name: build-docs
+on:
+  release:
+    types: [created]
+  push:
+    branches:
+      - '**'
+    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:
+    if: ${{ startsWith(github.ref, 'refs/tags/') }}
+    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:

.npmignore

@@ -10,7 +10,6 @@ tslint.json
 **/prettier.config.js
 
 # build scripts
-config/
 scripts/
 
 # Test files
@@ -30,3 +29,5 @@ examples
 ## this is generated by `npm pack`
 *.tgz
 package
+
+**/__tests__/**