docs: align type import guidelines with ESLint configuration#17275
Merged
FelixMalfait merged 2 commits intotwentyhq:mainfrom Jan 24, 2026
Merged
docs: align type import guidelines with ESLint configuration#17275FelixMalfait merged 2 commits intotwentyhq:mainfrom
FelixMalfait merged 2 commits intotwentyhq:mainfrom
Conversation
Contributor
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
|
Contributor
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". |
prastoin
approved these changes
Jan 21, 2026
Contributor
|
Thanks for your contribution ! |
camilo-agudelo-uma
pushed a commit
to innovation-grupo-uma/twenty-uma
that referenced
this pull request
Feb 2, 2026
…q#17275) ### Summary The style guide currently discourages type imports, which contradicts the enforced ESLint rule `@typescript-eslint/consistent-type-imports` and 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 - Aligns documentation with enforced ESLint configuration - Prevents ESLint auto-fix conflicts - Improves contributor experience Fixes #<### Summary The style guide currently discourages type imports, which contradicts the enforced ESLint rule `@typescript-eslint/consistent-type-imports` and 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 - Aligns documentation with enforced ESLint configuration - Prevents ESLint auto-fix conflicts - Improves contributor experience Fixes #<twentyhq#17222> <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Updates documentation to match tooling and current usage. > > - Replaces "Enforcing No-Type Imports" with **Type Imports**, recommending inline type imports > - Updates examples to prefer `import { type X } from ...` and avoid importing types as runtime values > - Clarifies ESLint `@typescript-eslint/consistent-type-imports` configuration to prefer explicit type imports and enforce `inline-type-imports` fix style > - Changes confined to `packages/twenty-docs/l/fr/developers/contribute/capabilities/frontend-development/style-guide.mdx` > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit e2250e4. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
This file contains hidden or 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
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.
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>
Note
Updates documentation to match tooling and current usage.
import { type X } from ...and avoid importing types as runtime values@typescript-eslint/consistent-type-importsconfiguration to prefer explicit type imports and enforceinline-type-importsfix stylepackages/twenty-docs/l/fr/developers/contribute/capabilities/frontend-development/style-guide.mdxWritten by Cursor Bugbot for commit e2250e4. This will update automatically on new commits. Configure here.