ESLint import-x/order config doesn't match documented import organization
Maintainers usually reply within 2 days
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 85/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- eslint, typescript
- Domain
- developer-experience, documentation
Research direction
Read the import organization section in docs/code-style.md and compare its ordering with the rules in eslint.config.js, especially the placement of the type group. Update the documentation to describe the order the configuration enforces, then check that the section matches the listed groups. Done means readers can follow the documented order without contradicting ESLint.
Written by the indexing model from the issue text.
Description
Enter your suggestions in details:
The import ordering documented in docs/code-style.md#import-organization doesn't match ESLint import-x/order rules.
Import Organization
Organize imports in this order:
- Node.js built-in modules
- External library imports (Including
@node-core/*) - Relative imports (
./*,../*,#specifier/) - Type-only imports at the end of each given section
Actual ESLint config:
groups: [
'builtin',
'external',
'internal',
'object',
'type', // <-- all type imports in one block
['sibling', 'parent'],
'index',
],
Proposal: Update docs to match ESLint config.
- Dominant language
- TypeScript
- Stars
- 6.9k
- Forks
- 6.5k
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 48
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nodejs/nodejs.org
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
nodejs/nodejs.org#9248 ·
Maintainers usually reply within 2 days
-
fix(ui-components): react in regular dependencies causes duplicate hook errors in consumer appsMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
nodejs/nodejs.org#9175 · 2 comments ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
nodejs/nodejs.org#9098 · 4 comments · 1 reaction ·
Maintainers usually reply within 2 days
-
Sidebar scroll position resets on navigation, active item can be off-screenPossibly taken @codebyanas claimed this 50 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
nodejs/nodejs.org#8828 · 4 comments ·
Maintainers usually reply within 2 days
-
Difficulty 3/5 1-2 days Newbie friendliness 56/100
nodejs/nodejs.org#9239 · 1 comment · 2 reactions ·
Maintainers usually reply within 2 days
All issues in nodejs/nodejs.org
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
area:web p3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Lets-Parley/Parley#912 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
wealthfolio/wealthfolio#2376 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
be-BOP-io-SA/be-BOP#2817 ·
Maintainers usually reply within 5 days
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
sno-ai/sno-station#149 · 1 comment ·
Maintainers usually reply within 1 day