prettier-plugin-csharp - GitLite

KO | EN

gitlite — search

#python #typescript #llm #go #android #nodejs #macos #awesome #cli #kubernetes #awesome-list #ios #openai #open-source

prettier-plugin-csharp

(★ 252)

Prettier C# Plugin

File Explorer

Download Latest Version (.zip)

- launch.json
- settings.json
- index.js
- - CSharpLexer.g4
  - CSharpParser.g4
  - CSharpPreprocessorParser.g4
  - README.md
- debug.js
- index.js
- parser.js
- printer.js
- AllInOne.cs
- AllInOne.Formatted.cs
- index.js
.eslintrc.json
.gitattributes
.gitignore
.npmignore
.travis.yml
LICENSE
package.json
README.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/warrenseine/prettier-plugin-csharp

Downloads the entire project code from GitHub to your computer.

cd prettier-plugin-csharp

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

yarn add --dev --exact prettier prettier-plugin-csharp

Type this command into your terminal and run it.

yarn

Downloads and installs the libraries listed in package.json.

yarn fetch-antlr

Type this command into your terminal and run it.

yarn generate-parser

Type this command into your terminal and run it.

yarn test

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
    ❌ This repository is unmaintained and the project is incomplete, don't expect anything else than a toy C# project to reformat correctly! ❌
</p>
<p align="center">
    Have a look at <a href="https://github.com/belav/csharpier">CSharpier</a> instead.
</p>
<hr>

<div align="center">
<img alt="Prettier"
  src="https://cdn.rawgit.com/prettier/prettier-logo/master/images/prettier-icon-light.svg">
<img alt="C#"
  hspace="25"
  height="210"
  src="https://upload.wikimedia.org/wikipedia/commons/4/4f/Csharp_Logo.png">
</div>

<h2 align="center">Prettier C# Plugin</h2>

<p align="center">
  <a href="https://gitter.im/jlongster/prettier">
    <img alt="Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
  </a>
  <a href="https://travis-ci.org/warrenseine/prettier-plugin-csharp">
    <img alt="Travis" src="https://img.shields.io/travis/warrenseine/prettier-plugin-csharp/master.svg?style=flat-square">
  </a>
  <a href="https://www.npmjs.com/package/prettier-plugin-csharp">
    <img alt="npm version" src="https://img.shields.io/npm/v/prettier-plugin-csharp.svg?style=flat-square">
  </a>
  <a href="#badge">
    <img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square">
  </a>
  <a href="https://twitter.com/PrettierCode">
    <img alt="Follow+Prettier+on+Twitter" src="https://img.shields.io/twitter/follow/prettiercode.svg?label=follow+prettier&style=flat-square">
  </a>
</p>

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

## Unmaintained

This repository is unmaintained and the project is incomplete, don't expect anything else than a toy C# project to reformat correctly! **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-plugin-csharp
```

## Use

```bash
prettier --write "**/*.cs"
```

## How it works

The plugin is written in JavaScript. It depends on the JavaScript port of ANTLR and relies on a fork of an [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

### Installing dependencies

Use your favorite Node package manager:

```bash
yarn
```

### Updating the grammar

The grammar supports C# 6 as a baseline, and tries to catch up with recent additions. Contributions are welcome. To update the grammar:

- Update `src/csharp/*.g4` files.
- Ensure you have Java 8+ installed on your machine.
- Fetch a local copy of ANTLR:

```bash
yarn fetch-antlr
```

- Generate the JavaScript parser:

```bash
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`.
- Run `yarn prettier Your/File.cs` to check the output.

## Maintainers

<table>
  <tbody>
    <tr>
      <td align="center">
        <a href="https://github.com/warrenseine">
          <img width="150" height="150" src="https://github.com/warrenseine.png?v=3&s=150">
          </br>
          Warren Seine
        </a>
      </td>
    </tr>
  <tbody>
</table>