Git Product home page Git Product logo

Comments (3)

lierdakil avatar lierdakil commented on June 3, 2024 1

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.

from atom-ide-base.

bennypowers avatar bennypowers commented on June 3, 2024

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

from atom-ide-base.

aminya avatar aminya commented on June 3, 2024

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

from atom-ide-base.

Related Issues (15)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.