sqlx-inline-fmt 0.3.0

Format inline sqlx query strings in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# sqlx-inline-fmt

`sqlx-inline-fmt` finds inline `sqlx::query*!` macros in Rust source files,
runs each SQL string through an external formatter, and rewrites the literals
in place.

## Installation

Clone the repository and install the tool with Cargo:

```bash
cargo install --path .
```

## Usage

```
sqlx-inline-fmt [OPTIONS] --formatter "<COMMAND>" [INPUTS]...
```

* **INPUTS**: Files or directories to scan. If omitted, the tool scans `./src` and `./tests`.
* **--formatter "\<COMMAND\>" (required)**: The external SQL formatter to run.
  * The command is parsed like a shell string.
  * `sqlx-inline-fmt` will append `-` as the final argument and send the SQL on
    stdin. The formatted SQL should be written to stdout.
* **--check**: Don’t write changes; just report which files would change. Exits
  with code 1 if any file would change (useful for CI).
* **-v, --verbose**: Include `ok` entries in per-file status output.
* **-q, --quiet**: Suppress per-file status lines; only print warnings/errors.

### Examples

```bash
sqlx-inline-fmt --formatter pg_format path/to/file.rs path/to/dir
sqlx-inline-fmt --formatter "sqlfluff fix --dialect postgres"
```