-
Notifications
You must be signed in to change notification settings - Fork 71
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
refactor: sort all top-level imports #337
Merged
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
- basically, general format is: ```ts import x from "external-dep" import y from "./internal-dep" ``` - so external deps, new line, then internal/local deps - with some further sorting within there, like trying to keep Node built-ins (e.g. `path`) at the top half of externals, then core deps like `typescript`, then any other external deps - and similar for internal deps -- core internals at the top half of internals, then any other internal deps - just to keep things consistent between files -- makes the top easier to read through when it's similar between files - also makes it easier for contributors to understand where to put imports, as there's a sorting already there - this is how I generally sort my imports and how I wrote most of the unit test suite's imports as well - there is automation for this that we should probably add once TSLint is replaced here; some previous art: - https://github.com/trivago/prettier-plugin-sort-imports - https://github.com/lydell/eslint-plugin-simple-import-sort/ - Older: - https://github.com/renke/import-sort/tree/master/packages/import-sort-style-module - https://github.com/mcdougal/js-isort - inspired by Python's `isort` ofc
agilgur5
added
the
kind: internal
Changes only affect the internals, and _not_ the public API or external-facing docs
label
Jun 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
kind: internal
Changes only affect the internals, and _not_ the public API or external-facing docs
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.
Summary
Sort imports by external deps first, then local/internal deps next (AKA absolute imports first, then relative imports)
Details
basically, general format is:
path
) at the top half of externals, then core deps liketypescript
, then any other external depsthis is how I generally sort my imports and how I wrote most of the unit test suite's imports as well (c.f. test: add initial unit test suite #321)
there is automation for this that we should probably add once TSLint is replaced here; some previous art:
isort
ofc