From 9d68d8d311fd6a73ecab5ce0946dbde687c54728 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Tue, 19 Dec 2023 10:39:49 -0300 Subject: [PATCH] Add CI check to enforce no doc warning --- .github/workflows/test-suite.yaml | 4 ++++ package.json | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test-suite.yaml b/.github/workflows/test-suite.yaml index ca852035..d979df91 100644 --- a/.github/workflows/test-suite.yaml +++ b/.github/workflows/test-suite.yaml @@ -32,3 +32,7 @@ jobs: - name: 🧪 Run tests run: | nix develop --show-trace --command bash -c "npm test" + + - name: 🏥 Check docs generation + run: | + nix develop --show-trace --command bash -c "npm run docs" diff --git a/package.json b/package.json index f6e59a65..d99c6653 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "build": "tsc --version && tsc --build && shx mkdir -p dist && rollup --config rollup/config.mjs", "clean": "npm run clean --workspaces && shx rm -rf dist", "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' jest", - "docs": "typedoc .", + "docs": "typedoc . --treatWarningsAsErrors", "serve": "ws --port 1337 --rewrite '/importmap -> https://cdn.jsdelivr.net/gh/input-output-hk/marlowe-ts-sdk@0.2.0-beta/jsdelivr-npm-importmap.js'", "serve-dev": "ws --port 1337 --rewrite '/importmap -> /dist/local-importmap.js'" },