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

improve fix messages #276

Open
a-frantz opened this issue Dec 20, 2024 · 2 comments
Open

improve fix messages #276

a-frantz opened this issue Dec 20, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@a-frantz
Copy link
Member

This issue is the successor of #193

#260 ensured that every lint diagnostic includes a fix message, however some of them are still lacking. We should take another pass and include "corrected" code snippets wherever possible.

#264 (adds ShellCheck) uses the same fix message for every diagnostic. SC does provide its own "fix" for some diagnostics (but not all). It would be great if we could "translate" the SC fixes into our own fix messages.

@a-frantz a-frantz added the enhancement New feature or request label Dec 20, 2024
@thatRichman
Copy link
Contributor

I'd be happy to take a stab at this one, in the interest of finishing what I started in #264.

@a-frantz
Copy link
Member Author

a-frantz commented Jan 3, 2025

Sure, go right ahead! If you want to just focus on the ShellCheck fix messages, that would be fine. But we would certainly appreciate a more thorough PR that improves the other lint rule messages as well! Your call :)

I think the goal is to supply "corrected" code whenever possible. That is more straightforward for some rules than others, so the scope of this PR can be up to you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants