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

Is there interest in enhancing TypeScript support? #363

Open
henrygab opened this issue Jun 17, 2022 · 1 comment
Open

Is there interest in enhancing TypeScript support? #363

henrygab opened this issue Jun 17, 2022 · 1 comment

Comments

@henrygab
Copy link

I LOVE what WaveDrom enables.

When manually editing, to generate a fixed (predetermined) timing diagrams, it truly excels.

When trying to move into programmatically generating multiple diagrams, then there's some bumps.

Most of those bumps relate to discoverability. Most of the discoverability issues could be resolved by specifying the types expected for function parameters, and what to expect as results when functions return. Well, that and having a list of what's intended to be public. These are all things that are hampered in part by the type-less nature of Javascript.

Is there any interest in converting WaveDrom to TypeScript, so that type information can be slowly added?

@henrygab
Copy link
Author

I'm moving forward with this. The existing code's complexity has exceeded the area where native Javascript shines brighter than TypeScript. Incrementally increasing type safety will both improve documentation, and catch (at compile time) additional errors ... thus making it easier to safely add new features (e.g., new arrow / spline / line types).

I'm also looking to increase automated testing ... so that any change in output for known test cases must be manually validated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant