feat: add format subcommand for CLI formatting#127
Merged
barrettruth merged 1 commit intomainfrom Mar 25, 2026
Merged
Conversation
Problem: the formatter is only available via LSP `textDocument/formatting`, which requires a running editor. Users cannot format vimdoc files from the CLI for CI pipelines, pre-commit hooks, or batch operations. Solution: add a `format` subcommand that formats files in-place, with a `--check` flag that exits 1 if any file would change (for CI). Directories are globbed for `*.txt` files. Global `--line-width`, `--reflow`, and `--normalize-spacing` flags apply. Document both `format` and `check` subcommands in the README.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The formatter is only accessible via LSP
textDocument/formatting, requiring a running editor. There's no way to format vimdoc files from the CLI for CI pipelines, pre-commit hooks, or batch operations.Solution
Add a
formatsubcommand mirroring the existingcheckpattern.vimdoc-language-server format doc/formats files in-place;--checkexits 1 if any file would change (for CI). Directories are globbed for*.txtfiles. Global--line-width,--reflow, and--normalize-spacingflags apply. Bothformatandcheckare now documented in the README under a new CLI section.