Migrate from ESLint to OxLint (#18443)
## 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
This commit is contained in:
+2
-2
@@ -3,7 +3,7 @@ import { type Equal, type Expect } from 'twenty-shared/testing';
|
||||
import { type ExtractJsonbProperties } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/extract-jsonb-properties.type';
|
||||
import { type JsonbProperty } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/jsonb-property.type';
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
||||
// oxlint-disable-next-line @typescripttypescript/no-empty-object-type
|
||||
type EmptyObject = {};
|
||||
|
||||
type TestedRecord = {
|
||||
@@ -41,7 +41,7 @@ type TestedRecord = {
|
||||
|
||||
type TestResult = ExtractJsonbProperties<TestedRecord>;
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type Assertions = [
|
||||
Expect<
|
||||
Equal<
|
||||
|
||||
+7
-7
@@ -18,7 +18,7 @@ type ObjectWithoutRelation = {
|
||||
|
||||
type BrandedObjectWithRelation = JsonbProperty<ObjectWithRelation>;
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type ObjectAssertions = [
|
||||
// Object with SerializedRelation: Id suffix renamed to UniversalIdentifier, value becomes nullable
|
||||
Expect<
|
||||
@@ -52,7 +52,7 @@ type ObjectAssertions = [
|
||||
>,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type PrimitiveAssertions = [
|
||||
// Primitives pass through unchanged
|
||||
Expect<Equal<FormatRecordSerializedRelationProperties<string>, string>>,
|
||||
@@ -67,7 +67,7 @@ type PrimitiveAssertions = [
|
||||
>,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type ArrayAssertions = [
|
||||
// Array of objects with relation: transforms each element
|
||||
Expect<
|
||||
@@ -103,7 +103,7 @@ type ArrayAssertions = [
|
||||
>,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type UnionAssertions = [
|
||||
// Union with null: transforms object, keeps null
|
||||
Expect<
|
||||
@@ -135,7 +135,7 @@ type MultipleRelationsObject = {
|
||||
regularId: string;
|
||||
};
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type MultipleRelationsAssertions = [
|
||||
// Multiple SerializedRelation properties: all get renamed and become nullable
|
||||
Expect<
|
||||
@@ -190,7 +190,7 @@ type NestedWithArrayOfObjects = {
|
||||
}[];
|
||||
};
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type NestedObjectAssertions = [
|
||||
// Simple nested object: transforms relation inside nested object
|
||||
Expect<
|
||||
@@ -279,7 +279,7 @@ type JsonSchemaUnion =
|
||||
|
||||
type BrandedJsonSchemaUnion = JsonbProperty<JsonSchemaUnion>;
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type RecordPropertyAssertions = [
|
||||
// Object with 'properties' key containing Record<string, X>:
|
||||
// The 'properties' key should NOT be renamed to 'propertiesUniversalIdentifier'
|
||||
|
||||
+5
-5
@@ -5,14 +5,14 @@ import {
|
||||
type JsonbProperty,
|
||||
} from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/jsonb-property.type';
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
||||
// oxlint-disable-next-line @typescripttypescript/no-empty-object-type
|
||||
type EmptyObject = {};
|
||||
|
||||
type SimpleObject = { value: string };
|
||||
|
||||
type NestedObject = { nested: { deep: number } };
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type PrimitiveAssertions = [
|
||||
// Primitives pass through unchanged (not objects)
|
||||
Expect<Equal<JsonbProperty<string>, string>>,
|
||||
@@ -22,7 +22,7 @@ type PrimitiveAssertions = [
|
||||
Expect<Equal<JsonbProperty<undefined>, undefined>>,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type ObjectAssertions = [
|
||||
// Objects get branded
|
||||
Expect<
|
||||
@@ -45,7 +45,7 @@ type ObjectAssertions = [
|
||||
>,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type ArrayAssertions = [
|
||||
// Arrays are objects, so they get branded on the array itself
|
||||
Expect<
|
||||
@@ -68,7 +68,7 @@ type ArrayAssertions = [
|
||||
>,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type UnionAssertions = [
|
||||
// Union of object and null: object gets branded, null passes through
|
||||
Expect<
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ import { type MetadataUniversalFlatEntityMaps } from 'src/engine/workspace-manag
|
||||
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
|
||||
import { type UniversalFlatViewField } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-field.type';
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type Assertions = [
|
||||
Expect<
|
||||
Equal<
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@ import { type Equal, type Expect } from 'twenty-shared/testing';
|
||||
|
||||
import { type UniversalFlatEntityUpdate } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-entity-update.type';
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type Assertions = [
|
||||
Expect<
|
||||
Equal<
|
||||
|
||||
+3
-3
@@ -43,7 +43,7 @@ type OneToManyUniversalIdentifierArrays = {
|
||||
};
|
||||
|
||||
// Narrowed relation universal identifier assertions - verifies conditional typing is preserved
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type RelationUniversalIdentifierAssertions = [
|
||||
// Non-relation types have undefined relation universal identifiers
|
||||
Expect<
|
||||
@@ -76,7 +76,7 @@ type RelationUniversalIdentifierAssertions = [
|
||||
>,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type UniversalFlatTransformationAssertions = [
|
||||
Expect<
|
||||
HasAllProperties<UniversalFlatFieldMetadata, DatePropertiesCastToString>
|
||||
@@ -131,7 +131,7 @@ type SettingsExpectedResult =
|
||||
}
|
||||
| null;
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type Assertions = [
|
||||
Expect<Equal<SettingsTestCase, SettingsExpectedResult>>,
|
||||
Expect<Equal<NarrowedTestCase, NarrowedExpectedResult>>,
|
||||
|
||||
+1
-1
@@ -25,7 +25,7 @@ export type MetadataUniversalFlatEntityPropertiesToCompare<
|
||||
}[TComparedKeys] &
|
||||
keyof MetadataUniversalFlatEntity<T>;
|
||||
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
type Assertions = [
|
||||
Expect<
|
||||
Equal<
|
||||
|
||||
+2
-2
@@ -32,9 +32,9 @@ export type WorkspaceMigrationRunnerExecutionErrors = {
|
||||
};
|
||||
|
||||
const {
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
EXECUTION_FAILED: WorkspaceMigrationRunnerExceptionExecutionFailedCode,
|
||||
// eslint-disable-next-line unused-imports/no-unused-vars
|
||||
// oxlint-disable-next-line unused-imports/no-unused-vars
|
||||
...WorkspaceMigrationRunnerExceptionCodeOtherCode
|
||||
} = WorkspaceMigrationRunnerExceptionCode;
|
||||
|
||||
|
||||
+1
-1
@@ -257,7 +257,7 @@ export class WorkspaceMigrationRunnerService {
|
||||
} catch (error) {
|
||||
if (queryRunner.isTransactionActive) {
|
||||
await queryRunner.rollbackTransaction().catch((error) =>
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.trace(`Failed to rollback transaction: ${error.message}`),
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user