-
Notifications
You must be signed in to change notification settings - Fork 41
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
Add support for markdownlint-cli2 #879
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,3 +6,5 @@ node_modules/ | |
|
|
||
| # Typescript | ||
| out/ | ||
|
|
||
| junit.xml | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| import { linterCheckTest } from "tests"; | ||
|
|
||
| linterCheckTest({ linterName: "markdownlint-cli2" }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| version: 0.1 | ||
| tools: | ||
| definitions: | ||
| - name: markdownlint-cli2 | ||
| runtime: node | ||
| package: markdownlint-cli2 | ||
| shims: [markdownlint-cli2] | ||
| known_good_version: 0.14.0 | ||
|
|
||
| lint: | ||
| definitions: | ||
| - name: markdownlint-cli2 | ||
| files: [markdown] | ||
| tools: [markdownlint-cli2] | ||
| description: A style checker and lint tool for markdown files | ||
| commands: | ||
| - name: lint | ||
| # Custom parser type defined in the trunk cli to handle markdownlint's JSON output. | ||
| output: regex | ||
| read_output_from: stderr | ||
| parse_regex: | ||
| "(?P<path>[^:]+):(?P<line>[\\d+]+)(?::(?P<col>[\\d+]+))? (?P<code>[^ ]+) | ||
| (?P<message>.*)\n" | ||
| run: markdownlint-cli2 ${target} --json | ||
| success_codes: [0, 1] | ||
| batch: true | ||
| cache_results: true | ||
| suggest_if: config_present | ||
| direct_configs: | ||
| - .markdownlint-cli2.jsonc | ||
| - .markdownlint-cli2.yaml | ||
| - .markdownlint-cli2.cjs | ||
| - .markdownlint-cli2.mjs | ||
| affects_cache: | ||
| - package.json | ||
| - .markdownlint.jsonc | ||
| - .markdownlint.json | ||
| - .markdownlint.yaml | ||
| - .markdownlint.yml | ||
| - .markdownlint.cjs | ||
| - .markdownlint.mjs | ||
| issue_url_format: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#{} | ||
| known_good_version: 0.14.0 | ||
| version_command: | ||
| parse_regex: ${semver} | ||
| run: markdownlint --version |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "config": { | ||
| "extends": "markdownlint/style/prettier" | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # bad.md | ||
|
|
||
| # This file fails some rules | ||
|
|
||
| Line is OK- Make a realy long line that breaks the layout rules completely. Make a realy long line | ||
| that breaks | ||
| But this should be ignored because of config | ||
|
|
||
|
|
||
| Line is too long (over 120) A B C D E F G A B C D E F G A B C D E F G A B C D E F G A B C D E F G A | ||
| B C D E F G A B C D E F G A B C D E F G |
43 changes: 43 additions & 0 deletions
43
linters/markdownlint-cli2/test_data/markdownlint_cli2_v0.14.0_basic.check.shot
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`Testing linter markdownlint-cli2 test basic 1`] = ` | ||
| { | ||
| "issues": [ | ||
| { | ||
| "code": "MD025/single-title/single-h1", | ||
| "column": "1", | ||
| "file": "test_data/basic.in.md", | ||
| "issueClass": "ISSUE_CLASS_EXISTING", | ||
| "issueUrl": "https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD025/single-title/single-h1", | ||
| "level": "LEVEL_HIGH", | ||
| "line": "3", | ||
| "linter": "markdownlint-cli2", | ||
| "message": "Multiple top-level headings in the same document [Context: "This file fails some rules"]", | ||
| "targetType": "markdown", | ||
| }, | ||
| ], | ||
| "lintActions": [ | ||
| { | ||
| "command": "lint", | ||
| "fileGroupName": "markdown", | ||
| "linter": "markdownlint-cli2", | ||
| "paths": [ | ||
| "test_data/basic.in.md", | ||
| ], | ||
| "verb": "TRUNK_VERB_CHECK", | ||
| }, | ||
| { | ||
| "command": "lint", | ||
| "fileGroupName": "markdown", | ||
| "linter": "markdownlint-cli2", | ||
| "paths": [ | ||
| "test_data/basic.in.md", | ||
| ], | ||
| "upstream": true, | ||
| "verb": "TRUNK_VERB_CHECK", | ||
| }, | ||
| ], | ||
| "taskFailures": [], | ||
| "unformattedFiles": [], | ||
| } | ||
| `; |
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
Oops, something went wrong.
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.
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.
Please add a link for this below the table