feat: setup documentation website & document codebase with typedoc co…

…mments (#268)
Doist · Jan 29, 2025 · bfd0e1d · bfd0e1d
1 parent fc59a9c
commit bfd0e1d
Show file tree

Hide file tree

Showing 86 changed files with 21,174 additions and 666 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -4,7 +4,7 @@
         "sourceType": "module",
         "project": ["tsconfig.json", "tsconfig.test.json"]
     },
-    "extends": ["@doist/eslint-config/recommended-requiring-type-checking"],
+    "extends": ["@doist/eslint-config/recommended-type-checked"],
     "env": {
         "browser": true,
         "jest": true

diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ node_modules/
 scratch.ts
 
 .vscode/
+.DS_Store
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -27,32 +27,36 @@
         "axios": "^1.0.0",
         "axios-case-converter": "^1.0.0",
         "axios-retry": "^3.1.9",
-        "runtypes": "^6.5.0",
         "ts-custom-error": "^3.2.0",
-        "uuid": "^9.0.0"
+        "uuid": "^9.0.0",
+        "zod": "^3.24.1"
     },
     "devDependencies": {
-        "@doist/eslint-config": "8.1.3",
-        "@doist/prettier-config": "3.0.5",
+        "@doist/eslint-config": "11.1.0",
+        "@doist/prettier-config": "4.0.0",
         "@types/jest": "29.4.0",
         "@types/uuid": "9.0.7",
-        "@typescript-eslint/eslint-plugin": "5.54.1",
-        "@typescript-eslint/parser": "5.54.1",
+        "@typescript-eslint/eslint-plugin": "6.21.0",
+        "@typescript-eslint/parser": "6.21.0",
+        "docusaurus-plugin-typedoc": "^1.2.2",
         "eslint": "8.35.0",
         "eslint-config-prettier": "8.7.0",
         "eslint-import-resolver-webpack": "0.13.2",
         "eslint-plugin-import": "2.27.5",
-        "eslint-plugin-prettier": "4.2.1",
+        "eslint-plugin-prettier": "5.1.3",
         "husky": "8.0.3",
         "jest": "29.5.0",
         "lint-staged": "13.1.4",
         "npm-run-all": "4.1.5",
-        "prettier": "2.8.4",
+        "prettier": "3.3.2",
         "rimraf": "3.0.2",
         "ts-jest": "29.0.5",
         "ts-node": "10.9.1",
         "type-fest": "^4.12.0",
-        "typescript": "4.9.5"
+        "typedoc": "^0.27.6",
+        "typedoc-plugin-markdown": "^4.4.1",
+        "typedoc-plugin-zod": "^1.3.1",
+        "typescript": "5.3.2"
     },
     "peerDependencies": {
         "type-fest": "^4.12.0"

diff --git a/src/TodoistApi.projects.test.ts b/src/TodoistApi.projects.test.ts
@@ -132,7 +132,7 @@ describe('TodoistApi project endpoints', () => {
         })
 
         test('returns success result from rest client', async () => {
-            const returnedProject = { ...DEFAULT_PROJECT, DEFAULT_UPDATE_PROJECT_ARGS }
+            const returnedProject = { ...DEFAULT_PROJECT, ...DEFAULT_UPDATE_PROJECT_ARGS }
             setupRestClientMock(returnedProject, 204)
             const api = getTarget()
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,4 @@ node_modules/
		scratch.ts

		.vscode/
		.DS_Store