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

Investigate moving to JSDOC only insterad of TS #12

Open
Tokimon opened this issue Jul 30, 2024 · 0 comments
Open

Investigate moving to JSDOC only insterad of TS #12

Tokimon opened this issue Jul 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed question Further information is requested

Comments

@Tokimon
Copy link
Owner

Tokimon commented Jul 30, 2024

Since every function is documented by JSDOC anyway, maybe consider only using that over TS for type validation.

Issues to sort out

  • Have types understood by the IDE
  • Generate documentation JSON as normal
  • How to handle complex types

Advantages

  • No extra build step to transform TS to JS
  • Less Type complexity to handle
  • Possibly easier to handle complex types
  • Keep files as they are written if a "download-to-project" approach is taken (instead of a recompiled JS file from TS)

Disadvantages

  • No typescript means less confidence in the project (?)
  • Possibly less ways to handle complex types
@Tokimon Tokimon added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed question Further information is requested labels Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant