From ad08cf806cb1841c2ce2d6c0f8ba9c6d6857a7e0 Mon Sep 17 00:00:00 2001
From: Vivian Plasencia <v.pcalana@gmail.com>
Date: Wed, 17 Apr 2024 21:48:17 +0200
Subject: [PATCH] feat: add typedoc

---
 .eslintignore   |  1 +
 .gitignore      |  1 +
 .prettierignore |  1 +
 package.json    |  2 ++
 typedoc.json    |  5 ++++
 yarn.lock       | 68 ++++++++++++++++++++++++++++++++++++++++++++++++-
 6 files changed, 77 insertions(+), 1 deletion(-)
 create mode 100644 typedoc.json

diff --git a/.eslintignore b/.eslintignore
index 9cc0dd8..7bf1f8e 100644
--- a/.eslintignore
+++ b/.eslintignore
@@ -11,6 +11,7 @@ coverage.json
 # production
 dist
 build
+/docs
 
 # misc
 .DS_Store
diff --git a/.gitignore b/.gitignore
index c797133..45f8feb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -56,6 +56,7 @@ node_modules/
 # Production
 build
 dist
+/docs
 
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
diff --git a/.prettierignore b/.prettierignore
index 2039c20..c9c34e8 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -11,6 +11,7 @@ coverage.json
 # production
 dist
 build
+/docs
 
 # github
 .github/ISSUE_TEMPLATE
diff --git a/package.json b/package.json
index 22cfc63..adacf7d 100644
--- a/package.json
+++ b/package.json
@@ -16,6 +16,7 @@
         "format": "yarn format:prettier",
         "format:write": "yarn format:prettier:write",
         "style": "yarn lint && yarn format",
+        "docs": "typedoc --cname extensionstypes.semaphore.pse.dev --githubPages true",
         "version:bump": "yarn workspace @semaphore-extensions/${0} version ${1} && yarn remove:stable-version-field ${0} && NO_HOOK=1 git commit -am \"chore(${0}): v${1}\" && git tag ${0}-v${1}",
         "version:publish": "yarn workspaces foreach -A --no-private npm publish --tolerate-republish --access public",
         "version:release": "changelogithub",
@@ -54,6 +55,7 @@
         "rimraf": "^5.0.5",
         "ts-jest": "^29.1.2",
         "ts-node": "^10.9.2",
+        "typedoc": "^0.25.13",
         "typescript": "^5.4.4"
     }
 }
diff --git a/typedoc.json b/typedoc.json
new file mode 100644
index 0000000..d6b60db
--- /dev/null
+++ b/typedoc.json
@@ -0,0 +1,5 @@
+{
+    "entryPoints": ["packages/*"],
+    "name": "Semaphore Extensions",
+    "entryPointStrategy": "packages"
+}
diff --git a/yarn.lock b/yarn.lock
index d20cae4..b749a37 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3746,6 +3746,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"ansi-sequence-parser@npm:^1.1.0":
+  version: 1.1.1
+  resolution: "ansi-sequence-parser@npm:1.1.1"
+  checksum: 10/9ce30f257badc2ef62cac8028a7e26c368d22bf26650427192e8ffd102da42e377e3affe90fae58062eecc963b0b055f510dde3b677c7e0c433c67069b5a8ee5
+  languageName: node
+  linkType: hard
+
 "ansi-styles@npm:^3.2.1":
   version: 3.2.1
   resolution: "ansi-styles@npm:3.2.1"
@@ -7921,6 +7928,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lunr@npm:^2.3.9":
+  version: 2.3.9
+  resolution: "lunr@npm:2.3.9"
+  checksum: 10/f2f6db34c046f5a767782fe2454e6dd69c75ba3c5cf5c1cb9cacca2313a99c2ba78ff8fa67dac866fb7c4ffd5f22e06684793f5f15ba14bddb598b94513d54bf
+  languageName: node
+  linkType: hard
+
 "magic-string@npm:^0.25.7":
   version: 0.25.9
   resolution: "magic-string@npm:0.25.9"
