DavidWells / DavidWells/analytics
Update, improve and refactor JSDocs types for core
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2.7k
- Forks
- 267
- PR merge metrics
- No merged PRs in 30d
Description
Currently we have a custom JSDoc type setup and was created before typescript supported JSDoc types natively. It's about time we modernize this 😅
We need to refactor how the types get emitted to just using regular TypeScripts and emit out the file.
Also, while you're at it, we need to check out the doc types and verify that everything is correct.
So all the code will remain JS but be types with JSDocs. Start with the types in core https://github.com/DavidWells/analytics/tree/master/packages/analytics-core/src
The "types": "../../node_modules/.bin/jsdoc -t ../../node_modules/tsd-jsdoc/dist -r ./src/ -d _temp-types && node scripts/types.js", is ollllddddd and clunky.
Thanks @claude
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in packages/analytics-core/src and inspect the package types command that invokes jsdoc, tsd-jsdoc, and scripts/types.js. Review how the core JSDoc types are currently emitted and verify the documented types as you work. Done means the code remains JavaScript with JSDoc types, while type generation uses the modernized setup and emits correct files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- build-system, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100