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:
+5
-5
@@ -74,7 +74,7 @@ type PermissionOptions = {
|
||||
};
|
||||
|
||||
export class WorkspaceEntityManager extends EntityManager {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
readonly repositories: Map<string, Repository<any>>;
|
||||
declare connection: GlobalWorkspaceDataSource;
|
||||
|
||||
@@ -428,7 +428,7 @@ export class WorkspaceEntityManager extends EntityManager {
|
||||
if (isNaN(Number(value)))
|
||||
throw new TypeORMError(`Value "${value}" is not a number.`);
|
||||
// convert possible embeded path "social.likes" into object { social: { like: () => value } }
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
const values = propertyPath.split('.').reduceRight<any>(
|
||||
(value, key) => ({ [key]: value }),
|
||||
() => this.connection.driver.escape(column.databaseName) + ' + ' + value,
|
||||
@@ -487,7 +487,7 @@ export class WorkspaceEntityManager extends EntityManager {
|
||||
return this.connection.getMetadata(target).name;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
private extractTargetNameSingularFromEntity(entity: any): string {
|
||||
return this.connection.getMetadata(entity.constructor).name;
|
||||
}
|
||||
@@ -1040,7 +1040,7 @@ export class WorkspaceEntityManager extends EntityManager {
|
||||
);
|
||||
if (isNaN(Number(value)))
|
||||
throw new TypeORMError(`Value "${value}" is not a number.`);
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
const values = propertyPath.split('.').reduceRight<any>(
|
||||
(value, key) => ({ [key]: value }),
|
||||
() => this.connection.driver.escape(column.databaseName) + ' - ' + value,
|
||||
@@ -1830,7 +1830,7 @@ export class WorkspaceEntityManager extends EntityManager {
|
||||
|
||||
// Forbidden methods
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
override query<T = any>(_query: string, _parameters?: any[]): Promise<T> {
|
||||
throw new PermissionsException(
|
||||
'Method not allowed.',
|
||||
|
||||
+7
-7
@@ -116,7 +116,7 @@ export class GlobalWorkspaceDataSource extends DataSource {
|
||||
|
||||
Object.assign(queryRunner, { manager: manager });
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
return queryRunner as any as WorkspaceQueryRunner;
|
||||
}
|
||||
|
||||
@@ -181,17 +181,17 @@ export class GlobalWorkspaceDataSource extends DataSource {
|
||||
|
||||
override createQueryBuilder(
|
||||
queryRunner?: QueryRunner,
|
||||
options?: CreateQueryBuilderOptions, // eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
options?: CreateQueryBuilderOptions, // oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
): SelectQueryBuilder<any>;
|
||||
|
||||
// Only callable from workspaceEntityManager to guarantee a permission check was run
|
||||
override createQueryBuilder(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
queryRunnerOrEntityClass?: QueryRunner | EntityTarget<any>,
|
||||
aliasOrOptions?: string | CreateQueryBuilderOptions,
|
||||
queryRunner?: QueryRunner,
|
||||
options?: CreateQueryBuilderOptions,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
): SelectQueryBuilder<any> {
|
||||
let calledByWorkspaceEntityManager;
|
||||
|
||||
@@ -214,7 +214,7 @@ export class GlobalWorkspaceDataSource extends DataSource {
|
||||
}
|
||||
|
||||
if (isCalledWithEntityTarget) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
const entityClass = queryRunnerOrEntityClass as EntityTarget<any>;
|
||||
|
||||
return super.createQueryBuilder(
|
||||
@@ -229,10 +229,10 @@ export class GlobalWorkspaceDataSource extends DataSource {
|
||||
}
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
override query<T = any>(
|
||||
query: string,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
parameters?: any[],
|
||||
queryRunner?: QueryRunner,
|
||||
options?: {
|
||||
|
||||
+3
-3
@@ -71,7 +71,7 @@ export class WorkspaceSelectQueryBuilder<
|
||||
return workspaceSelectQueryBuilder;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
override async execute(): Promise<any> {
|
||||
try {
|
||||
this.validatePermissions();
|
||||
@@ -128,7 +128,7 @@ export class WorkspaceSelectQueryBuilder<
|
||||
}
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
override async getRawOne<U = any>(): Promise<U | undefined> {
|
||||
try {
|
||||
this.validatePermissions();
|
||||
@@ -139,7 +139,7 @@ export class WorkspaceSelectQueryBuilder<
|
||||
}
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
override async getRawMany<U = any>(): Promise<U[]> {
|
||||
try {
|
||||
this.validatePermissions();
|
||||
|
||||
+1
-1
@@ -132,7 +132,7 @@ const parseKeyFilter = ({
|
||||
queryBuilder: WhereExpressionBuilder;
|
||||
objectNameSingular: string;
|
||||
key: string;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
value: any;
|
||||
isFirst: boolean;
|
||||
fieldParser: GraphqlQueryFilterFieldParser;
|
||||
|
||||
@@ -40,7 +40,7 @@ export function formatData<T>(
|
||||
|
||||
const { fieldIdByName, fieldIdByJoinColumnName } = fieldMaps;
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
const newData: Record<string, any> = {};
|
||||
|
||||
for (const [key, value] of Object.entries(data)) {
|
||||
@@ -73,10 +73,10 @@ export function formatData<T>(
|
||||
}
|
||||
|
||||
export function formatCompositeField(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
value: any,
|
||||
fieldMetadata: FlatFieldMetadata,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
): Record<string, any> {
|
||||
const compositeType = compositeTypeDefinitions.get(
|
||||
fieldMetadata.type as CompositeFieldMetadataType,
|
||||
@@ -88,7 +88,7 @@ export function formatCompositeField(
|
||||
);
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
const formattedCompositeField: Record<string, any> = {};
|
||||
|
||||
for (const property of compositeType.properties) {
|
||||
@@ -107,7 +107,7 @@ export function formatCompositeField(
|
||||
}
|
||||
|
||||
function formatFieldMetadataValue(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
value: any,
|
||||
fieldMetadata: FlatFieldMetadata,
|
||||
) {
|
||||
|
||||
@@ -27,7 +27,7 @@ import { getCompositeFieldMetadataCollection } from 'src/engine/twenty-orm/utils
|
||||
import { isFieldMetadataEntityOfType } from 'src/engine/utils/is-field-metadata-of-type.util';
|
||||
|
||||
export function formatResult<T>(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
data: any,
|
||||
flatObjectMetadata: FlatObjectMetadata | undefined,
|
||||
flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>,
|
||||
@@ -250,7 +250,7 @@ export function getCompositeFieldMetadataMap(
|
||||
}
|
||||
|
||||
function formatFieldMetadataValue(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
value: any,
|
||||
fieldMetadataType: FieldMetadataType,
|
||||
) {
|
||||
@@ -325,7 +325,7 @@ function formatCompositeFieldValue(
|
||||
* or records with incomplete data.
|
||||
*/
|
||||
function handleEmptyCompositeFields(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
data: Record<string, any>,
|
||||
flatObjectMetadata: FlatObjectMetadata,
|
||||
flatFieldMetadataMaps: FlatEntityMaps<FlatFieldMetadata>,
|
||||
@@ -348,7 +348,7 @@ function handleEmptyCompositeFields(
|
||||
continue;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
const typedFieldValue = fieldValue as Record<string, any>;
|
||||
|
||||
// Check if all required properties are null/undefined
|
||||
@@ -381,7 +381,7 @@ function handleEmptyCompositeFields(
|
||||
*/
|
||||
function getDefaultCompositeFieldValue(
|
||||
fieldType: FieldMetadataType,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
): Record<string, any> | null {
|
||||
switch (fieldType) {
|
||||
case FieldMetadataType.ACTOR:
|
||||
|
||||
+1
-1
@@ -80,7 +80,7 @@ export const isRecordMatchingRLSRowLevelPermissionPredicate = ({
|
||||
flatFieldMetadataMaps,
|
||||
shouldIgnoreSoftDeleteDefaultFilter,
|
||||
}: {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
// oxlint-disable-next-line @typescripttypescript/no-explicit-any
|
||||
record: any;
|
||||
filter: RecordGqlOperationFilter;
|
||||
flatObjectMetadata: FlatObjectMetadata;
|
||||
|
||||
+1
-1
@@ -216,7 +216,7 @@ export class WorkspaceSchemaEnumManagerService {
|
||||
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}`);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user