-
Notifications
You must be signed in to change notification settings - Fork 32
Add docs-builder format command #2084
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
🔍 Preview links for changed docs |
reakaleek
reviewed
Oct 21, 2025
reakaleek
reviewed
Oct 21, 2025
Mpdreamz
requested changes
Oct 21, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love it! Some small PR notes.
src/authoring/Elastic.Documentation.Refactor/Formatters/IFormatter.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Martijn Laarman <Mpdreamz@gmail.com>
|
Added |
Mpdreamz
approved these changes
Oct 21, 2025
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.
Fixes #2083
Added a new
docs-builder formatcommand to automatically fix formatting issues in documentation files. The command currently handles irregular space characters (no-break spaces, en spaces, zero-width spaces, etc.) by replacing them with regular spaces. The formatter only processes markdown files included in the docset configuration.Note that the command supports a
--dry-runflag to preview changes without modifying files. I also updated the space normalizer linter to emit a single hint per file instead of per occurrence, directing users to rundocs-builder formatto fix all instances automatically.The formatter architecture is extensible by using the
IFormatterinterface, making it straightforward to add additional formatting operations in the future (trailing whitespace, line endings, etc.) without modifying the core service logic.How to test
—
Co-authored by Claude 4.5 using Claude CLI 2.0 inside Cursor