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

Document Open MCT public API using TypeScript type declaration files #5781

Open
akhenry opened this issue Sep 16, 2022 · 0 comments
Open

Document Open MCT public API using TypeScript type declaration files #5781

akhenry opened this issue Sep 16, 2022 · 0 comments
Labels
type:maintenance tests, chores, or project maintenance

Comments

@akhenry
Copy link
Contributor

akhenry commented Sep 16, 2022

  • Note that this issue is not about re-implementing the API using TypeScript

Summary

The Open MCT public API should be documented in such a way that commonly used IDEs can provide inline documentation and useful code suggestions. A reasonable way of doing this is using external TypeScript declaration files. A lot of our API is already implemented in jsdoc which could potentially be used for auto-generating typescript declarations.

Stages

  1. Prototype by documenting one fairly simple API
  2. If necessary, lint our existing JSDocs and correct any issues in order to smooth the auto-generation of typescript definitions for the rest of our API
  3. ?
  4. Profit!
@akhenry akhenry added the type:maintenance tests, chores, or project maintenance label Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:maintenance tests, chores, or project maintenance
Projects
None yet
Development

No branches or pull requests

1 participant