Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Where should maintainers put their definition files? #639

Open
simonbear89 opened this issue Jul 20, 2016 · 4 comments
Open

Where should maintainers put their definition files? #639

simonbear89 opened this issue Jul 20, 2016 · 4 comments
Labels

Comments

@simonbear89
Copy link

Hello, I maintain the mongoose definitions for DefinitelyTyped.
I noticed these typings could appear in multiple places:

  1. DefinitelyTyped
  2. Typings registry
  3. @types/mongoose
  4. mongoose repo on github (does not exist yet)
    more...?

Is there currently 1 preferred place to put my Typescript Definitions?
Or should I maintain the definitions across all of these places?

@blakeembrey
Copy link
Member

If you're comfortable with DefinitelyTyped, you can continue to maintain them there. If you're asking why Typings also has a definition, it's just easier for people to maintain. The reason Typings exists is to make it easier to consume, publish and manage type dependencies. Having a mono-repo makes it very hard for a maintainer to maintain their definition.

So currently DefinitelyTyped === @types/mongoose. In the near future the Typings registry will be merged with DefinitelyTyped as pointers, which would mean Typings === DefinitelyTyped === @types/mongoose. No sure what 4 is. However, for the merge, one definition will probably take precedence over the other and I imagine we'll need to figure that out - typings in Typings are already in the correct format for moving forward, while typings in DefinitelyTyped will be refactored anyway.

@simonbear89
Copy link
Author

simonbear89 commented Jul 20, 2016

@blakeembrey Okay I see. Thanks for your answer. I actually prefer the way Typings handles the definitions. It just seemed like DefinitelyTyped was a lot more active than the typings registry, which got me confused. But good to know we're working on a way to standardize this process.

@akeating
Copy link

akeating commented Sep 30, 2016

@blakeembrey apologies for missing the discussion around the merge. Is there a timetable for this and any protocol for handling conflicts where the package exists in both repos?

@blakeembrey
Copy link
Member

blakeembrey commented Sep 30, 2016

@akeating Waiting for microsoft/types-publisher#4. On conflicts, I'm not sure what to suggest - there's a reason people use the Typings structure as maintainers (myself included). It makes it easier on us and avoids the bundle of deserted definitions that is DefinitelyTyped, so I imagine Typings will continue to exist until Microsoft can support redirects and we can contribute to @types on NPM.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants