Files
twenty/packages/twenty-eslint-rules/rules/no-state-useref.ts
T
Félix Malfait c737028dd6 Move tools/eslint-rules to packages/twenty-eslint-rules (#17203)
## Summary

Moves the custom ESLint rules from `tools/eslint-rules` to
`packages/twenty-eslint-rules` for better organization within the
monorepo packages structure.

## Changes

- Move `eslint-rules` from `tools/` to `packages/twenty-eslint-rules`
- Use `loadWorkspaceRules` from `@nx/eslint-plugin` to load custom rules
- Update all ESLint configs to use the `twenty/` rule prefix instead of
`@nx/workspace-`
- Update `project.json`, `jest.config.mjs` with new paths
- Update `package.json` workspaces and `nx.json` cache inputs
- Update Dockerfile reference

## Technical Details

The custom ESLint rules are now loaded using Nx's `loadWorkspaceRules`
utility which:
- Handles TypeScript transpilation automatically
- Allows loading workspace rules from any directory
- Provides a cleaner approach than the previous `@nx/workspace-`
convention

## Testing

- Verified all 17 custom ESLint rules load correctly from the new
location
- Verified linting works on dependent packages (twenty-front,
twenty-server, etc.)
2026-01-17 07:37:17 +01:00

45 lines
1.3 KiB
TypeScript

import { ESLintUtils } from '@typescript-eslint/utils';
import { isIdentifier } from '@typescript-eslint/utils/ast-utils';
// NOTE: The rule will be available in ESLint configs as "@nx/workspace-no-state-useref"
export const RULE_NAME = 'no-state-useref';
export const rule = ESLintUtils.RuleCreator(() => __filename)({
name: RULE_NAME,
meta: {
docs: {
description: "Don't use useRef for state management",
},
messages: {
test: 'test',
noStateUseRef:
"Don't use useRef for state management. See https://docs.twenty.com/developer/frontend/best-practices#do-not-use-useref-to-store-state for more details.",
},
type: 'suggestion',
schema: [],
},
defaultOptions: [],
create: (context) => {
return {
CallExpression: (node) => {
if (!isIdentifier(node.callee) || node.callee.name !== 'useRef') return;
const typeParam = node.typeArguments?.params[0];
if (
!typeParam ||
typeParam.type !== 'TSTypeReference' ||
!isIdentifier(typeParam.typeName) ||
!typeParam.typeName.name.match(/^(HTML.*Element|Element)$/)
) {
context.report({
node,
messageId: 'noStateUseRef',
});
return;
}
},
};
},
});