bc4ae35bc4
## Summary - **Enhanced the `matching-state-variable` ESLint rule** to enforce consistent naming for `ComponentState`, `FamilyState`, and `ComponentFamilyState` hooks — previously it only covered `useAtomState` and `useAtomStateValue` - **The rule now checks 12 hooks** across three categories: value hooks (`useAtomComponentStateValue`, `useAtomFamilyStateValue`, etc.), state hooks (`useAtomComponentState`, `useAtomComponentFamilyState`), and setter hooks (`useSetAtomState`, `useSetAtomComponentState`, `useSetAtomFamilyState`, `useSetAtomComponentFamilyState`) - **Fixed all 225 resulting lint violations** across 151 files, renaming variables to match their state atom names (e.g. `currentViewId` → `contextStoreCurrentViewId`, `selectedRecord` → `recordStore`). Cases where the same state is accessed with different family keys/instance IDs are suppressed with `eslint-disable-next-line`. ## Naming convention | Hook | State argument | Valid | Invalid | |------|---------------|-------|---------| | `useAtomStateValue` | `fooState` | `const foo = ...` | `const bar = ...` | | `useAtomComponentStateValue` | `fooComponentState` | `const foo = ...` | `const bar = ...` | | `useAtomFamilyStateValue` | `fooFamilyState` | `const foo = ...` | `const bar = ...` | | `useAtomComponentFamilyStateValue` | `fooComponentFamilyState` | `const foo = ...` | `const bar = ...` | | `useAtomState` | `fooState` | `const [foo, setFoo] = ...` | `const [bar, setBar] = ...` | | `useAtomComponentState` | `fooComponentState` | `const [foo, setFoo] = ...` | `const [bar, setBar] = ...` | | `useAtomComponentFamilyState` | `fooComponentFamilyState` | `const [foo, setFoo] = ...` | `const [bar, setBar] = ...` | | `useSetAtomState` | `fooState` | `const setFoo = ...` | `const setBar = ...` | | `useSetAtomComponentState` | `fooComponentState` | `const setFoo = ...` | `const setBar = ...` | | `useSetAtomFamilyState` | `fooFamilyState` | `const setFoo = ...` | `const setBar = ...` | | `useSetAtomComponentFamilyState` | `fooComponentFamilyState` | `const setFoo = ...` | `const setBar = ...` |
87 lines
3.3 KiB
TypeScript
87 lines
3.3 KiB
TypeScript
import { useBasePageLayout } from '@/page-layout/hooks/useBasePageLayout';
|
|
import { usePageLayoutWithRelationWidgets } from '@/page-layout/hooks/usePageLayoutWithRelationWidgets';
|
|
import { pageLayoutCurrentLayoutsComponentState } from '@/page-layout/states/pageLayoutCurrentLayoutsComponentState';
|
|
import { pageLayoutDraftComponentState } from '@/page-layout/states/pageLayoutDraftComponentState';
|
|
import { pageLayoutIsInitializedComponentState } from '@/page-layout/states/pageLayoutIsInitializedComponentState';
|
|
import { pageLayoutPersistedComponentState } from '@/page-layout/states/pageLayoutPersistedComponentState';
|
|
import { type PageLayout } from '@/page-layout/types/PageLayout';
|
|
import { convertPageLayoutToTabLayouts } from '@/page-layout/utils/convertPageLayoutToTabLayouts';
|
|
import { useAtomComponentStateCallbackState } from '@/ui/utilities/state/jotai/hooks/useAtomComponentStateCallbackState';
|
|
import { useAtomComponentState } from '@/ui/utilities/state/jotai/hooks/useAtomComponentState';
|
|
import { useStore } from 'jotai';
|
|
import { useCallback, useEffect } from 'react';
|
|
import { isDefined } from 'twenty-shared/utils';
|
|
import { isDeeplyEqual } from '~/utils/isDeeplyEqual';
|
|
|
|
type PageLayoutInitializationQueryEffectProps = {
|
|
pageLayoutId: string;
|
|
onInitialized?: (pageLayout: PageLayout) => void;
|
|
};
|
|
|
|
export const PageLayoutInitializationQueryEffect = ({
|
|
pageLayoutId,
|
|
onInitialized,
|
|
}: PageLayoutInitializationQueryEffectProps) => {
|
|
const [pageLayoutIsInitialized, setPageLayoutIsInitialized] =
|
|
useAtomComponentState(pageLayoutIsInitializedComponentState);
|
|
|
|
const basePageLayout = useBasePageLayout(pageLayoutId);
|
|
|
|
const pageLayout = usePageLayoutWithRelationWidgets(basePageLayout);
|
|
|
|
const pageLayoutPersistedComponentCallbackState =
|
|
useAtomComponentStateCallbackState(pageLayoutPersistedComponentState);
|
|
|
|
const pageLayoutDraftComponentCallbackState =
|
|
useAtomComponentStateCallbackState(pageLayoutDraftComponentState);
|
|
|
|
const pageLayoutCurrentLayoutsComponentCallbackState =
|
|
useAtomComponentStateCallbackState(pageLayoutCurrentLayoutsComponentState);
|
|
|
|
const store = useStore();
|
|
|
|
const initializePageLayout = useCallback(
|
|
(layout: PageLayout) => {
|
|
const currentPersisted = store.get(
|
|
pageLayoutPersistedComponentCallbackState,
|
|
);
|
|
|
|
if (!isDeeplyEqual(layout, currentPersisted)) {
|
|
store.set(pageLayoutPersistedComponentCallbackState, layout);
|
|
store.set(pageLayoutDraftComponentCallbackState, {
|
|
id: layout.id,
|
|
name: layout.name,
|
|
type: layout.type,
|
|
objectMetadataId: layout.objectMetadataId,
|
|
tabs: layout.tabs,
|
|
});
|
|
|
|
const tabLayouts = convertPageLayoutToTabLayouts(layout);
|
|
store.set(pageLayoutCurrentLayoutsComponentCallbackState, tabLayouts);
|
|
}
|
|
},
|
|
[
|
|
pageLayoutCurrentLayoutsComponentCallbackState,
|
|
pageLayoutDraftComponentCallbackState,
|
|
pageLayoutPersistedComponentCallbackState,
|
|
store,
|
|
],
|
|
);
|
|
|
|
useEffect(() => {
|
|
if (!pageLayoutIsInitialized && isDefined(pageLayout)) {
|
|
initializePageLayout(pageLayout);
|
|
onInitialized?.(pageLayout);
|
|
setPageLayoutIsInitialized(true);
|
|
}
|
|
}, [
|
|
initializePageLayout,
|
|
pageLayoutIsInitialized,
|
|
pageLayout,
|
|
onInitialized,
|
|
setPageLayoutIsInitialized,
|
|
]);
|
|
|
|
return null;
|
|
};
|