documentcloud / documentcloud/underscore-contrib
TypeScript typings and possibly also Flow typings
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 622
- Forks
- 114
- PR merge metrics
- No merged PRs in 30d
Description
It would be nice to have type declarations included within the repository and published to NPM, so that users don't need to rely on third-party type declarations (at least not for Contrib itself). This has been on @joshuacc's wish list but there was no ticket for it yet, at least not as far as I could tell.
I suggest to consider this a low priority enhancement. For maintenance reasons, it is probably best to wait with this at least until after #220 and https://github.com/DefinitelyTyped/DefinitelyTyped/pull/45201.
A note to whoever might take up on this in the future: we have a convention in Underscore to write the source code proper in pure ES3 (with ES6 import/export for module linking only), so that it is ready to ship to all supported environments without any transpilation. I'd prefer to uphold this same convention in Contrib. So if you decide to add type declarations, please keep them separate from the source code proper.
(I don't mean to rule out that I might add the typings myself, by the way, but everyone is welcome to do it.)
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 issue #220 and DefinitelyTyped pull request #45201, then determine the repository and package-publishing locations for separate TypeScript and possible Flow declarations. Done means declarations are included in the repository and published to NPM without changing the ES3 source convention.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- developer-experience, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100