docs: remove *.const.ts files from the module index (#41)

* build: bring more consistency to the github workflow definitions

* docs: exclude *.const.ts from the documentation index

* build: forgive breakages in docs when pushing branches

Author: brianrodri

.github/workflows/ci.yml

@@ -1,29 +1,33 @@
 name: CI
 on:
-    push:
-        branches: [main]
-    pull_request:
-        branches: [main]
+    pull_request: { branches: [main] }
+    push: { branches: [main] }
 
 jobs:
     build:
-        name: ci
+        name: build:ci
         runs-on: ubuntu-latest
+
         steps:
             - name: Checkout
               uses: actions/checkout@v4
+
             - name: Setup Node.js
               uses: actions/setup-node@v4
               with: { node-version: latest }
+
             - name: Install dependencies
               run: npm clean-install
               env: { HUSKY: 0 }
-            - name: Run CI tasks
+
+            - name: Build with CI checks
               run: npm run build:ci
+
             - name: Upload test results to Codecov
               if: ${{ !cancelled() }}
               uses: codecov/test-results-action@v1
               with: { token: "${{ secrets.CODECOV_TOKEN }}" }
+
             - name: Upload coverage to Codecov
               if: ${{ !cancelled() }}
               uses: codecov/codecov-action@v5

.github/workflows/docs.yml .github/workflows/documentation.yml

@@ -1,8 +1,6 @@
 name: Documentation
-
 on:
     push: { branches: [main] }
-    workflow_dispatch:
 
 permissions:
     contents: read
@@ -15,28 +13,34 @@ concurrency:
 
 jobs:
     deploy:
-        name: docs
+        name: build:docs
+        runs-on: ubuntu-latest
         environment:
             name: github-pages
             url: ${{ steps.deployment.outputs.page_url }}
-        runs-on: ubuntu-latest
+
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Setup Pages
-              uses: actions/configure-pages@v5
+
             - name: Setup Node.js
               uses: actions/setup-node@v4
               with: { node-version: latest }
 
+            - name: Setup Pages
+              uses: actions/configure-pages@v5
+
             - name: Install dependencies
               run: npm clean-install
               env: { HUSKY: 0 }
+
             - name: Build documentation
               run: npm run build:docs
+
             - name: Upload artifact
               uses: actions/upload-pages-artifact@v3
               with: { path: "docs/" }
+
             - name: Deploy to GitHub Pages
               id: deployment
               uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -1,30 +1,35 @@
 name: Release
-on: workflow_dispatch
+on:
+    workflow_dispatch:
 
 permissions:
-    contents: read # for checkout
+    contents: read
 
 jobs:
     release:
-        name: Release
+        name: build:release
         runs-on: ubuntu-latest
         permissions:
-            contents: write # to be able to publish a GitHub release
-            issues: write # to be able to comment on released issues
-            pull-requests: write # to be able to comment on released pull requests
-            id-token: write # to enable use of OIDC for npm provenance
+            contents: write
+            issues: write
+            pull-requests: write
+            id-token: write
+
         steps:
             - name: Checkout
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
+
             - name: Setup Node.js
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with: { node-version: latest }
 
             - name: Install dependencies
               run: npm clean-install
               env: { HUSKY: 0 }
-            - name: Ensure CI passes
+
+            - name: Build with CI checks
               run: npm run build:ci
+
             - name: Release update
               env: { GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" }
               run: npx semantic-release

.husky/pre-push

@@ -1,2 +1 @@
-npm run build:docs
 npm run test:coverage

src/model/task/util.ts

@@ -7,7 +7,6 @@ import { DEFAULT_PRIORITY_VALUE, DEFAULT_TYPE_VALUE, Task, TASK_WITH_DEFAULT_VAL
 /**
  * @param parts - the task parts to merge.
  * @returns a new {@link Task} with the front-most non-default values taken from the parts.
- * @see {@link TASK_WITH_DEFAULT_VALUES}
  */
 export function mergeTaskParts(...parts: DeepPartial<Task>[]): Task {
     const defaults = { ...TASK_WITH_DEFAULT_VALUES };

typedoc.config.js

@@ -6,7 +6,7 @@ export default {
     treatValidationWarningsAsErrors: true,
     plugin: ["typedoc-plugin-coverage", "@typhonjs-typedoc/typedoc-theme-dmt", "typedoc-plugin-dt-links"],
     theme: "default-modern",
-    exclude: ["./docs/**/*", "./node_modules/**/*", "**/__tests__/**/*"],
+    exclude: ["./docs/**/*", "./node_modules/**/*", "**/__tests__/**/*", "**/*.const.ts"],
 
     // https://github.com/typhonjs-typedoc/typedoc-theme-dmt#configuration
     dmtNavigation: { style: "flat" },