Repository navigation
fix(convert): preserve unlabelled TLDR code blocks - #84
Merged
Merged
Conversation
Gubarz
marked this pull request as ready for review
September 30, 2026 14:47
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
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.
Summary
cheatmd convert tldrreplaces a command in an unlabelled fenced block with a single backtick. The inline-command check consumes the opening fence before the fenced-block check can read its body.Check for fenced blocks first. Add an exact-output regression test for a multiline command followed by another example.
Related issues
No linked issue.
Verification
The regression fails before the fix and passes afterward. Built CLI conversion followed by
dump --jsonpreserves bare, multiline, language-tagged and inline commands, including a following example.The optional real-world TLDR fixture sweep skips because this checkout lacks
pkg/convert/testdata/tldr. The new regression uses an inline fixture and runs.Local checks passed on Go 1.27.1. The CI workflow uses Go 1.26.3.
Checklist
go build ./...andgo test ./...passgofmt -l .andgo vet ./...are cleancheatmd --lint examples/passes