microsoft / microsoft/TypeScript-Website
publishing deep-dive is out of date regarding "exports"
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.6k
- Forks
- 1.5k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 7
Description
Page URL: https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html
publishing.html mentions "types" and "typings" fields but there are no comments about "exports" which I believe can supersede those. And I think they do not apply when there is a subpath based on documentation from https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-main-and-types.
https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports has good information about resolving; so, one could work backward if just given a reference there. But specific guidance on authoring is probably best.
"typings" is listed as an alias on publishing.html but is noted as legacy on modules/reference.html.
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 with publishing.html and compare its guidance on the "types" and "typings" fields with the package.json exports and main/types sections in modules/reference.html. Update the publishing guidance to address exports, subpaths, and the legacy status of "typings"; done means the two pages are consistent and link to the relevant reference material.
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
- 50/100