-
Notifications
You must be signed in to change notification settings - Fork 5k
docs: align type import guidelines with ESLint configuration #17275
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
base: main
Are you sure you want to change the base?
docs: align type import guidelines with ESLint configuration #17275
Conversation
Welcome!
Hello there, congrats on your first PR! We're excited to have you contributing to this project. |
Greptile SummaryUpdated documentation to recommend inline type imports (
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant D as Developer
participant SG as Style Guide (Documentation)
participant ESL as ESLint Config
participant CB as Codebase
Note over D,CB: Documentation Alignment Flow
D->>SG: Reads style guide
Note over SG: Previously: Discouraged type imports<br/>(contradicted ESLint)
D->>CB: Writes code following style guide
D->>ESL: Code triggers ESLint check
ESL-->>D: ❌ Error: Must use inline type imports
Note over D: Confusion: Documentation vs Tooling
Note over SG: After this PR: Recommends inline type imports
D->>SG: Reads updated style guide
Note over SG: Now: Prefer inline type imports<br/>(aligns with ESLint)
D->>CB: Writes code with inline type imports
D->>ESL: Code triggers ESLint check
ESL-->>D: ✅ Pass: Correct inline type imports
Note over D: Consistency: Documentation matches Tooling
|
Greptile found no issues!From now on, if a review finishes and we haven't found any issues, we will not post anything, but you can confirm that we reviewed your changes in the status check section. This feature can be toggled off in your Code Review Settings by deselecting "Create a status check for each PR". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No issues found across 1 file
|
Thanks for your contribution ! |
Summary
The style guide currently discourages type imports, which contradicts the enforced ESLint rule
@typescript-eslint/consistent-type-importsand existing code usage (e.g. Storybook stories).This PR updates the documentation to recommend inline type imports, aligning the style guide
with tooling and preventing contributor confusion.
Why
Fixes #<### Summary
The style guide currently discourages type imports, which contradicts the enforced ESLint rule
@typescript-eslint/consistent-type-importsand existing code usage (e.g. Storybook stories).This PR updates the documentation to recommend inline type imports, aligning the style guide
with tooling and preventing contributor confusion.
Why
Fixes #<#17222>