feat!: add import sorting rule #126
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
SgtPooki
added a commit
to ipfs/aegir
that referenced
this pull request
Jan 31, 2023
This PR shows an example of what changes ipfs/eslint-config-ipfs#126 would enforce. All of this these changes (except package.json) were done by running `npm run lint -- --fix`. CALLOUTS: 1. eslint was failing with locally linked package on missing plugins. 1. lint fix was called twice, with the first run failing due to an empty line the first fix runthrough didn't fix. 1. tsc seems to be failing for aegir
achingbrain
changed the title
achingbrain
approved these changes
Feb 1, 2023
There was a problem hiding this comment.
LGTM. I don't love all the empty lines between groups of imports because you frequently have one lone import in a group which just looks weird sitting there all on it's own, but I don't hate them either.
I updated the title to be feat!: because feature will break linting for pretty much every project, though it's easy to fix.
One caveat is that --fix only moves the imports around - it doesn't move the accompanying // @ts-expect-error no types comments we have in lots of places above imports of modules that don't ship with types.
achingbrain
added a commit
to ipfs/protons
that referenced
this pull request
Feb 1, 2023
ipfs/eslint-config-ipfs#126 will introduce linting rules on import sorting so order imports during building in a way that will comply with the new linting rules.
achingbrain
added a commit
to ipfs/protons
that referenced
this pull request
Feb 2, 2023
ipfs/eslint-config-ipfs#126 will introduce linting rules on import sorting so order imports during building in a way that will comply with the new linting rules.
Yea, that's important. we could update the rule to support moving associated comments, but I haven't looked into that. |
achingbrain
requested changes
Feb 28, 2023
achingbrain
approved these changes
Apr 5, 2023
achingbrain
added a commit
that referenced
this pull request
Apr 5, 2023
Lint import sorting, and support auto-fixing of import order. see ipfs/aegir#1178 for an example --------- Co-authored-by: Alex Potsides <alex@achingbrain.net>
github-actions bot
pushed a commit
that referenced
this pull request
Apr 5, 2023
## [4.0.0](v3.1.7...v4.0.0) (2023-04-05) ### ⚠ BREAKING CHANGES * `await` is not allowed before `return` unless it is inside a `try/catch` in which case it is required Co-authored-by: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com> * previously jsx and tsx files were not linted, now they are * add import sorting rule (#126) ### Features * add import sorting rule ([#126](#126)) ([1462d09](1462d09)) * lint jsx ([#140](#140)) ([fb5e5b6](fb5e5b6)) ### Bug Fixes * only require `await`ing promises returned from inside try/catch blocks ([#133](#133)) ([a6e4a7b](a6e4a7b)), closes [#130](#130) ### Trivial Changes * convert to aegir project ([81d8ba3](81d8ba3)) * **deps:** bump eslint-config-standard-with-typescript from 27.0.1 to 34.0.1 ([#135](#135)) ([fc9aa6f](fc9aa6f)) * **deps:** bump eslint-plugin-jsdoc from 39.9.1 to 40.1.1 ([#139](#139)) ([bd1422b](bd1422b)) * fix linting ([adffc58](adffc58)) * use unified ci ([2674c56](2674c56))
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.
Lint import sorting, and support auto-fixing of import order. see ipfs/aegir#1178 for an example