[Doc] Add JSDoc linter & general comment clean up (#611)

- Prefer comments above lines over end-of-line comments
  - Makes auto-formatting easier
  - Subjective, but it is generally easier to read in JS
- Standardises JSdoc format
- Auto-fixes for many issues (applies on save w/ESLint extension)
This commit is contained in:
filtered
2025-02-26 19:54:18 +11:00
committed by GitHub
parent d849fcd00c
commit 9ded97d189
21 changed files with 473 additions and 252 deletions

View File

@@ -51,6 +51,7 @@
"@types/eslint__js": "^8.42.3",
"@types/node": "^22.1.0",
"eslint": "^9.14.0",
"eslint-plugin-jsdoc": "^50.6.3",
"eslint-plugin-unused-imports": "^4.1.4",
"globals": "^15.12.0",
"husky": "^9.1.7",
@@ -59,7 +60,7 @@
"prettier": "^3.3.3",
"ts-node": "^10.9.2",
"typescript": "^5.6.3",
"typescript-eslint": "^8.14.0",
"typescript-eslint": "^8.25.0",
"typescript-strict-plugin": "^2.4.4",
"vite": "^6.2.0",
"vite-plugin-dts": "^4.3.0",