Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert MergeUnusedPayeesModal.jsx to tsx #3866

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Conversation

joel-jeremy
Copy link
Contributor

No description provided.

@actual-github-bot actual-github-bot bot changed the title Convert MergeUnusedPayeesModal.jsx to tsx [WIP] Convert MergeUnusedPayeesModal.jsx to tsx Nov 21, 2024
Copy link

netlify bot commented Nov 21, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit 6d9f5aa
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/673e79368874c80008befd50
😎 Deploy Preview https://deploy-preview-3866.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@joel-jeremy joel-jeremy changed the title [WIP] Convert MergeUnusedPayeesModal.jsx to tsx Convert MergeUnusedPayeesModal.jsx to tsx Nov 21, 2024
Copy link
Contributor

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
10 5.42 MB → 5.42 MB (+232 B) +0.00%
Changeset
File Δ Size
src/components/modals/MergeUnusedPayeesModal.tsx 🆕 +6.52 kB 0 B → 6.52 kB
src/components/modals/MergeUnusedPayeesModal.jsx 🔥 -6.3 kB (-100%) 6.3 kB → 0 B
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
static/js/index.js 3.44 MB → 3.44 MB (+232 B) +0.01%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/narrow.js 82.72 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/wide.js 241.19 kB 0%
static/js/ReportRouter.js 1.49 MB 0%

Copy link
Contributor

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.32 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.32 MB 0%

Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

Walkthrough

The pull request introduces significant modifications to the MergeUnusedPayeesModal component located in MergeUnusedPayeesModal.tsx. A new type, MergeUnusedPayeesModalProps, is defined to enforce type safety for the component's props, which include payeeIds (an array of PayeeEntity['id']) and targetPayeeId (a single PayeeEntity['id']). The function signature of the component is updated to reflect these changes. Additionally, the flashRef is explicitly typed as HTMLUListElement | null. The state initialization for payees is altered to filter allPayees based on the provided payeeIds. The onMerge and onMergeAndCreateRule functions are refactored to use useCallback, ensuring they reference the correct payees state and pass the appropriate targetPayee argument when invoked. Overall, the changes enhance type safety and clarify the component's logic while maintaining the existing control flow.

Possibly related PRs

Suggested labels

sparkles: Merged

Suggested reviewers

  • matt-fidd
  • MikesGlitch

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/desktop-client/src/components/modals/MergeUnusedPayeesModal.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eslint-plugin".

(The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eslint-plugin@latest --save-dev

The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/desktop-client/src/components/modals/MergeUnusedPayeesModal.tsx (1)

121-124: Consider adding type safety to mapped JSX props

While the conversion is good, consider adding explicit type annotations to the mapped JSX props for better type safety:

-{payees.map(payee => (
+{payees.map((payee: PayeeEntity) => (
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f523d25 and 6d9f5aa.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3866.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/modals/MergeUnusedPayeesModal.tsx (6 hunks)
🔇 Additional comments (6)
packages/desktop-client/src/components/modals/MergeUnusedPayeesModal.tsx (6)

Line range hint 1-24: LGTM! Well-structured type definitions

The TypeScript types are well-defined and properly imported. The MergeUnusedPayeesModalProps type correctly represents the component's props structure.


26-35: LGTM! Proper TypeScript component signature

The component signature is correctly typed with the new MergeUnusedPayeesModalProps interface, and the flashRef is properly typed as HTMLUListElement.


53-54: LGTM! Well-typed state initialization

The payees state is properly typed as PayeeEntity[] and efficiently initialized with the filter logic in the state initializer.


57-76: LGTM! Well-implemented merge callback

The onMerge callback is properly typed with TypeScript and correctly uses the useCallback hook with appropriate dependencies.


78-88: LGTM! Well-implemented merge and create rule callback

The onMergeAndCreateRule callback is properly typed and correctly uses the useCallback hook with appropriate dependencies.


90-92: LGTM! Proper null handling

The targetPayee lookup and null handling follow TypeScript best practices with appropriate type safety.

Comment on lines +53 to 55
const [payees] = useState<PayeeEntity[]>(() =>
allPayees.filter(p => payeeIds.includes(p.id)),
);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much nicer!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants