Skip to content

Make sample config json valid #2

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

Merged
merged 2 commits into from
Aug 2, 2024
Merged

Conversation

sycdan
Copy link
Contributor

@sycdan sycdan commented Jun 24, 2024

Last night I happened to search for "cli budgeting tool", fully expecting Google to laugh in my face because why would such a thing exist, at which point I would have proceeded to write this exact tool only in Python. However! This was the first hit and I loved it instantly.

I have just started getting it set up, but my first order of business was to make a parser for my Amex statements, and I thought I'd share.

Bonus documentation changes:

  • configuration:
    • Add closing square bracket to autoCategorization array in sample config
    • Remove a couple of trailing commas for consistency
    • Use tabs throughout for consistency
    • Remove trailing whitespace
    • Remove extra tab level in amount description
  • usage:
    • remove unused --input argument name

@joshcanhelp
Copy link
Owner

@sycdan - I'm so sorry for the delay here! Thank you so much for your contribution! I'm right in the middle of getting another project out but I'll come back and review in the next couple of days. Thank you for making my day with a PR!

@joshcanhelp
Copy link
Owner

If you could check the minor comments here and run the listing/formatting locally, I'm fine with merging:

https://github.com/joshcanhelp/budget-cli/blob/main/CONTRIBUTING.md#i-want-to-make-code-changes

Thanks again @sycdan!

@sycdan
Copy link
Contributor Author

sycdan commented Jul 6, 2024

Awesome, will try to publish the cleanup soon!

bonus:
- Make sample config json valid
- Fix minor issues in usage doc
- Update name of example translator
@joshcanhelp
Copy link
Owner

@sycdan - Hey there ... just checking in on this. If you're not able to look at the spacing in the docs, I can give it a look. Thanks!

@sycdan
Copy link
Contributor Author

sycdan commented Aug 1, 2024

Sorry, I thought I had fixed up what things you pointed out. What would you like me to do? Change tabs to spaces?

@@ -4,80 +4,81 @@ This tool can be configured using a `.budget-cli.json` file in the root of this

```json
{
"outputFile": {
Copy link
Owner

Choose a reason for hiding this comment

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

It looks like the spacing here went from spaces to tabs, making it hard to see any changes that might have been made.

@joshcanhelp joshcanhelp merged commit 2bd44f8 into joshcanhelp:main Aug 2, 2024
1 check passed
@joshcanhelp
Copy link
Owner

@sycdan - Thanks again for this!

@sycdan sycdan deleted the patch-1 branch August 2, 2024 22:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants