Add typescript-docs pre-commit hook

This hook runs `yarn docs` to re-generate API reference docs before each commit touching SDK files.
keep-network · Nov 3, 2023 · 09edfd9 · 09edfd9
1 parent 2cf0c94
commit 09edfd9
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -41,3 +41,9 @@ repos:
         files: "^cross-chain/arbitrum/"
         language: script
         description: "Checks cross-chain/arbitrum directory code according to the formatting configuration"
+      - id: typescript-docs
+        name: "Generate typescript API reference docs"
+        entry: /usr/bin/env bash -c "cd typescript && yarn docs"
+        files: "^typescript/"
+        language: script
+        description: "Generates typescript API reference docs according to the typedoc configuration"