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
Tool boilerplate reduction #20857
Comments
Isn't this what But yes, I've agreed with this position for a while :) |
I thought |
Good point. (I've not looked much at it, so I have no good sense of its current limitations)
That may perhaps be the current state of it is best suited for..
.. yet. I think we'd like to build upon it to make it suitable for less adhoc use as well. But if it's not feature complete enough for the sqlfluff tool today, let's proceed with the work in #20854 as is for now :) cc @gauthamnair could perhaps fill in more details here.. |
@kaos @grihabor @sureshjoshi I just took a look at the Sql PR. What code_quality_tool could have done (in the form introduced in #20135 ) is:
CodeQualityTool is for when you have a runnable and just want to lint/fmt/fix with it. It is intended for use by users rather than by plugin authors. The sql support added in #20854 would not be improved by it. In fact it is unclear how to provide a plugin through code quality tool. For another look at trying to reduce the boilerplate that plugin authors face, you can also check out what @lilatomic was piloting back in #16412 For a kind of long-form treatise on the matter there is https://docs.google.com/presentation/d/15P0YdoX1T4fX0DpNzwwXxP1bMVZqUZ_GB9Jkn3rQwRQ/edit#slide=id.p |
Thanks for the details @gauthamnair, that all makes sense. |
Is your feature request related to a problem? Please describe.
Adding new tools takes way too much effort.
Describe the solution you'd like
For standard tools (like,
pip install tool-x && tool-x --version
) it should be enough to provide the bare minimum in terms of what requirements it has and goals it supports.Describe alternatives you've considered
EDIT: The
code_quality_tool
may be a good alternative for tools that fit thefix
fmt
lint
bill of goals. (as pointed out by @sureshjoshi)Additional context
For context, adding a SQL tool for linting and formatting requires an unhealthy amount of boilerplate (#20854) (granted, almost 1.3k lines of that is for the lockfile, but there's still plenty of boilerplate):
The text was updated successfully, but these errors were encountered: