PostSharp Engineering: Code Style Features

Make sure you have read and understood PostSharp Engineering before reading this doc.

Table of contents

• PostSharp Engineering: Code Style Features
  • Table of contents
  • Introduction
  • Installation
  • Configuration
  • Code style cleanup

Introduction

This repository contains centralized code-style configurations and scripts.

Unified base code-style is found under Standard directory.

Other projects using slightly altered code-style configuration are in their own directories, respective to the name of the project.

Installation

1. Copy the PostSharp.Engineering.CodeStyle repo to your own repo into eng/style using PostSharp.Engineering.BuildTools, with the command:

   .\Build.ps1 codestyle pull
   

   This tool will create a symlink for .editorconfig.

2. Enable symlinks for your repo (edit .git/config).

3. For each solution, in Rider, open Settings, choose "Manage Layers", select the team-shared layer, click on the + icon and then on "Open Settings File", then choose eng/style/CommonStyle.DotSettings. This step is required for code formatting using Build.ps1 codestyle format, even if you are otherwise not using Rider.

Configuration

The code quality configuration is configured in the following files:

• .editorconfig
• CommonStyle.DotSettings (used by JetBrains tools)
• stylecop.json

Code style cleanup

1. Commit all your changes. You cannot reformat a repo with uncommitted changes.
2. Do .\Build.ps1 codestyle format from the repo root (see PostSharp.Engineering).