refactor: Reformat SQL queries for ease of reading #1237
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The database queries in the @query annotations were in a range of different styles which made them difficult to read, and difficult to write new ones in a consistent style. Fix this. Write a new tool, `sqlfmt`. This processes the DAO files looking for `@Query(...)` annotations. It extracts the SQL from those annotations and calls `sqlfluff` (https://github.com/sqlfluff/sqlfluff, which must be installed separately) to lint and fix formatting issues in the SQL. The file is re-written with the newly formatted SQL queries.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The database queries in the @query annotations were in a range of different styles which made them difficult to read, and difficult to write new ones in a consistent style.
Fix this.
Write a new tool,
sqlfmt. This processes the DAO files looking for@Query(...)annotations. It extracts the SQL from those annotations and callssqlfluff(https://github.com/sqlfluff/sqlfluff, which must be installed separately) to lint and fix formatting issues in the SQL.The file is re-written with the newly formatted SQL queries.