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

Use ChartIQ type declarations #606

Open
kenkunz opened this issue Oct 12, 2023 · 0 comments
Open

Use ChartIQ type declarations #606

kenkunz opened this issue Oct 12, 2023 · 0 comments
Assignees
Labels
priority: P2 Default priority. An issue might not yet be fixed in the next release. size: S A small task that can be completed in less than a day type: tech debt Technical debt

Comments

@kenkunz
Copy link
Contributor

kenkunz commented Oct 12, 2023

Goal

As a developer, I want better type safety when using the ChartIQ charting library, so that my code is less bug-prone and I have improved DX (intellisense, etc.)

Background

Our previous distribution of ChartIQ licensed code did not include type declarations. As of the 9.0.0 distribution, types are now included. We can and should make use of these – both to avoid bugs and improve DX. Bug #605 would likely have been avoided if we were using ChartIQ types.

This is somewhat non-trivial since ChartIQ is an optional dependency (due to its licensing requirements).

Acceptance criteria

  • When ChartIQ distro is included in local dev, type errors for ChartIQ types are highlighted in the IDE (e.g., VS Code)
  • When ChartIQ distro is included in local dev, IDE shows appropriate hints/suggestions based on type declarations
  • When ChartIQ distro is not included in local dev, nothing breaks (though ChartIQ-based charts will not be shown, as expected)
@kenkunz kenkunz added priority: P2 Default priority. An issue might not yet be fixed in the next release. size: S A small task that can be completed in less than a day type: tech debt Technical debt labels Oct 12, 2023
@kenkunz kenkunz self-assigned this Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: P2 Default priority. An issue might not yet be fixed in the next release. size: S A small task that can be completed in less than a day type: tech debt Technical debt
Projects
None yet
Development

No branches or pull requests

1 participant