DavidWells / DavidWells/analytics
Enhance & update type support
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2.7k
- Forks
- 267
- PR merge metrics
- No merged PRs in 30d
Description
Types were originally implemented with JSdoc before typescript proper supported this for type generation. This led to the kind of funky setup here.
The js first + JSdocs approach has been working well in a number of my other projects and it's time to update that over c'here 😃
Todo:
- Use
tsc --noEmit false --emitDeclarationOnly truefor cleaner typegen - Update variadic functions like
identityref
Related:
Reference material:
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 with packages/analytics-core/scripts/types.js and the existing JSDoc-based type-generation flow, then review the variadic-function concern for identity in issue #172. Use the specified tsc declaration-only command as the reference approach; done means type generation no longer needs the current setup and variadic functions have updated types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- developer-experience, tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100