(chore) Extend ESLint configuration #837
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
denniskigen
force-pushed
the
fix/lint-consistent-type-imports
branch
2 times, most recently
from
91d0cb9 to
a2ae073
Compare
|
Size Change: -378 kB (-12%) 👏 Total Size: 2.71 MB
ℹ️ View Unchanged
|
denniskigen
force-pushed
the
fix/lint-consistent-type-imports
branch
from
a2ae073 to
8bfcdd8
Compare
denniskigen
changed the title
denniskigen
force-pushed
the
fix/lint-consistent-type-imports
branch
from
ccd0d39 to
9ade952
Compare
ibacher
requested changes
Dec 13, 2023
There was a problem hiding this comment.
Thanks @denniskigen! Looks great. I'm not really sure what to do about my longer concern, so feel free to ignore that one.
| "@typescript-eslint/no-unused-vars": "off", | ||
| "@typescript-eslint/no-var-requires": "off", | ||
| "@typescript-eslint/triple-slash-reference": "off", | ||
| // Use `import type` instead of `import` for type imports https://typescript-eslint.io/blog/consistent-type-imports-and-exports-why-and-how |
There was a problem hiding this comment.
Personally, I'm a little iffy on this rule. Specifically, I like the idea of requiring type qualification for type imports, but the style I prefer is not one of the "consistent" options, specifically, the style I prefer is:
import type { Type1, Type2, Type3, Type4 } from "./types";
import {
type Patient,
type Visit,
saveVisit
} from "@openmrs/esm-framework";Basically, the idea is use import type ... if everything is a type and import {type ...} otherwise. This is primarily for aesthetics, i.e.,
import type { Type1, Type2, Type3, Type4 } from "./types";Is (in my view) nicer than:
import {
type Type1,
type Type2,
type Type3,
type Type4,
} from "./types";But also because of the transformation mentioned here (import {} from "./types" might have side-effects that tsc cannot reason about).
There was a problem hiding this comment.
Fair points, well-argued. Unfortunately, it doesn't seem like the rule's configuration options give us the desired flexibility.
FWIW, looking through the ESLint configs of popular projects, most use the defaults. I think inlined type imports look better than separate type imports, e.g.
I find this:
import { loadWebpackConfig, logInfo, logWarn, type ImportMapDeclaration } from '../utils';Preferable to:
import type { ImportmapDeclaration } from '../utils';
import { loadWebpackConfig, logInfo, logWarn } from '../utils';It boils down to relative aesthetics. Ultimately, I don't know what the preferred compromise is.
denniskigen
force-pushed
the
fix/lint-consistent-type-imports
branch
from
9ade952 to
20ac8a3
Compare
3 tasks
denniskigen
force-pushed
the
fix/lint-consistent-type-imports
branch
from
20ac8a3 to
f1d8002
Compare
ibacher
approved these changes
Dec 20, 2023
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.
Requirements
For changes to apps
If applicable
Summary
This PR tweaks our ESLint configuration, adding a rule consistent type imports and other useful TypeScript-related rules.
Related Issue
None
Other
None