feat: markdown output #94
Open
Conversation
This file contains 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
Add a Markdown output format. This is useful for displaying in GitHub comments, for example. The output has the following format: # supa-mdx-lint results ## test.md ``` 1 | # Hello World 2 | ``` This is an error ### Recommendations 1. Replace the text from row 1, column 9 to row 1, column 14 with Friend 2. Replace the text from row 1, column 9 to row 1, column 14 with Neighbor 3. Insert the following text at row 1, column 14: and Universe
Output format is an enum, which is not particularly useful, since we want it to be extendable by users of the library (when we clean up the API). Make it a trait instead.
Markdown output format should also output the lint summary: ``` ## Summary - 🤖 1 file linted - 🚨 1 errors - 🔔 0 warnings ``` Refactor the summary calculation out of the output::pretty module to support this.
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.
Add a Markdown output format. This is useful for displaying in GitHub comments, for example.
The output has the following format: