Skip to content

docs(code-style): match import organization to eslint config #9238

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.

Sign up for GitHub

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

Open
Devehab wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −5
Open

docs(code-style): match import organization to eslint config #9238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/code-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,21 +197,29 @@ The repository includes a `.vscode` directory with recommended settings that wil

### Import Organization

Organize imports in this order:
Import order is enforced by the `import-x/order` rule in [`eslint.config.js`](../eslint.config.js), so `pnpm lint:fix` will sort your imports for you. Imports are grouped in this order, with an empty line between groups and alphabetical order within each group:

1. Node.js built-in modules
2. External library imports (Including `@node-core/*`)
3. Relative imports (`./*`, `../*`, `#specifier/`)
4. Type-only imports at the end of each given section
2. External library imports (Including `@node-core/*` and `#platform/*`)
3. Internal imports using subpath specifiers (`#site/*`, `#ui/*`)
4. Type-only imports, all together in one group no matter where they are imported from
5. Relative imports (`./*`, `../*`)
6. Relative CSS imports (`./*.css`, `../*.css`)

```tsx
import { readFile } from 'node:fs/promises';

import { SomeComponent } from '@node-core/ui-components/Common/SomeComponent';
import { useTranslations } from 'next-intl';

import { BASE_URL } from '#site/next.constants.mjs';

import type { MyComponentProps } from './types';
import type { FC } from 'react';

import { myHook } from '../hooks/myHook';
import type { MyComponentProps } from './types';

import styles from './index.module.css';
```

## Documentation Standards
Expand Down