openedx / openedx/frontend-build
Migrate JSDoc type definitions to TypeScript
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 25
- Forks
- 41
- Avg merge
- 3d 14h
- Merged PRs (30d)
- 5
Description
Some files rely on JSDoc-style type definitions despite the repository now having first-class support for TypeScript (e.g., in the paragonUtils.js file [soon to be merged, source link TBD]).'
To improve maintainability and confidence in future refactors, migrating these JSDoc type definitions to TypeScript would be beneficial.
Example JSDoc type definitions:
/**
* @typedef {Object} ParagonThemeCssAsset
* @property {string} filePath
* @property {string} entryName
* @property {string} outputChunkName
*/
### Tasks
- [ ] Migrate JSDoc-style type definitions to TypeScript.
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 by reviewing the referenced paragonUtils.js file once its source link is available, then inventory the other files that use JSDoc-style type definitions. Compare the existing TypeScript support in the repository and define completion as migrating the identified definitions to TypeScript without leaving the listed JSDoc typedefs behind.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100