[PR #7078] [MERGED] Formula Card: Add budget analysis functions #41355

Closed
opened 2026-04-23 14:09:13 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/7078
Author: @sys044
Created: 2/25/2026
Status: Merged
Merged: 3/17/2026
Merged by: @youngcw

Base: masterHead: feat/formula-budget-query


📝 Commits (7)

  • 1119b98 feat(formula): Add QUERY_BUDGET function for budget-aware formula reporting
  • 3031d16 docs(release): Add QUERY_BUDGET feature release notes
  • fbdccce refactor: decompose into multiple functions and support goal dimension
  • 2c0b14f [autofix.ci] apply automated fixes
  • f9b408c refactor: simplified code
  • 5188fff [autofix.ci] apply automated fixes
  • 4d01800 updated release notes

📊 Changes

4 files changed (+578 additions, -1 deletions)

View changed files

📝 packages/desktop-client/src/components/formula/codeMirror-excelLanguage.tsx (+48 -0)
📝 packages/desktop-client/src/components/formula/queryModeFunctions.ts (+48 -0)
📝 packages/desktop-client/src/hooks/useFormulaExecution.ts (+476 -1)
upcoming-release-notes/7078.md (+6 -0)

📄 Description

Description

Adds four new formula functions for budget analysis:

Query Extraction Functions:

  • QUERY_EXTRACT_CATEGORIES(queryName) - Array of category IDs from query
  • QUERY_EXTRACT_TIMEFRAME_START(queryName) - Start month (YYYY-MM) from query
  • QUERY_EXTRACT_TIMEFRAME_END(queryName) - End month (YYYY-MM) from query

Budget Query Function:

  • BUDGET_QUERY(dimension, categories, startMonth, endMonth) - Budget data for dimension

Supported dimensions: budgeted, spent, balance_start, balance_end, goal

Parameters support literal values, array notation, or extraction functions:

=BUDGET_QUERY("spent", {"5201c6be-af20-41ba-8302-85c4c65cf4d3"}, "2025-01", "2025-12")
=BUDGET_QUERY("budgeted", QUERY_EXTRACT_CATEGORIES("savings"), QUERY_EXTRACT_TIMEFRAME_START("fy"), QUERY_EXTRACT_TIMEFRAME_END("fy"))
=BUDGET_QUERY("balance_end", {"5201c6be-af20-41ba-8302-85c4c65cf4d3"}, "2025-01", QUERY_EXTRACT_TIMEFRAME_END("fy"))

https://github.com/actualbudget/actual/issues/5949

Testing

I tested by visual checks within the formula query manager alongside my real budget file to ensure the results were consistent.

Checklist

  • Release notes added (see link above)
  • No obvious regressions in affected areas
  • Self-review has been performed - I understand what each change in the code does and why it is needed

Bundle Stats

Bundle Files count Total bundle size % Changed
desktop-client 27 14.85 MB → 14.86 MB (+14.88 kB) +0.10%
loot-core 1 5.82 MB 0%
api 1 4.43 MB 0%
View detailed bundle stats

desktop-client

Total

Files count Total bundle size % Changed
27 14.85 MB → 14.86 MB (+14.88 kB) +0.10%
Changeset
File Δ Size
src/hooks/useFormulaExecution.ts 📈 +11.28 kB (+140.67%) 8.02 kB → 19.3 kB
src/components/formula/codeMirror-excelLanguage.tsx 📈 +2.2 kB (+10.43%) 21.06 kB → 23.26 kB
src/components/formula/queryModeFunctions.ts 📈 +1.41 kB (+5.96%) 23.57 kB → 24.97 kB
View detailed bundle breakdown

Added
No assets were added

Removed
No assets were removed

Bigger

Asset File Size % Changed
static/js/ReportRouter.js 1.16 MB → 1.17 MB (+11.28 kB) +0.95%
static/js/FormulaEditor.js 1.04 MB → 1.05 MB (+3.6 kB) +0.34%

Smaller
No assets were smaller

Unchanged

Asset File Size % Changed
static/js/index.js 9.54 MB 0%
static/js/indexeddb-main-thread-worker-e59fee74.js 12.94 kB 0%
static/js/workbox-window.prod.es5.js 5.64 kB 0%
static/js/ca.js 188.15 kB 0%
static/js/da.js 106.35 kB 0%
static/js/de.js 180.07 kB 0%
static/js/en-GB.js 7.18 kB 0%
static/js/en.js 170.37 kB 0%
static/js/es.js 174.55 kB 0%
static/js/fr.js 179.6 kB 0%
static/js/it.js 171.16 kB 0%
static/js/nb-NO.js 156.96 kB 0%
static/js/nl.js 106.37 kB 0%
static/js/pl.js 88.37 kB 0%
static/js/pt-BR.js 154.22 kB 0%
static/js/th.js 181.87 kB 0%
static/js/uk.js 214.74 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 120.54 kB 0%
static/js/narrow.js 637.77 kB 0%
static/js/TransactionList.js 106.22 kB 0%
static/js/wide.js 164.15 kB 0%
static/js/AppliedFilters.js 9.71 kB 0%
static/js/usePayeeRuleCounts.js 10.04 kB 0%
static/js/useTransactionBatchActions.js 13.23 kB 0%

loot-core

Total

Files count Total bundle size % Changed
1 5.82 MB 0%
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.BwrdDDMW.js 5.82 MB 0%

api

Total

Files count Total bundle size % Changed
1 4.43 MB 0%
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
bundle.api.js 4.43 MB 0%

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/7078 **Author:** [@sys044](https://github.com/sys044) **Created:** 2/25/2026 **Status:** ✅ Merged **Merged:** 3/17/2026 **Merged by:** [@youngcw](https://github.com/youngcw) **Base:** `master` ← **Head:** `feat/formula-budget-query` --- ### 📝 Commits (7) - [`1119b98`](https://github.com/actualbudget/actual/commit/1119b981fb0d633e8df3d89e4e6aff0f2b58ccf8) feat(formula): Add QUERY_BUDGET function for budget-aware formula reporting - [`3031d16`](https://github.com/actualbudget/actual/commit/3031d1623136ccd5553e1ee1632ec17cf96240c3) docs(release): Add QUERY_BUDGET feature release notes - [`fbdccce`](https://github.com/actualbudget/actual/commit/fbdccce79654325d92737a50e46c3ec83ef72c50) refactor: decompose into multiple functions and support goal dimension - [`2c0b14f`](https://github.com/actualbudget/actual/commit/2c0b14fb1a12b3decf2f60ad7378046cac93e61c) [autofix.ci] apply automated fixes - [`f9b408c`](https://github.com/actualbudget/actual/commit/f9b408c13cb95918b2d602a6e2ab77bb7c34f378) refactor: simplified code - [`5188fff`](https://github.com/actualbudget/actual/commit/5188fff60bd809903c3796f8a1fb5e7b1cbb014c) [autofix.ci] apply automated fixes - [`4d01800`](https://github.com/actualbudget/actual/commit/4d018000833d6d0518d3d044dcc418cff5dd0c5e) updated release notes ### 📊 Changes **4 files changed** (+578 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `packages/desktop-client/src/components/formula/codeMirror-excelLanguage.tsx` (+48 -0) 📝 `packages/desktop-client/src/components/formula/queryModeFunctions.ts` (+48 -0) 📝 `packages/desktop-client/src/hooks/useFormulaExecution.ts` (+476 -1) ➕ `upcoming-release-notes/7078.md` (+6 -0) </details> ### 📄 Description <!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. --> ## Description Adds four new formula functions for budget analysis: **Query Extraction Functions:** - `QUERY_EXTRACT_CATEGORIES(queryName)` - Array of category IDs from query - `QUERY_EXTRACT_TIMEFRAME_START(queryName)` - Start month (YYYY-MM) from query - `QUERY_EXTRACT_TIMEFRAME_END(queryName)` - End month (YYYY-MM) from query **Budget Query Function:** - `BUDGET_QUERY(dimension, categories, startMonth, endMonth)` - Budget data for dimension Supported dimensions: `budgeted`, `spent`, `balance_start`, `balance_end`, `goal` Parameters support literal values, array notation, or extraction functions: ``` =BUDGET_QUERY("spent", {"5201c6be-af20-41ba-8302-85c4c65cf4d3"}, "2025-01", "2025-12") =BUDGET_QUERY("budgeted", QUERY_EXTRACT_CATEGORIES("savings"), QUERY_EXTRACT_TIMEFRAME_START("fy"), QUERY_EXTRACT_TIMEFRAME_END("fy")) =BUDGET_QUERY("balance_end", {"5201c6be-af20-41ba-8302-85c4c65cf4d3"}, "2025-01", QUERY_EXTRACT_TIMEFRAME_END("fy")) ``` ## Related issue(s) https://github.com/actualbudget/actual/issues/5949 ## Testing I tested by visual checks within the formula query manager alongside my real budget file to ensure the results were consistent. ## Checklist - [ ] Release notes added (see link above) - [x] No obvious regressions in affected areas - [x] Self-review has been performed - I understand what each change in the code does and why it is needed <!--- actual-bot-sections ---> <!--- bundlestats-action-comment key:combined start ---> ### Bundle Stats Bundle | Files count | Total bundle size | % Changed ------ | ----------- | ----------------- | --------- desktop-client | 27 | 14.85 MB → 14.86 MB (+14.88 kB) | +0.10% loot-core | 1 | 5.82 MB | 0% api | 1 | 4.43 MB | 0% <details> <summary>View detailed bundle stats</summary> #### desktop-client **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 27 | 14.85 MB → 14.86 MB (+14.88 kB) | +0.10% <details> <summary>Changeset</summary> File | Δ | Size ---- | - | ---- `src/hooks/useFormulaExecution.ts` | 📈 +11.28 kB (+140.67%) | 8.02 kB → 19.3 kB `src/components/formula/codeMirror-excelLanguage.tsx` | 📈 +2.2 kB (+10.43%) | 21.06 kB → 23.26 kB `src/components/formula/queryModeFunctions.ts` | 📈 +1.41 kB (+5.96%) | 23.57 kB → 24.97 kB </details> <details> <summary>View detailed bundle breakdown</summary> <div> **Added** No assets were added **Removed** No assets were removed **Bigger** Asset | File Size | % Changed ----- | --------- | --------- static/js/ReportRouter.js | 1.16 MB → 1.17 MB (+11.28 kB) | +0.95% static/js/FormulaEditor.js | 1.04 MB → 1.05 MB (+3.6 kB) | +0.34% **Smaller** No assets were smaller **Unchanged** Asset | File Size | % Changed ----- | --------- | --------- static/js/index.js | 9.54 MB | 0% static/js/indexeddb-main-thread-worker-e59fee74.js | 12.94 kB | 0% static/js/workbox-window.prod.es5.js | 5.64 kB | 0% static/js/ca.js | 188.15 kB | 0% static/js/da.js | 106.35 kB | 0% static/js/de.js | 180.07 kB | 0% static/js/en-GB.js | 7.18 kB | 0% static/js/en.js | 170.37 kB | 0% static/js/es.js | 174.55 kB | 0% static/js/fr.js | 179.6 kB | 0% static/js/it.js | 171.16 kB | 0% static/js/nb-NO.js | 156.96 kB | 0% static/js/nl.js | 106.37 kB | 0% static/js/pl.js | 88.37 kB | 0% static/js/pt-BR.js | 154.22 kB | 0% static/js/th.js | 181.87 kB | 0% static/js/uk.js | 214.74 kB | 0% static/js/resize-observer.js | 18.37 kB | 0% static/js/BackgroundImage.js | 120.54 kB | 0% static/js/narrow.js | 637.77 kB | 0% static/js/TransactionList.js | 106.22 kB | 0% static/js/wide.js | 164.15 kB | 0% static/js/AppliedFilters.js | 9.71 kB | 0% static/js/usePayeeRuleCounts.js | 10.04 kB | 0% static/js/useTransactionBatchActions.js | 13.23 kB | 0% </div> </details> --- #### loot-core **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 5.82 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **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.BwrdDDMW.js | 5.82 MB | 0% </div> </details> --- #### api **Total** Files count | Total bundle size | % Changed ----------- | ----------------- | --------- 1 | 4.43 MB | 0% <details> <summary>View detailed bundle breakdown</summary> <div> **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 ----- | --------- | --------- bundle.api.js | 4.43 MB | 0% </div> </details> </details> <!--- bundlestats-action-comment key:combined end ---> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-23 14:09:13 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#41355