Files

T

Charles Bochet fea47aa9f8 Add twenty/folder-structure custom oxlint rule (#18467 )

## Summary

- Re-implements `eslint-plugin-project-structure`'s folder structure
enforcement as a custom oxlint rule (`twenty/folder-structure`),
recovering functionality lost during the ESLint → Oxlint migration
- Validates `src/modules/` structure: kebab-case module folder names,
allowed subdirectories (hooks, utils, components, states, types,
graphql, etc.), hook file naming (`use{PascalCase}.(ts|tsx)`), util file
naming (`{camelCase}.(ts|tsx)`), and module nesting depth (max 4 levels)
- Enabled as `"warn"` in twenty-front with 403 pre-existing violations
to address incrementally

## What the rule checks

| Check | Example valid | Example invalid |
|-------|-------------|-----------------|
| Module names kebab-case | `object-record/` | `graphWidgetBarChart/` |
| Allowed subdirs only | `hooks/`, `components/`, `utils/` |
`random-stuff/` |
| Hook file naming | `useMyHook.ts` | `badName.ts` |
| Util file naming | `buildQuery.ts` | `build-query.ts` |
| Max nesting depth 4 | `a/b/c/d/hooks/` | `a/b/c/d/e/hooks/` |
| Utils kebab-case subfolders | `utils/cron-to-human/` |
`utils/camelCase/` |

## Pre-existing violations (403 total)

| Category | Count | Examples |
|----------|-------|---------|
| Non-kebab-case module names | 160 | `graphWidgetBarChart`,
`AIChatThreads` |
| Module depth > 4 | 215 |
`settings/roles/role-permissions/object-level-permissions/field-permissions`
|
| Util file naming | 22 | `.util.ts` suffix, kebab-case, PascalCase
filenames |
| Misc (hooks, tests) | 6 | Non-hook files in hooks/, folders in test
dirs |

2026-03-06 17:02:46 +00:00

3.9 KiB

Raw Blame History

Oxlint Migration TODO

This file tracks what was lost or temporarily disabled during the ESLint to Oxlint migration, and what needs to be re-activated or addressed.

Temporarily Disabled Rules

twenty-server

Rule	Reason	Violations	Auto-fixable
`typescript/consistent-type-imports`	3814 pre-existing violations. Cannot be auto-fixed because NestJS relies on `emitDecoratorMetadata` for DI — the auto-fixer converts constructor parameter imports to `import type`, which erases them at runtime and breaks dependency injection.	3814	No (unsafe auto-fix)
`twenty/max-consts-per-file`	94 pre-existing violations across 24 constant files with >1 export	94	No

Re-activated Rules

twenty-front

Rule	Violations Fixed	Method
`twenty/sort-css-properties-alphabetically`	578	Auto-fix via `npx nx lint twenty-front --configuration=fix`

Dropped Plugins (No Oxlint Equivalent)

These plugins were in use but have no oxlint equivalent. Consider whether alternative tooling is needed.

Plugin	Where Used	What It Did	Replacement / Status
`eslint-plugin-project-structure`	Frontend	Enforced folder naming and structure conventions for `src/modules/` (kebab-case dirs, allowed subdirs like hooks/utils/components, file naming for hooks/utils). Config still in `folderStructure.json`.	Re-implemented as `twenty/folder-structure` custom oxlint rule. Enabled as `"warn"` — 403 pre-existing violations (160 non-kebab-case names, 215 depth > 4, 28 naming).
`lingui/*`	Frontend, emails	i18n extraction and consistency rules	No equivalent
`@stylistic/*`	Server	Formatting rules (indentation, spacing)	Use Prettier instead
`import/order`, `simple-import-sort/imports`	Server	Import sorting and ordering	No equivalent
`prefer-arrow/prefer-arrow-functions`	Frontend	Enforced arrow functions over function declarations	No equivalent
`eslint-plugin-mdx`	Docs	MDX file linting	Not supported by oxlint
`@next/eslint-plugin-next`	Website	Next.js-specific rules (no `<img>`, link handling, etc.)	Not supported by oxlint
`eslint-plugin-unused-imports`	Frontend	Removed unused imports on save	Partially covered by `no-unused-vars`
`eslint-plugin-storybook`	Frontend	Storybook best practices (story structure, naming)	No equivalent
`eslint-plugin-jsx-a11y`	Frontend	Accessibility rules (alt text, aria, roles, etc.)	Partial equivalent in Oxlint (`jsx-a11y` plugin), but coverage is limited.
`eslint-plugin-react-refresh`	Frontend	React Refresh boundary validation (HMR)	No equivalent

IDE Integration

The oxc.oxc-vscode extension provides inline diagnostics for built-in oxlint rules but does not yet support jsPlugins (custom twenty/* rules). Custom rule violations are only caught by nx lint and CI.

Remaining Re-activation Plan

Consistent type imports (twenty-server): Cannot safely auto-fix due to NestJS emitDecoratorMetadata. Options:
- Manually add import type only where safe (not for DI constructor params)
- Enable TypeScript's verbatimModuleSyntax (major migration)
- Keep disabled until oxlint supports decorator-aware type import analysis
Max consts per file (twenty-server): Manually split 24 constant files to have at most 1 exported const each, then re-enable the rule.
Folder structure enforcement (twenty-front): Re-implemented as twenty/folder-structure custom oxlint rule (enabled as "warn"). 403 pre-existing violations to address:
- 160 non-kebab-case module folder names (e.g. graphWidgetBarChart → graph-widget-bar-chart)
- 215 modules nested deeper than 4 levels
- 28 util/hook file naming violations (.util.ts suffixes, kebab-case filenames, PascalCase)
- Promote to "error" once violations are resolved

3.9 KiB Raw Blame History