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:
@@ -22,7 +22,7 @@ import { useUpdateEffect } from '~/hooks/useUpdateEffect';
|
||||
import { isMatchingLocation } from '~/utils/isMatchingLocation';
|
||||
|
||||
export const useApolloFactory = (options: Partial<Options<any>> = {}) => {
|
||||
// eslint-disable-next-line twenty/no-state-useref
|
||||
// oxlint-disable-next-line twenty/no-state-useref
|
||||
const apolloRef = useRef<ApolloFactory<NormalizedCacheObject> | null>(null);
|
||||
|
||||
const navigate = useNavigate();
|
||||
@@ -108,7 +108,7 @@ export const useApolloFactory = (options: Partial<Options<any>> = {}) => {
|
||||
});
|
||||
|
||||
return apolloRef.current.getClient();
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
// oxlint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, [
|
||||
setTokenPair,
|
||||
setCurrentUser,
|
||||
|
||||
+3
-3
@@ -56,10 +56,10 @@ export const triggerUpdateGroupByQueriesOptimisticEffect = ({
|
||||
const updatedGroupByConnections = cachedGroupByConnections.map(
|
||||
(groupConnection) => {
|
||||
const groupByDimensionValues =
|
||||
readField('groupByDimensionValues', groupConnection) || [];
|
||||
readField('groupByDimensionValues', groupConnection) ?? [];
|
||||
|
||||
const cachedEdges =
|
||||
readField<RecordGqlRefEdge[]>('edges', groupConnection) || [];
|
||||
readField<RecordGqlRefEdge[]>('edges', groupConnection) ?? [];
|
||||
|
||||
const cachedTotalCount = readField<number | undefined>(
|
||||
'totalCount',
|
||||
@@ -166,7 +166,7 @@ export const triggerUpdateGroupByQueriesOptimisticEffect = ({
|
||||
const dimensionKey = recordDimensionValues.join('|');
|
||||
const dimensionExists = updatedGroupByConnections.some((conn) => {
|
||||
const connDimensionValues =
|
||||
readField('groupByDimensionValues', conn) || [];
|
||||
readField('groupByDimensionValues', conn) ?? [];
|
||||
return (
|
||||
Array.isArray(connDimensionValues) &&
|
||||
connDimensionValues.join('|') === dimensionKey
|
||||
|
||||
+1
-1
@@ -165,7 +165,7 @@ export const triggerCreateRecordsOptimisticEffect = ({
|
||||
},
|
||||
);
|
||||
|
||||
if (recordToCreateReference && !recordAlreadyInCache) {
|
||||
if (isDefined(recordToCreateReference) && !recordAlreadyInCache) {
|
||||
const cursor = encodeCursor(recordToCreate);
|
||||
|
||||
const edge = {
|
||||
|
||||
+1
-1
@@ -94,7 +94,7 @@ export const triggerDestroyRecordsOptimisticEffect = ({
|
||||
cachedEdges?.filter((cachedEdge) => {
|
||||
const nodeId = readField<string>('id', cachedEdge.node);
|
||||
|
||||
return nodeId && !recordIdsToDestroy.includes(nodeId);
|
||||
return isDefined(nodeId) && !recordIdsToDestroy.includes(nodeId);
|
||||
}) || [];
|
||||
|
||||
if (nextCachedEdges.length === cachedEdges?.length)
|
||||
|
||||
@@ -139,7 +139,7 @@ export class ApolloFactory<TCacheShape> implements ApolloManager<TCacheShape> {
|
||||
attempts: {
|
||||
max: 2,
|
||||
retryIf: (error) => {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.log('retryIf error from retryLink', error);
|
||||
if (this.isAuthenticationError(error)) {
|
||||
return false;
|
||||
@@ -163,14 +163,14 @@ export class ApolloFactory<TCacheShape> implements ApolloManager<TCacheShape> {
|
||||
renewalPromise = renewToken(graphqlUri, getTokenPair())
|
||||
.then((tokens) => {
|
||||
if (isDefined(tokens)) {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.log('setTokenPair from handleTokenRenewal');
|
||||
onTokenPairChange?.(tokens);
|
||||
cookieStorage.setItem('tokenPair', JSON.stringify(tokens));
|
||||
}
|
||||
})
|
||||
.catch(() => {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.log(
|
||||
'Failed to renew token, triggering unauthenticated error from handleTokenRenewal',
|
||||
);
|
||||
@@ -234,7 +234,7 @@ export class ApolloFactory<TCacheShape> implements ApolloManager<TCacheShape> {
|
||||
});
|
||||
})
|
||||
.catch((sentryError) => {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.error(
|
||||
'Failed to capture GraphQL error with Sentry:',
|
||||
sentryError,
|
||||
@@ -248,7 +248,7 @@ export class ApolloFactory<TCacheShape> implements ApolloManager<TCacheShape> {
|
||||
onErrorCb?.(graphQLErrors);
|
||||
for (const graphQLError of graphQLErrors) {
|
||||
if (graphQLError.message === 'Unauthorized') {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.log('Unauthorized, triggering token renewal');
|
||||
return handleTokenRenewal(operation, forward);
|
||||
}
|
||||
@@ -262,7 +262,7 @@ export class ApolloFactory<TCacheShape> implements ApolloManager<TCacheShape> {
|
||||
return;
|
||||
}
|
||||
case 'UNAUTHENTICATED': {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.log('UNAUTHENTICATED, triggering token renewal');
|
||||
return handleTokenRenewal(operation, forward);
|
||||
}
|
||||
@@ -294,7 +294,7 @@ export class ApolloFactory<TCacheShape> implements ApolloManager<TCacheShape> {
|
||||
this.isRestOperation(operation) &&
|
||||
this.isAuthenticationError(networkError as ServerError)
|
||||
) {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.log(
|
||||
'Authentication error, triggering token renewal from errorLink',
|
||||
);
|
||||
|
||||
@@ -6,7 +6,7 @@ export const createCaptchaRefreshLink = (
|
||||
return new ApolloLink((operation, forward) => {
|
||||
const { variables } = operation;
|
||||
|
||||
const hasCaptchaToken = variables && 'captchaToken' in variables;
|
||||
const hasCaptchaToken = variables != null && 'captchaToken' in variables;
|
||||
|
||||
return forward(operation).map((response) => {
|
||||
if (hasCaptchaToken) {
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
import { OperationType } from '@/apollo/types/operation-type';
|
||||
|
||||
const operationTypeColors = {
|
||||
// eslint-disable-next-line twenty/no-hardcoded-colors
|
||||
// oxlint-disable-next-line twenty/no-hardcoded-colors
|
||||
query: '#03A9F4',
|
||||
// eslint-disable-next-line twenty/no-hardcoded-colors
|
||||
// oxlint-disable-next-line twenty/no-hardcoded-colors
|
||||
mutation: '#61A600',
|
||||
// eslint-disable-next-line twenty/no-hardcoded-colors
|
||||
// oxlint-disable-next-line twenty/no-hardcoded-colors
|
||||
subscription: '#61A600',
|
||||
// eslint-disable-next-line twenty/no-hardcoded-colors
|
||||
// oxlint-disable-next-line twenty/no-hardcoded-colors
|
||||
error: '#F51818',
|
||||
// eslint-disable-next-line twenty/no-hardcoded-colors
|
||||
// oxlint-disable-next-line twenty/no-hardcoded-colors
|
||||
default: '#61A600',
|
||||
};
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ export const getTokenPair = (): AuthTokenPair | undefined => {
|
||||
const stringTokenPair = cookieStorage.getItem('tokenPair');
|
||||
|
||||
if (!isDefined(stringTokenPair)) {
|
||||
// eslint-disable-next-line no-console
|
||||
// oxlint-disable-next-line no-console
|
||||
console.log('tokenPair is undefined');
|
||||
|
||||
return undefined;
|
||||
|
||||
@@ -40,7 +40,7 @@ export const loggerLink = (getSchemaName: (operation: Operation) => string) =>
|
||||
|
||||
console.groupCollapsed(...titleArgs);
|
||||
|
||||
if (variables && Object.keys(variables).length !== 0) {
|
||||
if (Object.keys(variables).length !== 0) {
|
||||
logDebug('VARIABLES', variables);
|
||||
}
|
||||
|
||||
@@ -70,7 +70,7 @@ export const loggerLink = (getSchemaName: (operation: Operation) => string) =>
|
||||
errors.forEach((err: any) => {
|
||||
logDebug(
|
||||
`%c${err.message}`,
|
||||
// eslint-disable-next-line twenty/no-hardcoded-colors
|
||||
// oxlint-disable-next-line twenty/no-hardcoded-colors
|
||||
'color: #F51818; font-weight: lighter',
|
||||
);
|
||||
});
|
||||
@@ -78,7 +78,7 @@ export const loggerLink = (getSchemaName: (operation: Operation) => string) =>
|
||||
|
||||
logDebug('HEADERS: ', headers);
|
||||
|
||||
if (variables && Object.keys(variables).length !== 0) {
|
||||
if (Object.keys(variables).length !== 0) {
|
||||
logDebug('VARIABLES', variables);
|
||||
}
|
||||
|
||||
|
||||
@@ -107,13 +107,13 @@ export class StreamingRestLink extends ApolloLink {
|
||||
try {
|
||||
const definition = operation.query.definitions[0];
|
||||
|
||||
if (!definition || definition.kind !== 'OperationDefinition') {
|
||||
if (!isDefined(definition) || definition.kind !== 'OperationDefinition') {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (
|
||||
!definition.selectionSet ||
|
||||
!definition.selectionSet.selections ||
|
||||
!isDefined(definition.selectionSet) ||
|
||||
!isDefined(definition.selectionSet.selections) ||
|
||||
definition.selectionSet.selections.length === 0
|
||||
) {
|
||||
return null;
|
||||
@@ -121,7 +121,7 @@ export class StreamingRestLink extends ApolloLink {
|
||||
|
||||
const selection = definition.selectionSet.selections[0];
|
||||
|
||||
if (!selection || !isDefined(selection.directives)) {
|
||||
if (!isDefined(selection) || !isDefined(selection.directives)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user