chore: install jsdoc to generate documentation

RuggeroVisintin · Dec 10, 2023 · 0cfd277 · 0cfd277
1 parent 6a89cd6
commit 0cfd277
Show file tree

Hide file tree

Showing 4 changed files with 236 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -5,9 +5,13 @@ dist/
 src/**/*.js
 src/**/*.d.ts
 
+.vscode
 .DS_Store
+
+docs/
+
 /test-results/
 /playwright-report/
 /blob-report/
 /playwright/.cache/
-.vscode
+
diff --git a/jsdoc.conf.json b/jsdoc.conf.json
@@ -0,0 +1,20 @@
+{
+    "plugins": [],
+    "recurseDepth": 10,
+    "source": {
+        "includePattern": ".+\\.ts(doc|x)?$",
+        "excludePattern": "(^|\\/|\\\\)_"
+    },
+    "sourceType": "module",
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": [
+            "jsdoc",
+            "closure"
+        ]
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -44,6 +44,7 @@
     "jest-canvas-mock": "^2.5.2",
     "jest-environment-jsdom": "^29.7.0",
     "jest-extended": "^4.0.2",
+    "jsdoc": "^4.0.2",
     "release-please": "^16.4.0",
     "semantic-release": "^22.0.10",
     "ts-jest": "^29.1.1",