Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
illright opened this issue Jan 23, 2021 · 3 comments
Open

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

illright opened this issue Jan 23, 2021 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@illright
Copy link

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
Copy link
Member

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 atom-community/atom-community.github.io#8

@lierdakil
Copy link
Contributor

lierdakil commented Jan 23, 2021

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
Copy link
Member

aminya commented Jan 24, 2021

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

@aminya aminya added good first issue Good for newcomers enhancement New feature or request labels Jan 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants