Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: setup documentation website & document codebase with typedoc comments #268

Merged
merged 4 commits into from
Jan 29, 2025
Merged

feat: setup documentation website & document codebase with typedoc comments #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
11b4638
feat: setup Docusaurus website
pedroalves0 Jan 28, 2025
e577803
chore: change type runtime validator from runtypes to zod
pedroalves0 Jan 28, 2025
3d6ea6a
chore: [BREAKING] remove restClient export
pedroalves0 Jan 28, 2025
21d950e
doc: add typedoc comments to codebase
pedroalves0 Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ node_modules/
scratch.ts

.vscode/
.DS_Store
1,232 changes: 871 additions & 361 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 13 additions & 9 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion src/TodoistApi.projects.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()

Expand Down
Loading