@@ -7983,6 +7997,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"marked@npm:^4.3.0":
+  version: 4.3.0
+  resolution: "marked@npm:4.3.0"
+  bin:
+    marked: bin/marked.js
+  checksum: 10/c830bb4cb3705b754ca342b656e8a582d7428706b2678c898b856f6030c134ce2d1e19136efa3e6a1841f7330efbd24963d6bdeddc57d2938e906250f99895d0
+  languageName: node
+  linkType: hard
+
 "meow@npm:^12.0.1":
   version: 12.1.1
   resolution: "meow@npm:12.1.1"
@@ -8046,7 +8069,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"minimatch@npm:^9.0.1":
+"minimatch@npm:^9.0.1, minimatch@npm:^9.0.3":
   version: 9.0.4
   resolution: "minimatch@npm:9.0.4"
   dependencies:
@@ -9376,6 +9399,7 @@ __metadata:
     rimraf: "npm:^5.0.5"
     ts-jest: "npm:^29.1.2"
     ts-node: "npm:^10.9.2"
+    typedoc: "npm:^0.25.13"
     typescript: "npm:^5.4.4"
   languageName: unknown
   linkType: soft
@@ -9442,6 +9466,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"shiki@npm:^0.14.7":
+  version: 0.14.7
+  resolution: "shiki@npm:0.14.7"
+  dependencies:
+    ansi-sequence-parser: "npm:^1.1.0"
+    jsonc-parser: "npm:^3.2.0"
+    vscode-oniguruma: "npm:^1.7.0"
+    vscode-textmate: "npm:^8.0.0"
+  checksum: 10/be3f2444c65bd0c57802026f171cb42ad571d361ee885be0c292b60785f68c70f19b69310f5ffe7f7a93db4c5ef50211e0a0248794bc6bb48d242bc43fe72a62
+  languageName: node
+  linkType: hard
+
 "side-channel@npm:^1.0.4, side-channel@npm:^1.0.6":
   version: 1.0.6
   resolution: "side-channel@npm:1.0.6"
@@ -10122,6 +10158,22 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typedoc@npm:^0.25.13":
+  version: 0.25.13
+  resolution: "typedoc@npm:0.25.13"
+  dependencies:
+    lunr: "npm:^2.3.9"
+    marked: "npm:^4.3.0"
+    minimatch: "npm:^9.0.3"
+    shiki: "npm:^0.14.7"
+  peerDependencies:
+    typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x
+  bin:
+    typedoc: bin/typedoc
+  checksum: 10/3c82603894b5830c4b027b4f4f9ca70f770b6752c6512a42e780c40cb67fe4c9a144e34a837bb35aab14a125e00a5893e1e6feac1ec86a2add80f46833b279d4
+  languageName: node
+  linkType: hard
+
 "typescript@npm:^4.9.3":
   version: 4.9.5
   resolution: "typescript@npm:4.9.5"
@@ -10345,6 +10397,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"vscode-oniguruma@npm:^1.7.0":
+  version: 1.7.0
+  resolution: "vscode-oniguruma@npm:1.7.0"
+  checksum: 10/7da9d21459f9788544b258a5fd1b9752df6edd8b406a19eea0209c6bf76507d5717277016799301c4da0d536095f9ca8c06afd1ab8f4001189090c804ca4814e
+  languageName: node
+  linkType: hard
+
+"vscode-textmate@npm:^8.0.0":
+  version: 8.0.0
+  resolution: "vscode-textmate@npm:8.0.0"
+  checksum: 10/9fa7d66d6042cb090d116c2d8820d34c8870cfcbaed6e404da89f66b899970ed0ac47b59a2e30fc40a25af5414822bb3ea27974f714e9b91910d69c894be95f7
+  languageName: node
+  linkType: hard
+
 "walker@npm:^1.0.8":
   version: 1.0.8
   resolution: "walker@npm:1.0.8"