From 09edfd9433c046a44cc1cdd90a1555ddf829c5d1 Mon Sep 17 00:00:00 2001
From: Lukasz Zimnoch <lukasz.zimnoch@keep.network>
Date: Fri, 3 Nov 2023 15:45:46 +0100
Subject: [PATCH] Add `typescript-docs` pre-commit hook

This hook runs `yarn docs` to re-generate API reference docs before each
commit touching SDK files.
---
 .pre-commit-config.yaml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index f63f7acc3..b57092008 100644
--- 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"