Reorganize modules/exports and auto-generate docs

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Deploy Docs Site
+on:
+  push:
+    branches:
+    - master
+
+# Prohibit concurrent workflows
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+    - uses: actions/checkout@v6
+    - run: corepack enable
+    - uses: actions/setup-node@v6
+      with:
+        node-version-file: .node-version
+        cache: yarn
+    - run: yarn install --immutable
+    - run: yarn build:docs
+    - id: deployment
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      pages: write
+    needs: build
+    steps:
+    - id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/lint.yml

@@ -8,17 +8,17 @@ on:
     - master
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
     permissions:
       contents: read
       id-token: write
     steps:
-      - uses: actions/checkout@v6
-      - run: corepack enable
-      - uses: actions/setup-node@v6
-        with:
-          node-version-file: .node-version
-          cache: yarn
-      - run: yarn install --immutable
-      - run: yarn lint
+    - uses: actions/checkout@v6
+    - run: corepack enable
+    - uses: actions/setup-node@v6
+      with:
+        node-version-file: .node-version
+        cache: yarn
+    - run: yarn install --immutable
+    - run: yarn lint

.github/workflows/publish.yml

@@ -1,22 +1,23 @@
-name: Publish
+name: Publish to NPM
 on:
+  # Trigger when a new release is published on the Github repo
   release:
     types: [published]
 
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
     permissions:
       contents: read
       id-token: write
     steps:
-      - uses: actions/checkout@v6
-      - run: corepack enable
-      - uses: actions/setup-node@v6
-        with:
-          node-version-file: .node-version
-          registry-url: https://registry.npmjs.org/
-          cache: yarn
-      - run: yarn install --immutable
-      - run: yarn test
-      - run: yarn npm publish --access public
+    - uses: actions/checkout@v6
+    - run: corepack enable
+    - uses: actions/setup-node@v6
+      with:
+        node-version-file: .node-version
+        registry-url: https://registry.npmjs.org/
+        cache: yarn
+    - run: yarn install --immutable
+    - run: yarn test
+    - run: yarn npm publish --access public

.github/workflows/test.yml

@@ -8,17 +8,17 @@ on:
     - master
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     permissions:
       contents: read
       id-token: write
     steps:
-      - uses: actions/checkout@v6
-      - run: corepack enable
-      - uses: actions/setup-node@v6
-        with:
-          node-version-file: .node-version
-          cache: yarn
-      - run: yarn install --immutable
-      - run: yarn test
+    - uses: actions/checkout@v6
+    - run: corepack enable
+    - uses: actions/setup-node@v6
+      with:
+        node-version-file: .node-version
+        cache: yarn
+    - run: yarn install --immutable
+    - run: yarn test

.gitignore

@@ -3,6 +3,7 @@
 node_modules
 auth.js
 dist
+docs
 npm-debug.log
 
 screeps.json