search

atom-community / atom-ide-base

Atom IDE packages for Atom
https://atom.io/packages/atom-ide-base
Other
44 stars 10 forks source link

Do we need the Datatip types in this repository? #41

Open illright opened 3 years ago

illright commented 3 years ago

Now that atom-ide-datatip has been converted to TypeScript, perhaps, we could move the types away from here and into the atom-ide-datatip repository.

bennypowers commented 3 years ago

Whether or not this is adopted, all type comments should be changed from line comments (// ...) to docblock comments (/** ... */). The reason for this is to allow tooling to pick up the types' descriptions when generating docs pages. See https://github.com/atom-community/atom-community.github.io/pull/8

lierdakil commented 3 years ago

Not a great idea, since atom-ide-datatip is not an npm dependency, and it doesn't need to be (I would argue it shouldn't be). If you move the types to atom-ide-datatip, getting the type definitions would get harder with no apparent benefit. In any case, having a separate API type spec for a public-facing project is a good idea -- I wouldn't recommend relying on tsc-generated definitions, because that could make things very unstable unless everyone involved is very, very careful. So if the only question is where to keep those, I think here is fine.

What you should do in my opinion is install this as a dependency (via devDependenices obviously) in atom-ide-datatip and use the types defined here as interfaces (via extends/ implements) to make sure everything is consistent. That is, if you didn't do that already, which, judging by the question in OP, I assume you didn't.

aminya commented 3 years ago

We can look into moving the types to each repository, but we should still provide them here using git submodules.