https://github.com/xt0rted/dotnet-format-problem-matcher

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

annotations dotnet dotnet-core dotnet-format github-actions linting problem-matcher

Last synced: about 1 year ago
JSON representation

A GitHub Action that registers a problem matcher for dotnet-format's report output

• Host: GitHub
• URL: https://github.com/xt0rted/dotnet-format-problem-matcher
• Owner: xt0rted
• License: mit
• Created: 2019-08-19T05:57:46.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2025-03-17T19:58:09.000Z (about 1 year ago)
• Last Synced: 2025-03-17T20:40:06.363Z (about 1 year ago)
• Topics: annotations, dotnet, dotnet-core, dotnet-format, github-actions, linting, problem-matcher
• Language: TypeScript
• Homepage:
• Size: 2.01 MB
• Stars: 11
• Watchers: 3
• Forks: 6
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Problem Matcher for dotnet-format

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

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

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

## Usage

```yml

on: push

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - uses: actions/setup-dotnet@v1

          with:

            dotnet-version: 3.1.101

      - uses: xt0rted/dotnet-format-problem-matcher@v1

      - run: dotnet tool install -g dotnet-format

      - run: dotnet-format --dry-run

```

![Example of inline annotations](docs/annotations.png)

![Example of build log with highlighted errors](docs/build-log.png)

## 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)