♻️ (eslint) disallow importing actual-app/web in loot-core #4347

MatissJanis · 2025-02-10T20:31:14Z

No description provided.

netlify · 2025-02-10T20:31:34Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`a64f084`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/67aa621434839f0008c05974
😎 Deploy Preview	https://deploy-preview-4347.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions · 2025-02-10T20:32:37Z

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
16	6.83 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
static/js/workbox-window.prod.es5.js	5.69 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/useAccountPreviewTransactions.js	1.69 kB	0%
static/js/en-GB.js	99.33 kB	0%
static/js/wide.js	102.8 kB	0%
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/en.js	99.43 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/AppliedFilters.js	10.52 kB	0%
static/js/narrow.js	84.94 kB	0%
static/js/nl.js	94.83 kB	0%
static/js/uk.js	111.11 kB	0%
static/js/pt-BR.js	104.03 kB	0%
static/js/de.js	110.85 kB	0%
static/js/ReportRouter.js	1.59 MB	0%
static/js/index.js	4.29 MB	0%

github-actions · 2025-02-10T20:32:38Z

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.33 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.33 MB	0%

coderabbitai · 2025-02-10T20:49:06Z

Walkthrough

This pull request updates the ESLint configuration for the loot-core package to enforce stricter import boundaries. The changes modify the no-restricted-imports rule to prevent imports from the @actual-app/web package within the loot-core directory and enforce the use of relative paths instead of using pattern matching like loot-core/*. Additionally, inline comments have been added across various files to signal the need for future fixes related to these import restrictions. Several files now include imports of the useSyncedPref hook, accompanied by comments that highlight the intended restriction on importing from @actual-app/web. Despite these updates, the core functionality and existing method signatures of the affected modules remain unchanged.

Possibly related PRs

show all occurrences of upcoming schedules within the upcoming period #4166: Restricts imports from @actual-app/web in the ESLint configuration, aligning directly with the changes in this PR.
Add back eslint useDispatch and useSelector rules #4123: Modifies the no-restricted-imports rule in the ESLint configuration, presenting a code-level connection with the current updates.
fix first occurrence of some schedules moved after the weekend not showing in preview #4256: Addresses import restrictions in the transactions.ts file, matching the context of similar import control changes in this PR.

Suggested labels

:sparkles: Merged

Suggested reviewers

youngcw
jfdoming

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ee70e7 and a64f084.

⛔ Files ignored due to path filters (1)

upcoming-release-notes/4347.md is excluded by !**/*.md

📒 Files selected for processing (4)

eslint.config.mjs (1 hunks)
packages/loot-core/src/client/actions/prefs.ts (1 hunks)
packages/loot-core/src/client/data-hooks/schedules.tsx (1 hunks)
packages/loot-core/src/client/data-hooks/transactions.ts (1 hunks)

✅ Files skipped from review due to trivial changes (2)

packages/loot-core/src/client/actions/prefs.ts
packages/loot-core/src/client/data-hooks/transactions.ts

🔇 Additional comments (1)

eslint.config.mjs (1)

693-696: LGTM!

The ESLint rule correctly enforces the package boundary by disallowing imports from @actual-app/web in loot-core.

coderabbitai · 2025-02-10T20:49:09Z

packages/loot-core/src/client/data-hooks/schedules.tsx

+// eslint-disable-next-line no-restricted-imports -- fix me -- do not import @actual-app/web in loot-core
 import { useSyncedPref } from '@actual-app/web/src/hooks/useSyncedPref';


⚠️ Potential issue

Move preference management to loot-core.

The import from @actual-app/web violates the package boundary. Consider moving the preference management logic to loot-core to maintain proper separation of concerns.

Do you want me to help create a new preference management module within loot-core?

matt-fidd

LGTM!

♻️ (eslint) disallow importing actual-app/web in loot-core

a64f084

actual-github-bot bot changed the title ~~♻️ (eslint) disallow importing actual-app/web in loot-core~~ [WIP] ♻️ (eslint) disallow importing actual-app/web in loot-core Feb 10, 2025

actual-github-bot bot added the 🚧 WIP label Feb 10, 2025

MatissJanis changed the title ~~[WIP] ♻️ (eslint) disallow importing actual-app/web in loot-core~~ ♻️ (eslint) disallow importing actual-app/web in loot-core Feb 10, 2025

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Feb 10, 2025

coderabbitai bot reviewed Feb 10, 2025

View reviewed changes

matt-fidd approved these changes Feb 11, 2025

View reviewed changes

actual-github-bot bot added ✅ Approved and removed 🔍 Ready for review labels Feb 11, 2025

matt-fidd mentioned this pull request Feb 11, 2025

♻️ replace loot-core/src imports with loot-core #4349

Merged

MatissJanis merged commit be1c194 into master Feb 11, 2025
20 checks passed

MatissJanis deleted the matiss/eslint-actual-app-web-loot-core branch February 11, 2025 18:22

actual-github-bot bot added ✨ Merged and removed ✅ Approved labels Feb 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

♻️ (eslint) disallow importing actual-app/web in loot-core #4347

♻️ (eslint) disallow importing actual-app/web in loot-core #4347

MatissJanis commented Feb 10, 2025

netlify bot commented Feb 10, 2025 •

edited

Loading

github-actions bot commented Feb 10, 2025

github-actions bot commented Feb 10, 2025

coderabbitai bot commented Feb 10, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Feb 10, 2025

matt-fidd left a comment

		// eslint-disable-next-line no-restricted-imports -- fix me -- do not import @actual-app/web in loot-core
		import { useSyncedPref } from '@actual-app/web/src/hooks/useSyncedPref';

♻️ (eslint) disallow importing actual-app/web in loot-core #4347

♻️ (eslint) disallow importing actual-app/web in loot-core #4347

Conversation

MatissJanis commented Feb 10, 2025

netlify bot commented Feb 10, 2025 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Feb 10, 2025

Bundle Stats — desktop-client

github-actions bot commented Feb 10, 2025

Bundle Stats — loot-core

coderabbitai bot commented Feb 10, 2025

Walkthrough

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Feb 10, 2025

Choose a reason for hiding this comment

matt-fidd left a comment

Choose a reason for hiding this comment

netlify bot commented Feb 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)