9d57bc39e5
## 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
143 lines
3.9 KiB
TypeScript
143 lines
3.9 KiB
TypeScript
export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent';
|
|
|
|
export type LoggerConfig = {
|
|
logLevel: LogLevel;
|
|
isTestEnvironment: boolean;
|
|
captureForResponse: boolean;
|
|
};
|
|
|
|
const LOG_LEVELS: Record<LogLevel, number> = {
|
|
debug: 0,
|
|
info: 1,
|
|
warn: 2,
|
|
error: 3,
|
|
silent: 4,
|
|
};
|
|
|
|
const loggerRegistry = new Set<AppLogger>();
|
|
|
|
export class AppLogger {
|
|
private config: LoggerConfig;
|
|
private context: string;
|
|
private capturedLogs: string[] = [];
|
|
|
|
constructor(context: string) {
|
|
this.context = context;
|
|
this.config = {
|
|
logLevel: this.parseLogLevel(process.env.LOG_LEVEL || 'error'),
|
|
isTestEnvironment: process.env.NODE_ENV === 'test' || process.env.JEST_WORKER_ID !== undefined,
|
|
captureForResponse: process.env.CAPTURE_LOGS === 'true',
|
|
};
|
|
|
|
// Silence logs in test environment unless explicitly overridden
|
|
if (this.config.isTestEnvironment && process.env.LOG_LEVEL === undefined) {
|
|
this.config.logLevel = 'silent';
|
|
}
|
|
}
|
|
|
|
private parseLogLevel(level: string): LogLevel {
|
|
const normalizedLevel = level.toLowerCase() as LogLevel;
|
|
return Object.keys(LOG_LEVELS).includes(normalizedLevel) ? normalizedLevel : 'error';
|
|
}
|
|
|
|
private shouldLog(level: LogLevel): boolean {
|
|
return LOG_LEVELS[level] >= LOG_LEVELS[this.config.logLevel];
|
|
}
|
|
|
|
private safeStringify(value: unknown): string {
|
|
try {
|
|
if (typeof value === 'string') return value;
|
|
return JSON.stringify(value);
|
|
} catch {
|
|
return '[unserializable]';
|
|
}
|
|
}
|
|
|
|
private captureLog(level: LogLevel, message: string, ...args: unknown[]): void {
|
|
if (!this.config.captureForResponse) {
|
|
return;
|
|
}
|
|
|
|
const timestamp = new Date().toISOString();
|
|
const formattedMessage =
|
|
args.length > 0
|
|
? `${message} ${args.map((arg) => this.safeStringify(arg)).join(' ')}`
|
|
: message;
|
|
|
|
this.capturedLogs.push(
|
|
`[${timestamp}] [${level.toUpperCase()}] [${this.context}] ${formattedMessage}`,
|
|
);
|
|
}
|
|
|
|
debug(message: string, ...args: unknown[]): void {
|
|
this.captureLog('debug', message, ...args);
|
|
if (this.shouldLog('debug')) {
|
|
// oxlint-disable-next-line no-console
|
|
console.log(`[${this.context}] ${message}`, ...args);
|
|
}
|
|
}
|
|
|
|
info(message: string, ...args: unknown[]): void {
|
|
this.captureLog('info', message, ...args);
|
|
if (this.shouldLog('info')) {
|
|
// oxlint-disable-next-line no-console
|
|
console.log(`[${this.context}] ${message}`, ...args);
|
|
}
|
|
}
|
|
|
|
warn(message: string, ...args: unknown[]): void {
|
|
this.captureLog('warn', message, ...args);
|
|
if (this.shouldLog('warn')) {
|
|
// oxlint-disable-next-line no-console
|
|
console.warn(`[${this.context}] ${message}`, ...args);
|
|
}
|
|
}
|
|
|
|
error(message: string, ...args: unknown[]): void {
|
|
this.captureLog('error', message, ...args);
|
|
if (this.shouldLog('error')) {
|
|
// oxlint-disable-next-line no-console
|
|
console.error(`[${this.context}] ${message}`, ...args);
|
|
}
|
|
}
|
|
|
|
// For fatal errors, security issues, or data corruption - always visible
|
|
critical(message: string, ...args: unknown[]): void {
|
|
this.captureLog('error', `CRITICAL: ${message}`, ...args);
|
|
// oxlint-disable-next-line no-console
|
|
console.error(`[${this.context}] CRITICAL: ${message}`, ...args);
|
|
}
|
|
|
|
getCapturedLogs(): string[] {
|
|
return [...this.capturedLogs];
|
|
}
|
|
|
|
clearCapturedLogs(): void {
|
|
this.capturedLogs = [];
|
|
}
|
|
}
|
|
|
|
export const createLogger = (context: string): AppLogger => {
|
|
const logger = new AppLogger(context);
|
|
loggerRegistry.add(logger);
|
|
return logger;
|
|
};
|
|
|
|
export const removeLogger = (logger: AppLogger): void => {
|
|
loggerRegistry.delete(logger);
|
|
};
|
|
|
|
export const getAllCapturedLogs = (): string[] => {
|
|
const allLogs: string[] = [];
|
|
for (const logger of loggerRegistry) {
|
|
allLogs.push(...logger.getCapturedLogs());
|
|
}
|
|
return allLogs.sort();
|
|
};
|
|
|
|
export const clearAllCapturedLogs = (): void => {
|
|
for (const logger of loggerRegistry) {
|
|
logger.clearCapturedLogs();
|
|
}
|
|
};
|