https://github.com/dotnet/codeformatter

Tool that uses Roslyn to automatically rewrite the source to follow our coding styles
https://github.com/dotnet/codeformatter

Last synced: 4 months ago
JSON representation

Tool that uses Roslyn to automatically rewrite the source to follow our coding styles

• Host: GitHub
• URL: https://github.com/dotnet/codeformatter
• Owner: dotnet
• License: mit
• Archived: true
• Created: 2015-01-07T03:28:44.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2022-07-11T17:29:55.000Z (over 2 years ago)
• Last Synced: 2024-09-23T16:32:40.218Z (4 months ago)
• Language: C#
• Homepage:
• Size: 944 KB
• Stars: 1,236
• Watchers: 232
• Forks: 244
• Open Issues: 93
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE-OF-CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-dotnet-core - CodeFormatter - Tool that uses Roslyn to automatically rewrite the source to follow netfx coding styles. [Nuget Package](https://www.nuget.org/packages/Dotnet.CodeFormatter.BuildTask.Fork) (Frameworks, Libraries and Tools / Code Analysis and Metrics)
• fucking-awesome-dotnet-core - CodeFormatter - Tool that uses Roslyn to automatically rewrite the source to follow netfx coding styles. 🌎 [Nuget Package](www.nuget.org/packages/Dotnet.CodeFormatter.BuildTask.Fork) (Frameworks, Libraries and Tools / Code Analysis and Metrics)
• awesome-dotnet-core - CodeFormatter - Tool that uses Roslyn to automatically rewrite the source to follow netfx coding styles. [Nuget Package](https://www.nuget.org/packages/Dotnet.CodeFormatter.BuildTask.Fork) (Frameworks, Libraries and Tools / Code Analysis and Metrics)
• awesome-dotnet-core - CodeFormatter - CodeFormatter是使用Roslyn来自动重写我们的代码格式。 (框架, 库和工具 / 代码分析和指标)

README

        
# CodeFormatter

***NOTE: This repo is archived. The replacement is [dotnet/format](https://github.com/dotnet/format).***

CodeFormatter is a tool that uses Roslyn to automatically rewrite the source to

follow our coding styles, which are [documented here][corefx-coding-style].

[corefx-coding-style]: https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md

## Prerequisites

In order to build or run this tool you will need to have Microsoft Build Tools

2015 installed.  This comes as a part of [Visual Studio 2015](https://www.visualstudio.com/downloads/download-visual-studio-vs).

## Installation

Download binaries from [GitHub Releases](https://github.com/dotnet/codeformatter/releases)

## Usage

In order get the usage, simply invoke the tool with no arguments:

```

$ .\CodeFormatter.exe

CodeFormatter  [] [/file:] [/nocopyright] [/c: [/copyright:file]

     - Rule types to use in addition to the default ones.

                   Use ConvertTests to convert MSTest tests to xUnit.

       - Only apply changes to files with specified name.

        - Additional preprocessor configurations the formatter

                   should run under.

      - Specifies file containing copyright header.

```

## Contributing

We follow the same contribution process that 

[corefx is using][corefx-contributing].

[corefx-contributing]: https://github.com/dotnet/corefx/wiki/Contributing