https://github.com/xt0rted/markdownlint-problem-matcher

A GitHub Action that registers a problem matcher for markdownlint-cli's report format
https://github.com/xt0rted/markdownlint-problem-matcher

annotations github-actions linting markdownlint problem-matcher

Last synced: over 1 year ago
JSON representation

A GitHub Action that registers a problem matcher for markdownlint-cli's report format

• Host: GitHub
• URL: https://github.com/xt0rted/markdownlint-problem-matcher
• Owner: xt0rted
• License: mit
• Created: 2020-02-17T14:17:45.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-30T06:47:16.000Z (almost 2 years ago)
• Last Synced: 2024-10-05T19:04:16.471Z (almost 2 years ago)
• Topics: annotations, github-actions, linting, markdownlint, problem-matcher
• Language: TypeScript
• Homepage:
• Size: 2.85 MB
• Stars: 9
• Watchers: 4
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Problem Matcher for markdownlint-cli

[![CI](https://github.com/xt0rted/markdownlint-problem-matcher/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/xt0rted/markdownlint-problem-matcher/actions/workflows/ci.yml)

[![CodeQL](https://github.com/xt0rted/markdownlint-problem-matcher/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/xt0rted/markdownlint-problem-matcher/actions/workflows/codeql-analysis.yml)

Adds a problem matcher that will detect errors from [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) and create annotations for them.

## Usage

```yml

on: push

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: xt0rted/markdownlint-problem-matcher@v3

      - run: markdownlint **/*.md --ignore node_modules

```

## Options

Name | Allowed values | Description

-- | -- | --

`action` | `add` (default), `remove` | If the problem matcher should be registered or removed

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE)