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

[wishlist] action: Apply and provide git-diff #1046

Open
chrysn opened this issue Jun 26, 2024 · 2 comments
Open

[wishlist] action: Apply and provide git-diff #1046

chrysn opened this issue Jun 26, 2024 · 2 comments

Comments

@chrysn
Copy link

chrysn commented Jun 26, 2024

When typos is used as the GitHub action, changes are shown but not easy to apply, requiring the tedious process of opening the files, changing the text and not missing one suggestion (guess who missed one again).

While there is the write_changes option, that requires extra steps to set up (not only once but at runtime – creating another PR in the process or whatnot), and moreover, the one linked action that'd do that has been archive.

Please consider adding an option patch that

  • runs typos in write-mode
  • shows the output of git diff

A developer applying changes from CI often has a terminal open anyway, so seeing that the typos linter triggered and fixing it would be as easy as typing git am and copy-pasting from the action output.

CC'ing @ROMemories who was so kind as to introduce me to this tool ;-)

@epage
Copy link
Collaborator

epage commented Jun 26, 2024

As a user, I am not a patch heavy person and would find this bloating the output with noisy text.

As a maintainer, I am not a patch heavy person and have the impression there are multiple, slightly incompatible patch formats (git diff vs diff) and wouldn't be thrilled with having to deal with those.

I say this not to say "no" but in looking for more input (and not just from you but anyone) on this.

@chrysn
Copy link
Author

chrysn commented Jun 26, 2024 via email

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