Charles Bochet
9d57bc39e5
## Summary Fully replaces ESLint with OxLint across the entire monorepo: - **Replaced all ESLint configs** (`eslint.config.mjs`) with OxLint configs (`.oxlintrc.json`) for every package: `twenty-front`, `twenty-server`, `twenty-emails`, `twenty-ui`, `twenty-shared`, `twenty-sdk`, `twenty-zapier`, `twenty-docs`, `twenty-website`, `twenty-apps/*`, `create-twenty-app` - **Migrated custom lint rules** from ESLint plugin format to OxLint JS plugin system (`@oxlint/plugins`), including `styled-components-prefixed-with-styled`, `no-hardcoded-colors`, `sort-css-properties-alphabetically`, `graphql-resolvers-should-be-guarded`, `rest-api-methods-should-be-guarded`, `max-consts-per-file`, and Jotai-related rules - **Migrated custom rule tests** from ESLint `RuleTester` + Jest to `oxlint/plugins-dev` `RuleTester` + Vitest - **Removed all ESLint dependencies** from `package.json` files and regenerated lockfiles - **Updated Nx targets** (`lint`, `lint:diff-with-main`, `fmt`) in `nx.json` and per-project `project.json` to use `oxlint` commands with proper `dependsOn` for plugin builds - **Updated CI workflows** (`.github/workflows/ci-*.yaml`) — no more ESLint executor - **Updated IDE setup**: replaced `dbaeumer.vscode-eslint` with `oxc.oxc-vscode` extension, configured `source.fixAll.oxc` and format-on-save with Prettier - **Replaced all `eslint-disable` comments** with `oxlint-disable` equivalents across the codebase - **Updated docs** (`twenty-docs`) to reference OxLint instead of ESLint - **Renamed** `twenty-eslint-rules` package to `twenty-oxlint-rules` ### Temporarily disabled rules (tracked in `OXLINT_MIGRATION_TODO.md`) | Rule | Package | Violations | Auto-fixable | |------|---------|-----------|-------------| | `twenty/sort-css-properties-alphabetically` | twenty-front | 578 | Yes | | `typescript/consistent-type-imports` | twenty-server | 3814 | Yes | | `twenty/max-consts-per-file` | twenty-server | 94 | No | ### Dropped plugins (no OxLint equivalent) `eslint-plugin-project-structure`, `lingui/*`, `@stylistic/*`, `import/order`, `prefer-arrow/prefer-arrow-functions`, `eslint-plugin-mdx`, `@next/eslint-plugin-next`, `eslint-plugin-storybook`, `eslint-plugin-react-refresh`. Partial coverage for `jsx-a11y` and `unused-imports`. ### Additional fixes (pre-existing issues exposed by merge) - Fixed `EmailThreadPreview.tsx` broken import from main rename (`useOpenEmailThreadInSidePanel`) - Restored truthiness guard in `getActivityTargetObjectRecords.ts` - Fixed `AgentTurnResolver` return types to match entity (virtual `fileMediaType`/`fileUrl` are resolved via `@ResolveField()`) ## Test plan - [x] `npx nx lint twenty-front` passes - [x] `npx nx lint twenty-server` passes - [x] `npx nx lint twenty-docs` passes - [x] Custom oxlint rules validated with Vitest: `npx nx test twenty-oxlint-rules` - [x] `npx nx typecheck twenty-front` passes - [x] `npx nx typecheck twenty-server` passes - [x] CI workflows trigger correctly with `dependsOn: ["twenty-oxlint-rules:build"]` - [x] IDE linting works with `oxc.oxc-vscode` extension
82 lines
2.4 KiB
TypeScript
82 lines
2.4 KiB
TypeScript
import { RuleTester } from 'oxlint/plugins-dev';
|
|
|
|
import { rule, RULE_NAME } from './enforce-module-boundaries';
|
|
|
|
const depConstraints = [
|
|
{
|
|
sourceTag: 'scope:frontend',
|
|
onlyDependOnLibsWithTags: ['scope:shared', 'scope:frontend'],
|
|
},
|
|
{
|
|
sourceTag: 'scope:backend',
|
|
onlyDependOnLibsWithTags: ['scope:shared', 'scope:backend'],
|
|
},
|
|
{
|
|
sourceTag: 'scope:shared',
|
|
onlyDependOnLibsWithTags: ['scope:shared'],
|
|
},
|
|
];
|
|
|
|
const ruleTester = new RuleTester();
|
|
|
|
ruleTester.run(RULE_NAME, rule, {
|
|
valid: [
|
|
{
|
|
code: "import { isDefined } from 'twenty-shared';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-front/src/utils.ts',
|
|
},
|
|
{
|
|
code: "import { Button } from 'twenty-ui';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-front/src/components.tsx',
|
|
},
|
|
{
|
|
code: "import { isDefined } from 'twenty-shared';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-server/src/utils.ts',
|
|
},
|
|
{
|
|
code: "import { helper } from './local';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-front/src/utils.ts',
|
|
},
|
|
{
|
|
code: "import lodash from 'lodash';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-front/src/utils.ts',
|
|
},
|
|
{
|
|
code: "import { isDefined } from 'twenty-shared';",
|
|
options: [{ depConstraints: [] }],
|
|
filename: '/project/packages/twenty-front/src/utils.ts',
|
|
},
|
|
],
|
|
invalid: [
|
|
{
|
|
code: "import { ServerService } from 'twenty-server';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-front/src/bad-import.ts',
|
|
errors: [{ messageId: 'moduleBoundaryViolation' }],
|
|
},
|
|
{
|
|
code: "import { Component } from 'twenty-front';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-server/src/bad-import.ts',
|
|
errors: [{ messageId: 'moduleBoundaryViolation' }],
|
|
},
|
|
{
|
|
code: "import { Component } from 'twenty-front';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-shared/src/bad-import.ts',
|
|
errors: [{ messageId: 'moduleBoundaryViolation' }],
|
|
},
|
|
{
|
|
code: "import { ServerThing } from 'twenty-server';",
|
|
options: [{ depConstraints }],
|
|
filename: '/project/packages/twenty-shared/src/bad-import.ts',
|
|
errors: [{ messageId: 'moduleBoundaryViolation' }],
|
|
},
|
|
],
|
|
});
|