Skip to content
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

Log.txt file automatic creation in PWD is kind of an anti-feature #165

Open
xkortex opened this issue May 3, 2024 · 3 comments
Open

Log.txt file automatic creation in PWD is kind of an anti-feature #165

xkortex opened this issue May 3, 2024 · 3 comments

Comments

@xkortex
Copy link

xkortex commented May 3, 2024

Hi, great tool, but I have a bit of a UX nitpick. By default, every time you run bump-pydantic it generates log.txt in the current directory. This is usually at the project root of a repo and I really don't care about the log file 99% of the time, and I have to remember not to accidentally git commit it. I would add a rule but for a basically one-off process it seems unnecessary.

I think it would be a better experience if it did one of the following:

  • Don't generate a log file unless --log-file option is requested
  • Generate a log file in an inconsequential dir by default (e.g. /tmp/bump-pydantic/log.txt)
  • Accept --no-log-file to suppress the generation of the log file. (I suppose I can --log-file=/dev/null but I have to remember that each time)
@Kludex
Copy link
Member

Kludex commented May 4, 2024

Second option is good 👍

PR welcome 🙏

@xkortex
Copy link
Author

xkortex commented May 6, 2024

Also, is the log file supposed to output things? I just ran the tool and updated my code (44 lines changed) and there was nothing in the log file.

edit: looking into it, seems like it only outputs when an error occurs.

@Kludex
Copy link
Member

Kludex commented Jul 25, 2024

@xkortex Are you still interested in helping here?

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

No branches or pull requests

2 participants