Files
twenty/packages/twenty-front/scripts/mock-data/generate-record-data.ts
T
Charles BochetandGitHub 9d57bc39e5 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
2026-03-06 01:03:50 +01:00

114 lines
3.4 KiB
TypeScript

/* oxlint-disable no-console, lingui/no-unlocalized-strings */
import { print } from 'graphql';
import { type ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
import { generateDepthRecordGqlFieldsFromObject } from '@/object-record/graphql/record-gql-fields/utils/generateDepthRecordGqlFieldsFromObject';
import { generateFindManyRecordsQuery } from '@/object-record/utils/generateFindManyRecordsQuery';
import { graphqlRequest, writeGeneratedFile } from './utils.js';
const RECORDS_LIMIT = 10;
const OBJECTS_TO_GENERATE = [
'company',
'person',
'task',
'note',
'timelineActivity',
'workspaceMember',
'favorite',
'favoriteFolder',
'connectedAccount',
'calendarEvent',
];
// Production query builders omit __typename on connection/edge wrappers
// since Apollo Client injects them automatically. Raw fetch needs them explicit.
const addTypenamesToSelections = (query: string): string =>
query.replace(/\{(?!\s*__typename\b)/g, '{\n__typename');
const toObjectMetadataItems = (rawMetadata: {
objects: { edges: { node: Record<string, unknown> }[] };
}): ObjectMetadataItem[] =>
rawMetadata.objects.edges.map((edge) => {
const { fieldsList, indexMetadataList, ...rest } = edge.node;
return {
...rest,
fields: fieldsList,
readableFields: fieldsList,
updatableFields: fieldsList,
indexMetadatas: ((indexMetadataList as unknown[]) ?? []).map(
(index: any) => ({
...index,
indexFieldMetadatas: index.indexFieldMetadataList ?? [],
}),
),
} as unknown as ObjectMetadataItem;
});
const generateForObject = async (
token: string,
objectMetadataItems: ObjectMetadataItem[],
objectNameSingular: string,
) => {
const objectMetadataItem = objectMetadataItems.find(
(item) => item.nameSingular === objectNameSingular,
);
if (!objectMetadataItem) {
throw new Error(`${objectNameSingular} object metadata not found`);
}
const recordGqlFields = generateDepthRecordGqlFieldsFromObject({
objectMetadataItems,
objectMetadataItem,
depth: 1,
});
const queryDocument = generateFindManyRecordsQuery({
objectMetadataItem,
objectMetadataItems,
recordGqlFields,
objectPermissionsByObjectMetadataId: {},
});
const query = addTypenamesToSelections(print(queryDocument));
console.log(
`Fetching ${objectMetadataItem.namePlural} (limit: ${RECORDS_LIMIT}) from /graphql ...`,
);
const data = (await graphqlRequest('/graphql', query, token, {
limit: RECORDS_LIMIT,
})) as Record<string, { edges: { node: Record<string, unknown> }[] }>;
const records = data[objectMetadataItem.namePlural].edges.map(
(edge) => edge.node,
);
console.log(` Got ${records.length} ${objectMetadataItem.namePlural}.`);
const pascalName =
objectNameSingular.charAt(0).toUpperCase() + objectNameSingular.slice(1);
writeGeneratedFile(
`data/${objectMetadataItem.namePlural}/mock-${objectMetadataItem.namePlural}-data.ts`,
`mocked${pascalName}Records`,
'ObjectRecord[]',
"import { type ObjectRecord } from '@/object-record/types/ObjectRecord';",
records,
);
};
export const generateRecordData = async (
token: string,
rawMetadata: { objects: { edges: { node: Record<string, unknown> }[] } },
) => {
const objectMetadataItems = toObjectMetadataItems(rawMetadata);
for (const objectNameSingular of OBJECTS_TO_GENERATE) {
await generateForObject(token, objectMetadataItems, objectNameSingular);
}
};