diff options
| author | Bronson Jordan <80419011+bpjordan@users.noreply.github.com> | 2024-01-15 21:48:26 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-15 19:48:26 -0800 |
| commit | e0276bb32e9b33ece11fef2a5cfc8fb2108df0df (patch) | |
| tree | a8b9bb0a2c16ab85f2ce74c198de3b6965424451 /doc/conform.txt | |
| parent | 75e7c5c7eb5fbd53f8b12dc420b31ec70770b231 (diff) | |
feat: Add dry_run option and report if buffer was/would be changed by formatters (#273)
* feat: add dry_run option and pass return values for if buffer would be modified
* fix: implement dry_run for blocking calls to lsp formatter
* refactor: change `changed` variable to `did_edit`
* docs: Update README
* fix: address PR comments
* fix: small cleanups
---------
Co-authored-by: Steven Arcangeli <stevearc@stevearc.com>
Diffstat (limited to 'doc/conform.txt')
| -rw-r--r-- | doc/conform.txt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/conform.txt b/doc/conform.txt index ad2c736..ed1241f 100644 --- a/doc/conform.txt +++ b/doc/conform.txt @@ -120,6 +120,8 @@ format({opts}, {callback}): boolean *conform.forma {async} `nil|boolean` If true the method won't block. Defaults to false. If the buffer is modified before the formatter completes, the formatting will be discarded. + {dry_run} `nil|boolean` If true don't apply formatting changes to + the buffer {formatters} `nil|string[]` List of formatters to run. Defaults to all formatters for the buffer filetype. {lsp_fallback} `nil|boolean|"always"` Attempt LSP formatting if no @@ -137,7 +139,8 @@ format({opts}, {callback}): boolean *conform.forma lsp_fallback = true {filter} `nil|fun(client: table): boolean` Passed to |vim.lsp.buf.format| when lsp_fallback = true - {callback} `nil|fun(err: nil|string)` Called once formatting has completed + {callback} `nil|fun(err: nil|string, did_edit: nil|boolean)` Called once + formatting has completed Returns: `boolean` True if any formatters were attempted |