build(ui): automatically sort imports #13813
Merged
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
- like Python's `isort` but in JS/TS using https://github.com/IanVS/prettier-plugin-sort-imports - with [default config](https://github.com/IanVS/prettier-plugin-sort-imports/blob/e28fa0e92832a011a923fc5e3bc5a20705102406/README.md?plain=1#L198) plus [a newline](https://github.com/IanVS/prettier-plugin-sort-imports/blob/e28fa0e92832a011a923fc5e3bc5a20705102406/README.md?plain=1#L250) before relative imports and [CSS handling](https://github.com/IanVS/prettier-plugin-sort-imports/blob/e28fa0e92832a011a923fc5e3bc5a20705102406/README.md?plain=1#L234) - tried to get it as close to the existing style as possible with the smallest diff and least config - plus specify TS version according to [`yarn.lock`](https://github.com/argoproj/argo-workflows/blob/49ff7a44ba307416282a1f5cd3b844d19bce7f88/ui/yarn.lock#L9723) - decided to use a `prettier` plugin instead of an `eslint` plugin as there was less configuration - and I generally jive with letting a tool decide consistent style, although `prettier` is not quite zero config, but "low" config - https://github.com/import-js/eslint-plugin-import / https://github.com/un-ts/eslint-plugin-import-x would be the alternative - and potentially still has useful options in terms of static analysis Signed-off-by: Anton Gilgur <[email protected]>
Signed-off-by: Anton Gilgur <[email protected]>
|
I couldn't request a review from @Adrien-D due to not being in the "members" team -- same reason as #8790 (comment) -- so tagging in this comment instead |
tczhao
approved these changes
Oct 25, 2024
|
Added @Adrien-D |
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.
Follow-up to #12539 "Future Work" part 3, #13160 (comment), #11811 (comment), #13069 (comment), and other places I've mentioned it
Motivation
Automatically sort imports for consistent style, like Python's
isortbut for JS/TSModifications
using https://github.com/IanVS/prettier-plugin-sort-imports
yarn.lockran
yarn lintand committed changesmanually fix feat(ui): Retry a single workflow step manually #13343 (comment) and feat(ui): Add start/end workflows ISO display switch #13284 (comment) as those are unsortable since they were placed after side-effect imports
Verification
yarn linthas no more changes, otherwise this is purely stylistic and has no semantic changesNotes to Reviewers
prettierplugin instead of aneslintplugin as there was less configurationprettieris not quite zero config, but "low" config