TWNTY-2244 - ESLint rule: enforce usage of .getLoadable() + .getValue() to get atoms (#4143)

* ESLint rule: enforce usage of .getLoadable() + .getValue() to get atoms

Co-authored-by: Matheus <matheus_benini@hotmail.com>

* Merge main

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>

* Fix

* Refactor according to review

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>

* Fix linter issue

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>

* Fix linter

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>

---------

Co-authored-by: gitstart-twenty <gitstart-twenty@users.noreply.github.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>
Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Lucas Bordeau <bordeau.lucas@gmail.com>
This commit is contained in:
gitstart-app[bot]
2024-03-06 00:24:20 +01:00
committed by GitHub
parent 706b5d3cf1
commit b2210bd418
17 changed files with 180 additions and 24 deletions

View File

@ -48,6 +48,7 @@ module.exports = {
'@nx/workspace-styled-components-prefixed-with-styled': 'error',
'@nx/workspace-no-state-useref': 'error',
'@nx/workspace-component-props-naming': 'error',
'@nx/workspace-use-getLoadable-and-getValue-to-get-atoms': 'error',
'react/no-unescaped-entities': 'off',
'react/prop-types': 'off',

View File

@ -46,7 +46,7 @@ export const useGetRelationMetadata = () =>
objectNameType: 'singular',
}),
)
.valueOrThrow();
.getValue();
if (!relationObjectMetadataItem) return null;

View File

