enhance: allow prefix for budget templates #4032
Conversation
for example: Prime video: #template $10
actual-github-bot
bot
changed the title
✅ Deploy Preview for actualbudget ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Bundle Stats — desktop-clientHey 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
Changeset No files were changed View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
Bundle Stats — loot-coreHey 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
Changeset
View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger
Smaller No assets were smaller Unchanged No assets were unchanged |
UnderKoen
changed the title
|
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
packages/loot-core/src/server/budget/template-notes.test.tsOops! 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: 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. WalkthroughThe pull request introduces modifications to the budget template parsing logic across multiple files. In the Possibly related PRs
Suggested labels
Suggested reviewers
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/loot-core/src/server/budget/template-notes.ts (1)
85-85: Ensure robust prefix handling and clarity in regex usageSwitching from
startsWith(TEMPLATE_PREFIX)tomatch(new RegExp('^[^#]*#template'))broadens the matching criteria, supporting prefixes. This is good for flexibility, but be mindful of lines with special characters or edge cases (e.g., lines with trailing spaces, or lines where#may appear multiple times). Consider testing such edge cases if they exist in user input.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
upcoming-release-notes/4032.mdis excluded by!**/*.md
📒 Files selected for processing (3)
packages/loot-core/src/server/budget/goal-template.pegjs(2 hunks)packages/loot-core/src/server/budget/template-notes.test.ts(1 hunks)packages/loot-core/src/server/budget/template-notes.ts(1 hunks)
🧰 Additional context used
📓 Learnings (1)
packages/loot-core/src/server/budget/goal-template.pegjs (2)
Learnt from: youngcw
PR: actualbudget/actual#3754
File: packages/loot-core/src/server/budget/goal-template.pegjs:38-43
Timestamp: 2024-11-10T16:45:25.627Z
Learning: In `packages/loot-core/src/server/budget/goal-template.pegjs`, within the `limit` rule, the optional space `_?` is always placed before the `hold` option, ensuring consistency.
Learnt from: youngcw
PR: actualbudget/actual#3754
File: packages/loot-core/src/server/budget/goal-template.pegjs:38-43
Timestamp: 2024-11-10T16:45:25.627Z
Learning: Validations for limit rules, such as checking start date validity and ensuring amounts are positive, are performed during template processing, not in the parser defined in `goal-template.pegjs`.
🔇 Additional comments (3)
packages/loot-core/src/server/budget/goal-template.pegjs (2)
38-42: Return structure enhancements for the limit rule
The new structure for weekly, daily, and monthly limit returns is consistent and includes all necessary properties (amount, hold, start, period). This is beneficial for clarity and uniformity. Ensure relevant unit tests thoroughly cover each branch, including the newly introduced 'weekly' usage.
66-66: Regex-based matching for template rule
Changing the template rule to [ ^#]* '#template' priority: priority? aligns with the updated prefix logic. Be sure to handle edge cases where additional # characters might appear in the line. Also confirm that the presence of potential special characters before #template does not cause unintended matches.
packages/loot-core/src/server/budget/template-notes.test.ts (1)
76-95: Expanded test coverage for prefixed template lines
The new test case ensures that lines containing a prefix before #template are correctly parsed. This is a valuable addition, confirming that recent changes in template-notes.ts and goal-template.pegjs support prefixed inputs. However, consider adding negative or malformed prefix scenarios (e.g., spaces, punctuation, or multiple # markers) to ensure robust coverage.
| @@ -63,7 +63,7 @@ schedule = 'schedule'i | |||
| full = 'full'i _ {return true} | |||
| priority = '-'i number: number {return number} | |||
| remainder = 'remainder'i _? weight: positive? { return +weight || 1 } | |||
| template = '#template' priority: priority? {return {priority: +priority, directive: 'template'}} | |||
| template = [^#]* '#template' priority: priority? {return {priority: +priority, directive: 'template'}} | |||
There was a problem hiding this comment.
Could this function be moved into the notes file instead of in the parser?
for example:
Prime video: #template $10