feat: zk fmt sqlx-queries #533
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
montekki
reviewed
Nov 22, 2023
slowli
reviewed
Nov 22, 2023
slowli
reviewed
Nov 23, 2023
tomg10
force-pushed
the
sql-formatter
branch
from
0f8aa7c
to
b376916
Compare
slowli
previously approved these changes
Nov 29, 2023
There was a problem hiding this comment.
LGTM, but I'd love other opinions as to whether this formatting makes sense. As some potential alternatives (given that we have a tool to unify SQL queries):
- We could use raw literal strings without indentation. IMO, they look ugly.
- We could use raw literal strings with indentation. Doesn't satisfy the "query is not recompiled regardless of surrounding formatting" criterion.
- We could extract queries into files (i.e., use
query_fileetc.). IMO, extracting queries makes it more difficult to keep the query context when reviewing code.
FWIW, I've tried updating sqlx to the latest version (0.7), and it still doesn't transform whitespace in query literals; so, we wouldn't avoid the formatting problem by updating.
4 tasks
|
@slowli I will add this formatting to agenda to our next weekly platform team meeting |
tomg10
force-pushed
the
sql-formatter
branch
from
b376916
to
6a71860
Compare
slowli
approved these changes
Dec 18, 2023
RomanBrodetski
pushed a commit
that referenced
this pull request
Dec 19, 2023
🤖 I have created a release *beep* *boop* --- ## [18.9.0](core-v18.8.0...core-v18.9.0) (2023-12-19) ### Features * Add ecadd and ecmul to the list of precompiles upon genesis ([#669](#669)) ([0be35b8](0be35b8)) * **api:** Do not return receipt if tx was not included to the batch ([#706](#706)) ([625d632](625d632)) * proto serialization/deserialization of snapshots creator objects ([#667](#667)) ([9f096a4](9f096a4)) * zk fmt sqlx-queries ([#533](#533)) ([6982343](6982343)) ### Bug Fixes * **en:** Downgrade miniblock hash equality assertion to warning ([#695](#695)) ([2ef3ec8](2ef3ec8)) ### Performance Improvements * remove unnecessary to_vec ([#702](#702)) ([c55a658](c55a658)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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.
What ❔
Added option to format queries using
zk fmt sqlx-queriesIt uses https://github.com/sql-formatter-org/sql-formatter as a formatter
Checklist
zk fmtandzk lint.