microsoft / microsoft/TypeScript
Provide a clear and explicit TypeScript pkg.types alternative, such as pkg.typescriptTypes
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
package.types, package.json types, types, typings, ts-types
Suggestion
It would be great if TS provided an additional alias for package.json's types/typings fields.
This new alias should make it clear it refers to TypeScript types, so that projects that provide more than one type system can avoid ambiguity.
A possible solution would be a new ts-types field.
Use Cases
See "Suggestion"
Examples
{
"name": "my-library",
"ts-types": "ts-types/index.d.ts"
}
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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 how package.json's types and typings fields are currently interpreted, along with the FAQ's Common Feature Requests section. Define the proposed TypeScript-specific alias and its compatibility with existing package metadata; done would require an agreed design and implementation validated against package-resolution behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100