@ -35,7 +35,7 @@ export const useRecordBoardDeprecatedCardFieldsInternal = (
async (
field: Omit<ColumnDefinition<FieldMetadata>, 'size' | 'position'>,
) => {
const existingFields = await snapshot
const existingFields = snapshot
.getLoadable(recordBoardCardFieldsScopedState({ scopeId }))
.getValue();

View File

@ -11,16 +11,14 @@ export const useRemoveRecordBoardDeprecatedCardIdsInternal = () => {
return useRecoilCallback(
({ snapshot, set }) =>
(cardIdToRemove: string[]) => {
const boardColumns = snapshot
.getLoadable(boardColumnsState)
.valueOrThrow();
const boardColumns = snapshot.getLoadable(boardColumnsState).getValue();
boardColumns.forEach((boardColumn) => {
const columnCardIds = snapshot
.getLoadable(
recordBoardCardIdsByColumnIdFamilyState(boardColumn.id),
)
.valueOrThrow();
.getValue();
set(
recordBoardCardIdsByColumnIdFamilyState(boardColumn.id),
columnCardIds.filter((cardId) => !cardIdToRemove.includes(cardId)),

View File

@ -19,7 +19,9 @@ export const useSetRecordBoardDeprecatedCardSelectedInternal = (props: any) => {
const setCardSelected = useRecoilCallback(
({ set, snapshot }) =>
(cardId: string, selected: boolean) => {
const activeCardIds = snapshot.getLoadable(activeCardIdsState).contents;
const activeCardIds = snapshot
.getLoadable(activeCardIdsState)
.getValue();
set(isRecordBoardDeprecatedCardSelectedFamilyState(cardId), selected);
set(actionBarOpenState, selected || activeCardIds.length > 0);
@ -39,7 +41,9 @@ export const useSetRecordBoardDeprecatedCardSelectedInternal = (props: any) => {
const unselectAllActiveCards = useRecoilCallback(
({ set, snapshot }) =>
() => {
const activeCardIds = snapshot.getLoadable(activeCardIdsState).contents;
const activeCardIds = snapshot
.getLoadable(activeCardIdsState)
.getValue();
activeCardIds.forEach((cardId: string) => {
set(isRecordBoardDeprecatedCardSelectedFamilyState(cardId), false);

View File

@ -68,7 +68,7 @@ export const useUpdateCompanyBoardColumnsInternal = () => {
for (const [id, companyProgress] of Object.entries(companyBoardIndex)) {
const currentCompanyProgress = snapshot
.getLoadable(companyProgressesFamilyState(id))
.valueOrThrow();
.getValue();
if (!isDeeplyEqual(currentCompanyProgress, companyProgress)) {
set(companyProgressesFamilyState(id), companyProgress);
@ -78,11 +78,11 @@ export const useUpdateCompanyBoardColumnsInternal = () => {
const currentPipelineSteps = snapshot
.getLoadable(currentPipelineStepsState)
.valueOrThrow();
.getValue();
const currentBoardColumns = snapshot
.getLoadable(boardColumnsState)
.valueOrThrow();
.getValue();
if (!isDeeplyEqual(pipelineSteps, currentPipelineSteps)) {
set(currentPipelineStepsState, pipelineSteps);
@ -133,7 +133,7 @@ export const useUpdateCompanyBoardColumnsInternal = () => {
.getLoadable(
recordBoardCardIdsByColumnIdFamilyState(boardColumn.id),
)
.valueOrThrow();
.getValue();
if (!isDeeplyEqual(currentBoardCardIds, boardCardIds)) {
set(

View File

@ -10,7 +10,7 @@ export const useSetRecordInStore = () => {
records.forEach((record) => {
const currentRecord = snapshot
.getLoadable(recordStoreFamilyState(record.id))
.valueOrThrow();
.getValue();
if (JSON.stringify(currentRecord) !== JSON.stringify(record)) {
set(recordStoreFamilyState(record.id), record);

View File

@ -26,7 +26,7 @@ export const useLeaveTableFocus = (recordTableId?: string) => {
const currentHotkeyScope = snapshot
.getLoadable(currentHotkeyScopeState)
.valueOrThrow();
.getValue();
if (!isSoftFocusActive) {
return;

View File

@ -24,7 +24,7 @@ export const useSetRecordTableData = ({
// TODO: refactor with scoped state later
const currentEntity = snapshot
.getLoadable(recordStoreFamilyState(entity.id))
.valueOrThrow();
.getValue();
if (JSON.stringify(currentEntity) !== JSON.stringify(entity)) {
set(recordStoreFamilyState(entity.id), entity);

View File

@ -19,8 +19,10 @@ export const usePipelineSteps = () => {
const handlePipelineStepAdd = useRecoilCallback(
({ snapshot }) =>
async (boardColumn: BoardColumnDefinition) => {
const currentPipeline = await snapshot.getPromise(currentPipelineState);
(boardColumn: BoardColumnDefinition) => {
const currentPipeline = snapshot
.getLoadable(currentPipelineState)
.getValue();
if (!currentPipeline?.id) return;
return createOnePipelineStep?.({
@ -35,8 +37,10 @@ export const usePipelineSteps = () => {
const handlePipelineStepDelete = useRecoilCallback(
({ snapshot }) =>
async (boardColumnId: string) => {
const currentPipeline = await snapshot.getPromise(currentPipelineState);
(boardColumnId: string) => {
const currentPipeline = snapshot
.getLoadable(currentPipelineState)
.getValue();
if (!currentPipeline?.id) return;
return deleteOnePipelineStep?.(boardColumnId);

View File

@ -14,7 +14,7 @@ export const usePreviousHotkeyScope = () => {
() => {
const previousHotkeyScope = snapshot
.getLoadable(previousHotkeyScopeState)
.valueOrThrow();
.getValue();
if (!previousHotkeyScope) {
return;
@ -35,7 +35,7 @@ export const usePreviousHotkeyScope = () => {
(scope: string, customScopes?: CustomHotkeyScopes) => {
const currentHotkeyScope = snapshot
.getLoadable(currentHotkeyScopeState)
.valueOrThrow();
.getValue();
setHotkeyScope(scope, customScopes);
set(previousHotkeyScopeState, currentHotkeyScope);

View File

@ -25,7 +25,7 @@ export const useScopedHotkeyCallback = () =>
}) => {
const currentHotkeyScopes = snapshot
.getLoadable(internalHotkeysEnabledScopesState)
.valueOrThrow();
.getValue();
if (!currentHotkeyScopes.includes(scope)) {
if (DEBUG_HOTKEY_SCOPE) {

View File

@ -27,7 +27,7 @@ export const useSetHotkeyScope = () =>
async (hotkeyScopeToSet: string, customScopes?: CustomHotkeyScopes) => {
const currentHotkeyScope = snapshot
.getLoadable(currentHotkeyScopeState)
.valueOrThrow();
.getValue();
if (currentHotkeyScope.scope === hotkeyScopeToSet) {
if (!isNonNullable(customScopes)) {