mirror of
https://github.com/twentyhq/twenty.git
synced 2026-04-20 23:14:20 -04:00
## 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
135 lines
3.5 KiB
TypeScript
135 lines
3.5 KiB
TypeScript
/* oxlint-disable no-console */
|
|
import * as fs from 'fs';
|
|
import * as path from 'path';
|
|
import { fileURLToPath } from 'url';
|
|
|
|
process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
|
|
|
|
const SERVER_BASE_URL =
|
|
process.env.REACT_APP_SERVER_BASE_URL ?? 'http://localhost:3000';
|
|
const AUTH_EMAIL = 'jane.austen@apple.dev';
|
|
const AUTH_PASSWORD = 'tim@apple.dev';
|
|
const WORKSPACE_SUBDOMAIN = 'apple';
|
|
|
|
const serverUrl = new URL(SERVER_BASE_URL);
|
|
export const WORKSPACE_ORIGIN = `${serverUrl.protocol}//${WORKSPACE_SUBDOMAIN}.${serverUrl.host}`;
|
|
|
|
const currentDir = path.dirname(fileURLToPath(import.meta.url));
|
|
export const GENERATED_DIR = path.resolve(
|
|
currentDir,
|
|
'../../src/testing/mock-data/generated',
|
|
);
|
|
|
|
export const graphqlRequest = async (
|
|
endpoint: string,
|
|
query: string,
|
|
token?: string,
|
|
variables?: Record<string, unknown>,
|
|
): Promise<unknown> => {
|
|
const headers: Record<string, string> = {
|
|
'Content-Type': 'application/json',
|
|
Origin: WORKSPACE_ORIGIN,
|
|
};
|
|
|
|
if (token !== undefined) {
|
|
headers['Authorization'] = `Bearer ${token}`;
|
|
}
|
|
|
|
const response = await fetch(`${SERVER_BASE_URL}${endpoint}`, {
|
|
method: 'POST',
|
|
headers,
|
|
body: JSON.stringify({ query, variables }),
|
|
});
|
|
|
|
const json = (await response.json()) as {
|
|
data?: unknown;
|
|
errors?: { message: string }[];
|
|
};
|
|
|
|
if (
|
|
json.errors !== undefined &&
|
|
json.errors !== null &&
|
|
json.errors.length > 0
|
|
) {
|
|
const errorDetails = json.errors.map((error) => error.message).join(', ');
|
|
throw new Error(`GraphQL error on ${endpoint}: ${errorDetails}`);
|
|
}
|
|
|
|
return json.data;
|
|
};
|
|
|
|
export const authenticate = async (): Promise<string> => {
|
|
console.log(
|
|
`Authenticating as ${AUTH_EMAIL} on workspace ${WORKSPACE_SUBDOMAIN}...`,
|
|
);
|
|
|
|
const loginData = (await graphqlRequest(
|
|
'/metadata',
|
|
`mutation GetLoginTokenFromCredentials {
|
|
getLoginTokenFromCredentials(
|
|
email: "${AUTH_EMAIL}",
|
|
password: "${AUTH_PASSWORD}",
|
|
origin: "${WORKSPACE_ORIGIN}"
|
|
) {
|
|
loginToken { token }
|
|
}
|
|
}`,
|
|
)) as {
|
|
getLoginTokenFromCredentials: { loginToken: { token: string } };
|
|
};
|
|
|
|
const loginToken = loginData.getLoginTokenFromCredentials.loginToken.token;
|
|
|
|
const authData = (await graphqlRequest(
|
|
'/metadata',
|
|
`mutation GetAuthTokensFromLoginToken {
|
|
getAuthTokensFromLoginToken(
|
|
loginToken: "${loginToken}",
|
|
origin: "${WORKSPACE_ORIGIN}"
|
|
) {
|
|
tokens {
|
|
accessOrWorkspaceAgnosticToken { token }
|
|
}
|
|
}
|
|
}`,
|
|
)) as {
|
|
getAuthTokensFromLoginToken: {
|
|
tokens: { accessOrWorkspaceAgnosticToken: { token: string } };
|
|
};
|
|
};
|
|
|
|
const accessToken =
|
|
authData.getAuthTokensFromLoginToken.tokens.accessOrWorkspaceAgnosticToken
|
|
.token;
|
|
|
|
console.log('Authenticated successfully.');
|
|
return accessToken;
|
|
};
|
|
|
|
export const writeGeneratedFile = (
|
|
relativePath: string,
|
|
exportName: string,
|
|
typeName: string,
|
|
typeImport: string,
|
|
data: unknown,
|
|
) => {
|
|
const filePath = path.join(GENERATED_DIR, relativePath);
|
|
fs.mkdirSync(path.dirname(filePath), { recursive: true });
|
|
|
|
const content = [
|
|
'/* oxlint-disable */',
|
|
'// @ts-nocheck',
|
|
typeImport,
|
|
'',
|
|
'// This file was automatically generated — do not edit manually.',
|
|
'',
|
|
'// prettier-ignore',
|
|
`export const ${exportName}: ${typeName} =`,
|
|
JSON.stringify(data, null, 2) + ';',
|
|
'',
|
|
].join('\n');
|
|
|
|
fs.writeFileSync(filePath, content, 'utf-8');
|
|
console.log(`Written: ${filePath}`);
|
|
};
|