https://github.com/maxisam/dotnet-format-plus

Yet another dotnet format. It combines dotnet format with jscpd to provide a single action to run both.
https://github.com/maxisam/dotnet-format-plus

dotnet-format github-actions jscpd

Last synced: about 1 month ago
JSON representation

Yet another dotnet format. It combines dotnet format with jscpd to provide a single action to run both.

• Host: GitHub
• URL: https://github.com/maxisam/dotnet-format-plus
• Owner: maxisam
• License: mit
• Created: 2023-09-16T15:00:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-07T22:42:39.000Z (over 1 year ago)
• Last Synced: 2025-02-07T23:25:52.373Z (over 1 year ago)
• Topics: dotnet-format, github-actions, jscpd
• Language: TypeScript
• Homepage:
• Size: 10.7 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# dotnet format plus

Yet another dotnet format. It combines dotnet format with jscpd to provide a single action to run both. The main goal is to provide a way to handle dotnet format in a mono repo. You can have an action before this and create a matrix of projects to run this action on. And each project can have its own dotnet format config file.

## Features

-   Dotnet format

-   Mono repo support by using `.dotnet-format.json (yml)` config file to configure dotnet format

-   Problem Matcher for dotnet format (only works when verbosity is set to detailed)

-   JSCPD, can be configured with `.jscpd.json (yml)` file

-   Generate reports as GitHub Action artifact

-   Generate reports as comment on PR

-   Generate reports as workflow summary

-   (optional) commit changes

-   (optional) update existing PR comment

## Demo

-   generate report as comment

    

-   Workflow summary

    

-   Annotation

    

## Usage

Currently this action is focused on running on PRs.

example:

-   [example workflow](.github/workflows/test-dotnet-format.yml)

-   [example dotnet-format config](./__tests__/dotnet/ConfigConsoleApp/.dotnet-format.json)

-   [example jscpd config](./__tests__/dotnet/ConfigConsoleApp/.jscpd.json)

-   [Action input](./action.yml)

## Aknowledgements

This project is based on / inspired by lots of other projects, including but not limited to:

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

-   https://github.com/jfversluis/dotnet-format

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

-   https://github.com/kucherenko/jscpd

-   https://github.com/getunlatch/jscpd-github-action

-   https://github.com/bibipkins/dotnet-test-reporter