## Intro
Prettier C# adds C# support to the [Prettier](https://github.com/prettier/prettier) code formatter. Like Prettier,
it is opinionated and restricts style options to a minimum. It runs where Prettier runs, including CI and pre-commit
hooks.
## WORK IN PROGRESS
Please note that this plugin is under active development, and might not be ready to run on production code yet. **It will break your code.**
Preview the result with this [diff example](https://github.com/warrenseine/prettier-csharp-demo/pull/1/commits/8652271a499740b726e6342346e97447abd23162).
## Install
```bash
yarn add --dev --exact prettier prettier-csharp
```
## Use
```bash
prettier --plugin=prettier-csharp --parser=cs --write "**/*.cs"
```
## How it works
The plugin is written in JavaScript. It depends on the JavaScript port of ANTLR and an
[unmodified unofficial C# 6 grammar from ANTLR](https://github.com/antlr/grammars-v4/tree/master/csharp).
The grammar is precompiled to plain JavaScript and ready to use in the project.
## Contributing
### Updating the grammar
- Copy the latest version of the [grammar](https://github.com/antlr/grammars-v4/tree/master/csharp) to `asset/csharp`
- Install ANTLR:
```bash
brew install antlr4 # on macOS
```
- Generate the JavaScript parser:
```bash
yarn install
yarn generate-parser
```
### Testing
The project is developed against a single grammar-complete regression test. There are no unit tests for the moment.
Run the test with:
```bash
yarn test
```
To test it out on an actual C# file:
- Clone this repository.
- Run `yarn`.
- Create a file called `test.cs`.
- Run `yarn prettier test.cs` to check the output.
## Maintainers
Warren Seine