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:
Charles Bochet
2026-03-06 01:03:50 +01:00
committed by GitHub
parent b421efbff7
commit 9d57bc39e5
880 changed files with 4711 additions and 9687 deletions
@@ -28,7 +28,7 @@ export type AgentActorContext = {
};
@Injectable()
// eslint-disable-next-line twenty/inject-workspace-repository
// oxlint-disable-next-line twenty/inject-workspace-repository
export class AgentActorContextService {
constructor(
private readonly userWorkspaceService: UserWorkspaceService,
@@ -3,9 +3,10 @@ import { Args, Mutation, Query } from '@nestjs/graphql';
import { InjectRepository } from '@nestjs/typeorm';
import { msg } from '@lingui/core/macro';
import { Repository } from 'typeorm';
import { PermissionFlagType } from 'twenty-shared/constants';
import { Repository } from 'typeorm';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { NotFoundError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';
@@ -14,7 +15,6 @@ import { MessageQueueService } from 'src/engine/core-modules/message-queue/servi
import { type WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthUserWorkspaceId } from 'src/engine/decorators/auth/auth-user-workspace-id.decorator';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { AgentTurnDTO } from 'src/engine/metadata-modules/ai/ai-agent-execution/dtos/agent-turn.dto';
@@ -44,7 +44,7 @@ registerEnumType(FieldMetadataType, {
@ObjectType('Field')
@Authorize({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
authorize: (context: any) => ({
workspaceId: { eq: context?.req?.workspace?.id },
}),
@@ -26,7 +26,7 @@ export const FieldMetadataExceptionCode = appendCommonExceptionCode({
NAME_NOT_SYNCED_WITH_LABEL: 'NAME_NOT_SYNCED_WITH_LABEL',
} as const);
// eslint-disable-next-line no-redeclare
// oxlint-disable-next-line no-redeclare
export type FieldMetadataExceptionCode =
(typeof FieldMetadataExceptionCode)[keyof typeof FieldMetadataExceptionCode];
@@ -18,7 +18,7 @@ export class FieldMetadataGraphqlApiExceptionInterceptor
{
constructor(private readonly i18nService: I18nService) {}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
const gqlContext = GqlExecutionContext.create(context);
const ctx = gqlContext.getContext();
@@ -78,7 +78,7 @@ type RelationFieldMetadata = FieldMetadataEntity<FieldMetadataType.RELATION>;
type MorphRelationFieldMetadata =
FieldMetadataEntity<FieldMetadataType.MORPH_RELATION>;
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type RelationAssertions = [
Expect<HasAllProperties<UUIDFieldMetadata, NotDefinedRelationRecord>>,
Expect<HasAllProperties<TextFieldMetadata, NotDefinedRelationRecord>>,
@@ -115,7 +115,7 @@ type NotDefinedSettings = {
settings: never | null;
};
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type SettingsAssertions = [
Expect<HasAllProperties<CurrencyFieldMetadata, NotDefinedSettings>>,
Expect<HasAllProperties<FullNameFieldMetadata, NotDefinedSettings>>,
@@ -239,7 +239,7 @@ type SettingsAssertions = [
>,
];
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type DefaultValueAssertions = [
Expect<
HasAllProperties<
@@ -453,7 +453,7 @@ type NotDefinedOptions = {
options: never | null;
};
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type OptionsAssertions = [
Expect<
HasAllProperties<
@@ -2,7 +2,7 @@ import { type FieldMetadataDefaultValueForAnyType } from 'twenty-shared/types';
export const unserializeDefaultValue = (
serializedDefaultValue: FieldMetadataDefaultValueForAnyType,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
): any => {
if (serializedDefaultValue === undefined || serializedDefaultValue === null) {
return null;
@@ -60,7 +60,7 @@ export const validateOptionsForType = (
const isValid = options.every((option) => {
return validators.some((validator) => {
const optionsInstance = plainToInstance<
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
any,
FieldMetadataDefaultOption | FieldMetadataComplexOption
>(validator, option);
@@ -12,7 +12,7 @@ export function IsQuotedString(validationOptions?: ValidationOptions) {
propertyName: propertyName,
options: validationOptions,
validator: {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
validate(value: any) {
return typeof value === 'string' && /^'{1}.*'{1}$/.test(value);
},
@@ -253,7 +253,7 @@ export const ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY = {
} as const satisfies ManyToOneMetadataRelationsProperties;
// satisfies with complex mapped types involving nested generics doesn't always catch missing required keys
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
AllMetadataName extends keyof typeof ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY
@@ -441,7 +441,7 @@ export const ALL_MANY_TO_ONE_METADATA_RELATIONS = {
} as const satisfies ManyToOneMetadataRelationsProperties;
// satisfies with complex mapped types involving nested generics doesn't always catch missing required keys
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
AllMetadataName extends keyof typeof ALL_MANY_TO_ONE_METADATA_RELATIONS
@@ -7,7 +7,7 @@ type MetadataSerializedRelationProperties = {
[TSourceMetadataName in AllMetadataName]: [
AllJsonbPropertiesWithSerializedPropertiesForMetadataName<TSourceMetadataName>,
] extends [never]
? // eslint-disable-next-line @typescript-eslint/no-empty-object-type
? // oxlint-disable-next-line @typescripttypescript/no-empty-object-type
{}
: Partial<Record<AllMetadataName, true>>;
};
@@ -50,7 +50,7 @@ export const ALL_METADATA_SERIALIZED_RELATION = {
} as const satisfies MetadataSerializedRelationProperties;
// satisfies with complex mapped types involving nested generics doesn't always catch missing required keys
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
AllMetadataName extends keyof typeof ALL_METADATA_SERIALIZED_RELATION
@@ -211,7 +211,7 @@ export const ALL_ONE_TO_MANY_METADATA_RELATIONS = {
} as const satisfies OneToManyMetadataRelationsProperties;
// satisfies with complex mapped types involving nested generics doesn't always catch missing required keys
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
AllMetadataName extends keyof typeof ALL_ONE_TO_MANY_METADATA_RELATIONS
@@ -23,7 +23,7 @@ type ExpectedGenericAllFlatEntityInformationByMetadataEngine = {
[P in keyof AllFlatEntityTypesByMetadataName]: ExpectedGenericFlatEntityInformation;
};
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
keyof AllFlatEntityTypesByMetadataName extends AllMetadataName
@@ -6,7 +6,7 @@ import { type CastRecordTypeOrmDatePropertiesToString } from 'src/engine/metadat
type FieldMetadataDateProperties =
CastRecordTypeOrmDatePropertiesToString<FieldMetadataEntity>;
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity has createdAt and updatedAt Date properties
Expect<
@@ -6,7 +6,7 @@ import { type ExtractEntityManyToOneEntityRelationProperties } from 'src/engine/
type FieldMetadataManyToOneRelations =
ExtractEntityManyToOneEntityRelationProperties<FieldMetadataEntity>;
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity ManyToOne relations:
// - object (ObjectMetadataEntity)
@@ -13,7 +13,7 @@ type FieldMetadataOneToManySyncableRelations =
SyncableEntity
>;
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity OneToMany relations (all targets):
// - indexFieldMetadatas, fieldPermissions, viewFields, viewFilters,
@@ -6,7 +6,7 @@ import { type ExtractEntityRelatedEntityProperties } from 'src/engine/metadata-m
type FieldMetadataRelatedProperties =
ExtractEntityRelatedEntityProperties<FieldMetadataEntity>;
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
// FieldMetadataEntity has both ManyToOne and OneToMany relations
// ManyToOne: object, workspace, application, relationTargetFieldMetadata, relationTargetObjectMetadata
@@ -6,7 +6,7 @@ import {
import { type FlatEntityUpdate } from 'src/engine/metadata-modules/flat-entity/types/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<
@@ -4,7 +4,7 @@ import { type MetadataManyToOneJoinColumn } from 'src/engine/metadata-modules/fl
type FieldMetadataJoinColumns = MetadataManyToOneJoinColumn<'fieldMetadata'>;
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
Equal<
@@ -26,5 +26,5 @@ export type FlatEntityFrom<
? FromMetadataEntityToMetadataName<TEntity>
: TMetadataName
> & { universalIdentifier: string }
: // eslint-disable-next-line @typescript-eslint/no-empty-object-type
: // oxlint-disable-next-line @typescripttypescript/no-empty-object-type
{});
@@ -15,7 +15,7 @@ export type FromMetadataEntityToMetadataName<T extends SyncableEntity> = {
}[AllMetadataName];
// metadata name lookups works with the base entity type, not with narrowed variants.
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertions = [
Expect<
[never] extends [
@@ -33,7 +33,7 @@ type OneToManyRelationIdArrays = {
mainGroupByFieldMetadataViewIds: string[];
};
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type RelationIdAssertions = [
// Non-relation types have undefined relation IDs
Expect<
@@ -66,7 +66,7 @@ type RelationIdAssertions = [
>,
];
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type FlatTransformationAssertions = [
Expect<HasAllProperties<FlatFieldMetadata, DatePropertiesCastToString>>,
Expect<HasAllProperties<FlatFieldMetadata, OneToManyRelationIdArrays>>,
@@ -16,7 +16,7 @@ import { IndexMetadataDTO } from './index-metadata.dto';
@ObjectType('IndexField')
@Authorize({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
authorize: (context: any) => ({
workspaceId: { eq: context?.req?.workspace?.id },
}),
@@ -35,7 +35,7 @@ registerEnumType(IndexType, {
@ObjectType('Index')
@Authorize({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
authorize: (context: any) => ({
workspaceId: { eq: context?.req?.workspace?.id },
}),
@@ -28,7 +28,7 @@ import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/
@ObjectType('LogicFunction')
@Authorize({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
authorize: (context: any) => ({
workspaceId: { eq: context?.req?.workspace?.id },
}),
@@ -11,7 +11,7 @@ import {
LogicFunctionExceptionCode,
} from 'src/engine/metadata-modules/logic-function/logic-function.exception';
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
export const logicFunctionGraphQLApiExceptionHandler = (error: any) => {
if (error instanceof LogicFunctionException) {
switch (error.code) {
@@ -16,7 +16,7 @@ import { ObjectStandardOverridesDTO } from 'src/engine/metadata-modules/object-m
@ObjectType('Object')
@Authorize({
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
authorize: (context: any) => ({
workspaceId: { eq: context?.req?.workspace?.id },
}),
@@ -18,7 +18,7 @@ export class ObjectMetadataGraphqlApiExceptionInterceptor
{
constructor(private readonly i18nService: I18nService) {}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
const gqlContext = GqlExecutionContext.create(context);
const ctx = gqlContext.getContext();
@@ -38,7 +38,7 @@ registerEnumType(WidgetConfigurationType, {
name: 'WidgetConfigurationType',
});
// eslint-disable-next-line unused-imports/no-unused-vars
// oxlint-disable-next-line unused-imports/no-unused-vars
type Assertion = Expect<
`${GraphType}` extends `${WidgetConfigurationType}` ? true : false
>;
@@ -104,7 +104,7 @@ export class PermissionFlagService {
try {
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}`);
}
}
@@ -15,7 +15,7 @@ export type CallWebhookJobData = WebhookJobBase & {
objectMetadata: { id: string; nameSingular: string };
workspaceMemberId?: string;
applicationId?: string;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
record: any;
updatedFields?: string[];
};