fix: Highcharts v12 side effect import sorting #219
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…er package imports Highcharts v12 introduces a new simpler way to import it's additional modules, which uses side effect imports to achieve. By default, eslint-plugin-simple-import-sort groups side effect imports at the top of the file, which makes `highcharts/modules/...` being imported before `highcharts`, resulting in a runtime error. To fix this, we add a custom `groups` config for `simple-import-sort/imports` to group Highcharts side effect imports after package imports. Highcharts v12 info: https://www.highcharts.com/blog/changelog/#:~:text=When%20importing%20Highcharts%20as%20a%20node%20module%2C%20additional%20modules%20no%20longer%20require%20initialization
liby
approved these changes
Dec 17, 2024
|
As @lixiaoyan is concerned about the maintainability of this fix, we are considering alternative workarounds for this issue. I am converting this PR to a draft. Once we reach a conclusion, this PR may be closed or ready for review again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Highcharts v12 introduces a new simpler way to import it's additional modules, which uses side effect imports to achieve.
By default,
eslint-plugin-simple-import-sortgroups side effect imports at the top of the file, which makeshighcharts/modules/...being imported beforehighcharts, resulting in a runtime error.To fix this, we add a custom
groupsconfig forsimple-import-sort/importsto group Highcharts side effect imports after package imports.Highcharts v12 info: https://www.highcharts.com/blog/changelog/#:~:text=When%20importing%20Highcharts%20as%20a%20node%20module%2C%20additional%20modules%20no%20longer%20require%20initialization