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

xkortex commented 4 months ago

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 commented 4 months ago

Second option is good 👍

PR welcome 🙏

xkortex commented 4 months ago

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 commented 1 month ago

@xkortex Are you still interested in helping here?

pydantic / bump-pydantic

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