Skip to content

A local-first personal finance app

:recycle: (eslint) enable some rules to enforce better code quality (#2357)

Matiss Janis Aboltinse650e00cb825
diff --git a/.eslintrc.js b/.eslintrc.js
index 53796782da..a1374f06b8 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -38,6 +38,7 @@ module.exports = {
extends: [
'react-app',
'plugin:react/recommended',
+ 'plugin:react/jsx-runtime',
'plugin:prettier/recommended',
'plugin:@typescript-eslint/recommended',
'plugin:import/typescript',
@@ -57,7 +58,7 @@ module.exports = {
'@typescript-eslint/no-unused-vars': [
'warn',
{
- varsIgnorePattern: '^_',
+ varsIgnorePattern: '^(_|React)',
ignoreRestSiblings: true,
},
],
@@ -90,15 +91,7 @@ module.exports = {
'react/prop-types': 'off',
// TODO: re-enable these rules
- 'react-hooks/exhaustive-deps': 'off',
- 'react/display-name': 'off',
'react/react-in-jsx-scope': 'off',
- // 'react-hooks/exhaustive-deps': [
- // 'warn',
- // {
- // additionalHooks: 'useLiveQuery',
- // },
- // ],
'no-var': 'warn',
'react/jsx-curly-brace-presence': 'warn',
@@ -277,6 +270,70 @@ module.exports = {
'import/no-default-export': 'off',
},
},
+ {
+ // TODO: fix the issues in these files
+ files: [
+ './packages/desktop-client/src/components/accounts/Account.jsx',
+ './packages/desktop-client/src/components/accounts/MobileAccount.jsx',
+ './packages/desktop-client/src/components/accounts/MobileAccounts.jsx',
+ './packages/desktop-client/src/components/App.tsx',
+ './packages/desktop-client/src/components/budget/BudgetCategories.jsx',
+ './packages/desktop-client/src/components/budget/BudgetSummaries.tsx',
+ './packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx',
+ './packages/desktop-client/src/components/budget/index.tsx',
+ './packages/desktop-client/src/components/budget/MobileBudget.tsx',
+ './packages/desktop-client/src/components/budget/rollover/HoldTooltip.tsx',
+ './packages/desktop-client/src/components/budget/rollover/TransferTooltip.tsx',
+ './packages/desktop-client/src/components/common/Menu.tsx',
+ './packages/desktop-client/src/components/FinancesApp.tsx',
+ './packages/desktop-client/src/components/GlobalKeys.ts',
+ './packages/desktop-client/src/components/KeyHandlers.tsx',
+ './packages/desktop-client/src/components/LoggedInUser.tsx',
+ './packages/desktop-client/src/components/manager/ManagementApp.jsx',
+ './packages/desktop-client/src/components/manager/subscribe/common.tsx',
+ './packages/desktop-client/src/components/ManageRules.tsx',
+ './packages/desktop-client/src/components/mobile/MobileAmountInput.jsx',
+ './packages/desktop-client/src/components/mobile/MobileNavTabs.tsx',
+ './packages/desktop-client/src/components/Modals.tsx',
+ './packages/desktop-client/src/components/modals/EditRule.jsx',
+ './packages/desktop-client/src/components/modals/ImportTransactions.jsx',
+ './packages/desktop-client/src/components/modals/MergeUnusedPayees.jsx',
+ './packages/desktop-client/src/components/Notifications.tsx',
+ './packages/desktop-client/src/components/payees/ManagePayees.jsx',
+ './packages/desktop-client/src/components/payees/ManagePayeesWithData.jsx',
+ './packages/desktop-client/src/components/payees/PayeeTable.tsx',
+ './packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTable.tsx',
+ './packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableTotals.tsx',
+ './packages/desktop-client/src/components/reports/reports/CashFlowCard.jsx',
+ './packages/desktop-client/src/components/reports/reports/CustomReport.jsx',
+ './packages/desktop-client/src/components/reports/reports/NetWorthCard.jsx',
+ './packages/desktop-client/src/components/reports/SaveReportName.tsx',
+ './packages/desktop-client/src/components/reports/useReport.ts',
+ './packages/desktop-client/src/components/schedules/ScheduleDetails.jsx',
+ './packages/desktop-client/src/components/schedules/SchedulesTable.tsx',
+ './packages/desktop-client/src/components/select/DateSelect.tsx',
+ './packages/desktop-client/src/components/sidebar/Tools.tsx',
+ './packages/desktop-client/src/components/sort.tsx',
+ './packages/desktop-client/src/components/spreadsheet/useSheetValue.ts',
+ './packages/desktop-client/src/components/table.tsx',
+ './packages/desktop-client/src/components/Titlebar.tsx',
+ './packages/desktop-client/src/components/transactions/MobileTransaction.jsx',
+ './packages/desktop-client/src/components/transactions/SelectedTransactions.jsx',
+ './packages/desktop-client/src/components/transactions/SimpleTransactionsTable.jsx',
+ './packages/desktop-client/src/components/transactions/TransactionList.jsx',
+ './packages/desktop-client/src/components/transactions/TransactionsTable.jsx',
+ './packages/desktop-client/src/components/transactions/TransactionsTable.test.jsx',
+ './packages/desktop-client/src/hooks/useAccounts.ts',
+ './packages/desktop-client/src/hooks/useCategories.ts',
+ './packages/desktop-client/src/hooks/usePayees.ts',
+ './packages/desktop-client/src/hooks/useProperFocus.tsx',
+ './packages/desktop-client/src/hooks/useSelected.tsx',
+ './packages/loot-core/src/client/query-hooks.tsx',
+ ],
+ rules: {
+ 'react-hooks/exhaustive-deps': 'off',
+ },
+ },
],
settings: {
'import/resolver': {
diff --git a/packages/desktop-client/src/components/budget/BudgetCategories.jsx b/packages/desktop-client/src/components/budget/BudgetCategories.jsx
index 51183003fc..fd708f3824 100644
--- a/packages/desktop-client/src/components/budget/BudgetCategories.jsx
+++ b/packages/desktop-client/src/components/budget/BudgetCategories.jsx
@@ -345,3 +345,5 @@ export const BudgetCategories = memo(
);
},
);
+
+BudgetCategories.displayName = 'BudgetCategories';
diff --git a/packages/desktop-client/src/components/budget/BudgetPageHeader.tsx b/packages/desktop-client/src/components/budget/BudgetPageHeader.tsx
index 4f29b9e2d4..4db9767f5b 100644
--- a/packages/desktop-client/src/components/budget/BudgetPageHeader.tsx
+++ b/packages/desktop-client/src/components/budget/BudgetPageHeader.tsx
@@ -44,3 +44,5 @@ export const BudgetPageHeader = memo<BudgetPageHeaderProps>(
);
},
);
+
+BudgetPageHeader.displayName = 'BudgetPageHeader';
diff --git a/packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx b/packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx
index ab366f3a60..1422a021c9 100644
--- a/packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx
+++ b/packages/desktop-client/src/components/budget/DynamicBudgetTable.tsx
@@ -96,6 +96,8 @@ const DynamicBudgetTableInner = forwardRef<
},
);
+DynamicBudgetTableInner.displayName = 'DynamicBudgetTableInner';
+
export const DynamicBudgetTable = forwardRef<
typeof BudgetTable,
DynamicBudgetTableInnerProps
@@ -113,3 +115,5 @@ export const DynamicBudgetTable = forwardRef<
</AutoSizer>
);
});
+
+DynamicBudgetTable.displayName = 'DynamicBudgetTable';
diff --git a/packages/desktop-client/src/components/budget/index.tsx b/packages/desktop-client/src/components/budget/index.tsx
index 724a969c23..0fc28ec312 100644
--- a/packages/desktop-client/src/components/budget/index.tsx
+++ b/packages/desktop-client/src/components/budget/index.tsx
@@ -434,6 +434,8 @@ const RolloverBudgetSummary = memo<{ month: string }>(props => {
);
});
+RolloverBudgetSummary.displayName = 'RolloverBudgetSummary';
+
export function Budget() {
const titlebar = useContext(TitlebarContext);
diff --git a/packages/desktop-client/src/components/common/Button.tsx b/packages/desktop-client/src/components/common/Button.tsx
index f565e83a00..3158d0b2b1 100644
--- a/packages/desktop-client/src/components/common/Button.tsx
+++ b/packages/desktop-client/src/components/common/Button.tsx
@@ -204,6 +204,8 @@ export const Button = forwardRef<HTMLButtonElement, ButtonProps>(
},
);
+Button.displayName = 'Button';
+
type ButtonWithLoadingProps = ButtonProps & {
loading?: boolean;
};
@@ -246,3 +248,5 @@ export const ButtonWithLoading = forwardRef<
</Button>
);
});
+
+ButtonWithLoading.displayName = 'ButtonWithLoading';
diff --git a/packages/desktop-client/src/components/common/Card.tsx b/packages/desktop-client/src/components/common/Card.tsx
index 49b6a400cd..14625a9cb0 100644
--- a/packages/desktop-client/src/components/common/Card.tsx
+++ b/packages/desktop-client/src/components/common/Card.tsx
@@ -35,3 +35,5 @@ export const Card = forwardRef<HTMLDivElement, CardProps>(
);
},
);
+
+Card.displayName = 'Card';
diff --git a/packages/desktop-client/src/components/common/ExternalLink.tsx b/packages/desktop-client/src/components/common/ExternalLink.tsx
index 979a62a902..5dbb9c94ce 100644
--- a/packages/desktop-client/src/components/common/ExternalLink.tsx
+++ b/packages/desktop-client/src/components/common/ExternalLink.tsx
@@ -28,3 +28,5 @@ export const ExternalLink = forwardRef<HTMLAnchorElement, ExternalLinkProps>(
</a>
),
);
+
+ExternalLink.displayName = 'ExternalLink';
diff --git a/packages/desktop-client/src/components/common/Stack.tsx b/packages/desktop-client/src/components/common/Stack.tsx
index a8e6f5c463..17f348bc48 100644
--- a/packages/desktop-client/src/components/common/Stack.tsx
+++ b/packages/desktop-client/src/components/common/Stack.tsx
@@ -95,3 +95,5 @@ export const Stack = forwardRef<HTMLDivElement, StackProps>(
);
},
);
+
+Stack.displayName = 'Stack';
diff --git a/packages/desktop-client/src/components/payees/ManagePayees.jsx b/packages/desktop-client/src/components/payees/ManagePayees.jsx
index 70afd912bb..da15bb8593 100644
--- a/packages/desktop-client/src/components/payees/ManagePayees.jsx
+++ b/packages/desktop-client/src/components/payees/ManagePayees.jsx
@@ -321,3 +321,5 @@ export const ManagePayees = forwardRef(
);
},
);
+
+ManagePayees.displayName = 'ManagePayees';
diff --git a/packages/desktop-client/src/components/payees/PayeeTable.tsx b/packages/desktop-client/src/components/payees/PayeeTable.tsx
index f3cd910aff..3efbaaad8e 100644
--- a/packages/desktop-client/src/components/payees/PayeeTable.tsx
+++ b/packages/desktop-client/src/components/payees/PayeeTable.tsx
@@ -80,3 +80,5 @@ export const PayeeTable = forwardRef<
);
},
);
+
+PayeeTable.displayName = 'PayeeTable';
diff --git a/packages/desktop-client/src/components/payees/PayeeTableRow.tsx b/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
index a9c1182242..3c3f1c8143 100644
--- a/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
+++ b/packages/desktop-client/src/components/payees/PayeeTableRow.tsx
@@ -151,3 +151,5 @@ export const PayeeTableRow = memo(
);
},
);
+
+PayeeTableRow.displayName = 'PayeeTableRow';
diff --git a/packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableRow.tsx b/packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableRow.tsx
index 831f0b0910..ad6ba5c3dd 100644
--- a/packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableRow.tsx
+++ b/packages/desktop-client/src/components/reports/graphs/tableGraph/ReportTableRow.tsx
@@ -138,3 +138,5 @@ export const ReportTableRow = memo(
);
},
);
+
+ReportTableRow.displayName = 'ReportTableRow';
diff --git a/packages/desktop-client/src/components/rules/RuleRow.tsx b/packages/desktop-client/src/components/rules/RuleRow.tsx
index 844100ccf5..d8a0713ccf 100644
--- a/packages/desktop-client/src/components/rules/RuleRow.tsx
+++ b/packages/desktop-client/src/components/rules/RuleRow.tsx
@@ -124,3 +124,5 @@ export const RuleRow = memo(
);
},
);
+
+RuleRow.displayName = 'RuleRow';
diff --git a/packages/desktop-client/src/components/select/DateSelect.tsx b/packages/desktop-client/src/components/select/DateSelect.tsx
index 6893edc8d2..4ccaa1a242 100644
--- a/packages/desktop-client/src/components/select/DateSelect.tsx
+++ b/packages/desktop-client/src/components/select/DateSelect.tsx
@@ -164,6 +164,8 @@ const DatePicker = forwardRef<DatePickerForwardedRef, DatePickerProps>(
},
);
+DatePicker.displayName = 'DatePicker';
+
function defaultShouldSaveFromKey(e) {
return e.key === 'Enter';
}
diff --git a/packages/desktop-client/src/components/table.tsx b/packages/desktop-client/src/components/table.tsx
index 5a51dd0f9f..e3a51e3435 100644
--- a/packages/desktop-client/src/components/table.tsx
+++ b/packages/desktop-client/src/components/table.tsx
@@ -598,6 +598,8 @@ export const CellButton = forwardRef<HTMLDivElement, CellButtonProps>(
},
);
+CellButton.displayName = 'CellButton';
+
type SelectCellProps = Omit<ComponentProps<typeof Cell>, 'children'> & {
partial?: boolean;
onEdit?: () => void;
@@ -1163,6 +1165,9 @@ export const Table = forwardRef(
props: TableProps<T> & { ref?: Ref<TableHandleRef<T>> },
) => ReactElement;
+// @ts-expect-error fix me
+Table.displayName = 'Table';
+
export type TableNavigator<T extends TableItem> = {
onEdit: (id: T['id'], field?: string) => void;
editingId: T['id'];
diff --git a/packages/desktop-client/src/components/transactions/MobileTransaction.jsx b/packages/desktop-client/src/components/transactions/MobileTransaction.jsx
index bbce43aee6..bf97e9d59c 100644
--- a/packages/desktop-client/src/components/transactions/MobileTransaction.jsx
+++ b/packages/desktop-client/src/components/transactions/MobileTransaction.jsx
@@ -429,6 +429,8 @@ const ChildTransactionEdit = forwardRef(
},
);
+ChildTransactionEdit.displayName = 'ChildTransactionEdit';
+
const TransactionEditInner = memo(function TransactionEditInner({
adding,
accounts,
@@ -1548,3 +1550,5 @@ const ListItem = forwardRef(({ children, style, ...props }, ref) => {
</View>
);
});
+
+ListItem.displayName = 'ListItem';
diff --git a/packages/desktop-client/src/components/transactions/TransactionsTable.jsx b/packages/desktop-client/src/components/transactions/TransactionsTable.jsx
index c99d1d7597..89ca9550ba 100644
--- a/packages/desktop-client/src/components/transactions/TransactionsTable.jsx
+++ b/packages/desktop-client/src/components/transactions/TransactionsTable.jsx
@@ -393,6 +393,8 @@ const TransactionHeader = memo(
},
);
+TransactionHeader.displayName = 'TransactionHeader';
+
function getPayeePretty(transaction, payee, transferAcct) {
const { payee: payeeId } = transaction;
@@ -2266,3 +2268,5 @@ export const TransactionTable = forwardRef((props, ref) => {
/>
);
});
+
+TransactionTable.displayName = 'TransactionTable';
diff --git a/upcoming-release-notes/2357.md b/upcoming-release-notes/2357.md
new file mode 100644
index 0000000000..6284a4f844
--- /dev/null
+++ b/upcoming-release-notes/2357.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MatissJanis]
+---
+
+eslint: re-enable some rules to enforce better code quality