{"id":13701354,"url":"https://github.com/galvez/plainbudget","last_synced_at":"2025-05-12T10:32:17.435Z","repository":{"id":48213976,"uuid":"134828531","full_name":"galvez/plainbudget","owner":"galvez","description":"Minimalist Plain Text Budgeting","archived":false,"fork":false,"pushed_at":"2025-05-08T13:39:04.000Z","size":431,"stargazers_count":168,"open_issues_count":6,"forks_count":6,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-08T13:41:59.909Z","etag":null,"topics":["nuxt","plaintext","spreadsheet","vue"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/galvez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-25T08:36:53.000Z","updated_at":"2025-05-08T13:39:08.000Z","dependencies_parsed_at":"2022-09-21T03:21:22.671Z","dependency_job_id":null,"html_url":"https://github.com/galvez/plainbudget","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galvez%2Fplainbudget","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galvez%2Fplainbudget/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galvez%2Fplainbudget/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galvez%2Fplainbudget/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/galvez","download_url":"https://codeload.github.com/galvez/plainbudget/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253411588,"owners_count":21904153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nuxt","plaintext","spreadsheet","vue"],"created_at":"2024-08-02T20:01:32.066Z","updated_at":"2025-05-12T10:32:17.417Z","avatar_url":"https://github.com/galvez.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\n\u003cimg src=\"https://github.com/user-attachments/assets/1fa28cd2-230f-47f2-92bb-8b8b4c70ba4f\" width=\"128px\"\u003e\n\n# PlainBudget\n\nMinimalist plain text budgeting.\n\n[**Read the blog post.**](https://hire.jonasgalvez.com.br/2025/may/8/plainbudget)\n\n[**Get the app.**](https://plainbudget.com/)\n\n```\n% npm i pbudget -g\n% pbudget -s Budget.txt\n% pbudget --stats Budget.txt\n% cat Budget.txt | pbudget \u003e Budget.txt\n```\n\n## Supported Syntax\n\n- **Groups** start with `=` and are used to group values.\n\n- **Flows** start with `+` and are used to express cash flow.\n\n- **Groups** can be referenced in other groups or flows.\n\n- **Multipliers** can added to any referenced group or value.\n\n- Blocks of text with invalid syntax will be ignored and remain intact in the source.\n\n- Circular dependencies (group references) will cause both groups to be ignored.\n\n- Padding is automatically added to the value column.\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003ctd valign=top\u003e\n\n**Input**\n\n```\n= Main\n- 2000 Rent\n- 1000 Utilities\n- 500 Leisure\n\n= Groceries\n- 10 Coffee x 12\n- 10 Milk x 12\n- 20 Cereal x 6\n\n= Income\n- 5000 Salary\n- 1000 Side hustle\n\n+ Income\n- Main\n- Groceries\n```\n\n\u003c/td\u003e\n\u003ctd valign=top\u003e\n\n**Output**\n\n```\n  = 3500 Main\n  - 2000 Rent\n  - 1000 Utilities\n  -  500 Leisure\n  \n  =  360 Groceries\n  -   10 Coffee x 12\n  -   10 Milk x 12\n  -   20 Cereal x 6\n  \n  = 6000 Income\n  - 5000 Salary\n  - 1000 Side hustle\n  \n  + 6000 Income\n  - 3500 Main\n  -  360 Groceries\n  = 2140 \n```\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## Programmatic Usage\n\n```js\nimport { readFileSync } from 'node:fs'\nimport { PlainBudget } from 'pbudget'\n\nconst budget = readFileSync('Budget.txt', 'utf8')\n\nconst pbudget = new PlainBudget(budget)\n\npbudget.process()\n\nconsole.log(pbudget.renderWithPadding())\n\npbudget.computeStats()\n\nconsole.log(pbudget.stats)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalvez%2Fplainbudget","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalvez%2Fplainbudget","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalvez%2Fplainbudget/lists"}