microsoft / microsoft/DefinitelyTyped-tools
Recommend to install with `--save-dev` when types are not part of the external API
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 423
- Forks
- 237
- Avg merge
- 18h 18m
- Merged PRs (30d)
- 11
Description
The current generated README shows the install example with --save option:
Wouldn't it be valuable to instruct users whether to choose --save or --save-dev for types?
For example:
If the types are consumed only within your package, install it with
--save-devoption:npm install --save-dev ...If your package directly or indirectly exports the types, use the
--saveoption instead of--save-dev.
Contributor guide
No contributing guide indexed for this repository
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/publisher/src/generate-packages.ts around line 176, where the generated README install example uses --save. Determine how the generator can distinguish types used only internally from types exported by the package, then regenerate the README and verify that internal types recommend --save-dev while exported types retain --save.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100