Move dotnet/format to dotnet/sdk

.vsts-ci.yml

@@ -173,6 +173,7 @@ stages:
               _Test: -test
 
   - template: /eng/template-engine.yml
+  - template: /eng/dotnet-format/dotnet-format-integration.yml
 
   - ${{ if and(ne(variables['System.TeamProject'], 'public'), notin(variables['Build.Reason'], 'PullRequest')) }}:
     - template: /eng/common/templates/job/publish-build-assets.yml

CODEOWNERS

@@ -92,3 +92,7 @@
 /test/containerize.UnitTests @dotnet/sdk-container-builds-maintainers
 /test/Microsoft.NET.Build.Containers.IntegrationTests @dotnet/sdk-container-builds-maintainers
 /test/Microsoft.NET.Build.Containers.UnitTests @dotnet/sdk-container-builds-maintainers
+
+# dotnet-format
+/src/BuiltInTools/dotnet-format @dotnet/roslyn-ide
+/test/dotnet-format.Tests @dotnet/roslyn-ide

Directory.Packages.props

@@ -1,27 +1,36 @@
 <Project>
   <Import Project="$(RepositoryEngineeringDir)\dependabot\Packages.props" Condition="'$(RepositoryEngineeringDir)' != ''"/>
+  <PropertyGroup>
+    <!-- Using multiple feeds isn't supported by Maestro: https://github.com/dotnet/arcade/issues/14155. -->
+    <NoWarn>$(NoWarn);NU1507</NoWarn>
+  </PropertyGroup>
 
   <ItemGroup>
-    <PackageVersion Include="dotnet-format" Version="$(DotnetFormatVersion)" />
     <PackageVersion Include="FluentAssertions" Version="$(FluentAssertionsVersion)" />
     <PackageVersion Include="FluentAssertions.Json" Version="$(FluentAssertionsJsonVersion)" />
     <PackageVersion Include="Microsoft.ApplicationInsights" Version="$(MicrosoftApplicationInsightsPackageVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.DeveloperCertificates.XPlat" Version="$(MicrosoftAspNetCoreDeveloperCertificatesXPlatPackageVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.Mvc.Razor.Extensions.Tooling.Internal" Version="$(MicrosoftAspNetCoreMvcRazorExtensionsToolingInternalPackageVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="$(MicrosoftAspNetCoreTestHostPackageVersion)" />
     <PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="$(MicrosoftNETCoreAppRefPackageVersion)"/>
-    <PackageVersion Include="Microsoft.Build.Locator" Version="$(MicrosoftBuildLocatorPackageVersion)" />
     <PackageVersion Include="Microsoft.Build.NuGetSdkResolver" Version="$(MicrosoftBuildNuGetSdkResolverPackageVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis" Version="$(MicrosoftCodeAnalysisPackageVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.Analyzer.Testing" Version="$(MicrosoftCodeAnalysisAnalyzerTestingVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="$(MicrosoftCodeAnalysisCSharpPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.CodeStyle" Version="$(MicrosoftNetCompilersToolsetPackageVersion)" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Features" Version="$(MicrosoftCodeAnalysisCSharpFeaturesPackageVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Features" Version="$(MicrosoftCodeAnalysisCSharpPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="$(MicrosoftCodeAnalysisCSharpWorkspacesPackageVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.Features" Version="$(MicrosoftCodeAnalysisPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="$(MicrosoftCodeAnalysisNetAnalyzersVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="$(MicrosoftCodeAnalysisPublicApiAnalyzersVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Razor.Tooling.Internal" Version="$(MicrosoftCodeAnalysisRazorToolingInternalVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic" Version="$(MicrosoftCodeAnalysisPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.CodeStyle" Version="$(MicrosoftNetCompilersToolsetPackageVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Features" Version="$(MicrosoftCodeAnalysisPackageVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Workspaces" Version="$(MicrosoftCodeAnalysisPackageVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="$(MicrosoftCodeAnalysisWorkspacesMSBuildPackageVersion)" />
     <PackageVersion Include="Microsoft.Css.Parser" Version="$(MicrosoftCssParserVersion)" />
+    <PackageVersion Include="Microsoft.DiaSymReader" Version="$(MicrosoftDiaSymReaderVersion)" />
     <PackageVersion Include="Microsoft.Deployment.DotNet.Releases" Version="$(MicrosoftDeploymentDotNetReleasesVersion)" />
     <PackageVersion Include="Microsoft.DotNet.Installer.Windows.Security.TestData" Version="$(MicrosoftDotNetInstallerWindowsSecurityTestDataPackageVersion)" />
     <PackageVersion Include="Microsoft.DotNet.XUnitExtensions" Version="$(MicrosoftDotNetXUnitExtensionsVersion)" />
@@ -45,6 +54,8 @@
     <PackageVersion Include="Microsoft.TemplateSearch.Common" Version="$(MicrosoftTemplateSearchCommonPackageVersion)" />
     <PackageVersion Include="Microsoft.TestPlatform.Build" Version="$(MicrosoftTestPlatformBuildPackageVersion)" />
     <PackageVersion Include="Microsoft.TestPlatform.CLI" Version="$(MicrosoftTestPlatformCLIPackageVersion)" />
+    <PackageVersion Include="Microsoft.VisualBasic" Version="$(MicrosoftVisualBasicVersion)" />
+    <PackageVersion Include="Microsoft.VisualStudio.Composition" Version="17.4.16" />
     <PackageVersion Include="Microsoft.VisualStudio.Setup.Configuration.Interop" Version="$(MicrosoftVisualStudioSetupConfigurationInteropVersion)" />
     <PackageVersion Include="Microsoft.Web.Deployment" Version="$(WebDeploymentPackageVersion)" />
     <PackageVersion Include="Microsoft.Web.Xdt" Version="$(MicrosoftWebXdtPackageVersion)" />
@@ -74,6 +85,7 @@
     <PackageVersion Include="System.CodeDom" Version="$(SystemCodeDomPackageVersion)" />
     <PackageVersion Include="System.Collections.Specialized" Version="$(SystemCollectionsSpecializedPackageVersion)" />
     <PackageVersion Include="System.CommandLine" Version="$(SystemCommandLineVersion)" />
+    <PackageVersion Include="System.CommandLine.Rendering" Version="$(SystemCommandLineRenderingVersion)" />
     <PackageVersion Include="System.ComponentModel.TypeConverter" Version="4.3.0" />
     <PackageVersion Include="System.Composition.AttributedModel" Version="$(MicrosoftNETCoreAppRefPackageVersion)"/>
     <PackageVersion Include="System.Composition.Convention" Version="$(MicrosoftNETCoreAppRefPackageVersion)"/>
@@ -111,6 +123,7 @@
     <PackageVersion Include="Microsoft.Build.Framework" Version="$(MicrosoftBuildVersion)" />
     <!-- Localization is the same between source-only and regular modes. Always taken from latest. Duplicated between the itemgroups for clarity. -->
     <PackageVersion Include="Microsoft.Build.Localization" Version="$(MicrosoftBuildLocalizationVersion)" />
+    <PackageVersion Include="Microsoft.Build.Locator" Version="$(MicrosoftBuildLocatorPackageVersion)" />
     <PackageVersion Include="Microsoft.Build.Runtime" Version="$(MicrosoftBuildVersion)" />
     <PackageVersion Include="Microsoft.Build.Tasks.Core" Version="$(MicrosoftBuildVersion)" />
     <PackageVersion Include="Microsoft.Build.Utilities.Core" Version="$(MicrosoftBuildVersion)" />
@@ -121,6 +134,7 @@
     <PackageVersion Include="Microsoft.Build.Framework" Version="$(MicrosoftBuildMinimumVersion)" />
     <!-- Localization is the same between source-only and regular modes. Always taken from latest. Duplicated between the itemgroups for clarity. -->
     <PackageVersion Include="Microsoft.Build.Localization" Version="$(MicrosoftBuildLocalizationVersion)" />
+    <PackageVersion Include="Microsoft.Build.Locator" Version="$(MicrosoftBuildLocatorPackageVersion)" />
     <PackageVersion Include="Microsoft.Build.Runtime" Version="$(MicrosoftBuildMinimumVersion)" />
     <PackageVersion Include="Microsoft.Build.Tasks.Core" Version="$(MicrosoftBuildMinimumVersion)" />
     <PackageVersion Include="Microsoft.Build.Utilities.Core" Version="$(MicrosoftBuildMinimumVersion)" />

THIRD-PARTY-NOTICES.TXT

@@ -0,0 +1,11 @@
+.NET Core uses third-party libraries or other resources that may be
+distributed under licenses different than the .NET Core software.
+
+In the event that we accidentally failed to list a required notice, please
+bring it to our attention. Post an issue or email us:
+
+           [email protected]
+
+The attached notices are provided for information only.
+
+No notices are provided at this time.

build.cmd

@@ -1,3 +1,3 @@
 @echo off
-powershell -NoLogo -NoProfile -ExecutionPolicy ByPass -Command "& """%~dp0eng\common\build.ps1""" -build -restore %*"
+powershell -NoLogo -ExecutionPolicy ByPass -NoProfile -command "& """%~dp0eng\common\build.ps1""" -restore -build -msbuildEngine dotnet %*"
 exit /b %ErrorLevel%

documentation/format/docs/3rd-party-analyzers.md

@@ -0,0 +1,39 @@
+# 3rd Party Analyzers
+
+## How to add analyzers to a project
+
+3rd party analyzers are discovered from the `<PackageReferences>` specified in the workspace project files.
+
+*Example:*
+
+Add the StyleCop analyzer package to a simple console project file.
+
+```diff
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
++ <ItemGroup>
++    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
++  </ItemGroup>
+
+</Project>
+```
+
+## How to configure analyzer severity
+
+The options specified in .editorconfig files are recognized by the pattern `dotnet_diagnostic.<diagnostic-id>.severity = <value>`. `<diagnostic-id>` represents the diagnostic ID matched by the compiler, case-insensitively, to be configured. `<value>` must be one of the following: error, warn, info, hidden, suppress. Please read the [Code Analysis documentation](https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-options#severity-level) for more details.
+
+*Example:*
+
+Configure the StyleCop analyzer so that empty comments are errors.
+
+```ini
+[*.{cs,vb}]
+
+# The C# comment does not contain any comment text.
+dotnet_diagnostic.SA1120.severity = error
+```

documentation/format/docs/README.md

@@ -0,0 +1,125 @@
+# Welcome to the dotnet-format docs!
+
+## .editorconfig options
+- [Supported .editorconfig options](./Supported-.editorconfig-options.md)
+
+## CLI options
+
+### Specify a workspace (Required)
+
+A workspace path is needed when running dotnet-format. By default, the current folder will be used as the workspace path. The workspace path and type of workspace determines which code files are considered for formatting.
+
+- Solutions and Projects - By default dotnet-format will open the workspace path as a MSBuild solution or project.
+- `--no-restore` - When formatting a solution or project the no restore option will stop dotnet-format from performing an implicit package restore.
+- `--folder` - When the folder options is specified the workspace path will be treated as a folder of code files.
+
+*Example:*
+
+Format the code files used in the format solution.
+
+```console
+dotnet format ./format.sln
+```
+
+Format the code files used in the dotnet-format project.
+
+```console
+dotnet format ./src/dotnet-format.csproj
+```
+
+Format the code files from the  `./src` folder.
+
+```console
+dotnet format whitespace ./src --folder
+```
+
+### Whitespace formatting
+
+Whitespace formatting includes the core .editorconfig settings along with the placement of spaces and newlines. The whitespace formatter is run by default when not running analysis. When only performing whitespace formatting, an implicit restore is not perfomed. When you want to run analysis and fix formatting issues you must specify both.
+
+Whitespace formatting run by default along with code-style and 3rd party analysis.
+
+```console
+dotnet format ./format.sln
+```
+
+Running the whitespace formatter alone.
+
+```console
+dotnet format whitespace ./format.sln
+```
+
+### Running analysis
+
+#### CodeStyle analysis
+
+Running codestyle analysis requires the use of a MSBuild solution or project file as the workspace. By default an implicit restore on the solution or project is performed. Enforces the .NET [Language conventions](https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-language-conventions?view=vs-2019) and [Naming conventions](https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-naming-conventions?view=vs-2019).
+
+- `dotnet format style --severity <severity>` - Runs analysis and attempts to fix issues with severity equal or greater than specified. If severity is not specified then severity defaults to warning.
+
+*Example:*
+
+Code-style analysis is run by default along with whitespace formatting and 3rd party analysis.
+
+```console
+dotnet format ./format.sln
+```
+
+Run code-style analysis alone against the dotnet-format project.
+
+```console
+dotnet format style ./src/dotnet-format.csproj --severity error
+```
+
+Errors when used with the `--folder` option. Analysis requires a MSBuild solution or project.
+
+```console
+dotnet format style ./src --folder
+```
+
+#### 3rd party analysis
+
+Running 3rd party analysis requires the use of a MSBuild solution or project file as the workspace. By default an implicit restore on the solution or project is performed. 3rd party analyzers are discovered from the `<PackageReferences>` specified in the workspace project files.
+
+- `dotnet format analyzers --severity <severity>` - Runs analysis and attempts to fix issues with severity equal or greater than specified. If no severity is specified then this defaults to warning.
+
+#### Filter diagnostics to fix
+
+Typically when running codestyle or 3rd party analysis, all diagnostics of sufficient severity are reported and fixed. The `--diagnostics` option allows you to target a particular diagnostic or set of diagnostics of sufficient severity.
+
+- `--diagnostics <diagnostic ids>` - When used in conjunction with `style` or `analyzer` subcommands, allows you to apply targeted fixes for particular analyzers.
+
+*Example:*
+
+Run code-style analysis and fix unused using directive errors.
+
+```console
+dotnet format style ./format.sln --diagnostics IDE0005
+```
+
+### Filter files to format
+
+You can further narrow the list of files to be formatted by specifying a list of paths to include or exclude. When specifying folder paths the path must end with a directory separator. File globbing is supported.
+
+- `--include` - A list of relative file or folder paths to include in formatting.
+- `--exclude` - A list of relative file or folder paths to exclude from formatting.
+
+*Example:*
+
+Other repos built as part of your project can be included using git submodules. These submodules likely contain their own .editorconfig files that are set as `root = true`. This makes it difficult to validate formatting for your project as formatting mistakes in submodules are treated as errors.
+
+The following command sets the repo folder as the workspace. It then includes the `src` and `tests` folders for formatting. The `submodule-a` folder is excluded from the formatting validation.
+
+```console
+dotnet format whitespace --folder --include ./src/ ./tests/ --exclude ./src/submodule-a/ --verify-no-changes
+```
+
+### Logging and Reports
+
+- `--verbosity` - Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]
+- `--report` - Writes a json file to the given directory. Defaults to 'format-report.json' if no filename given.
+- `--binarylog` - Writes a [binary log file](https://msbuildlog.com/) to help in diagnosing solution or project load errors. Defaults to 'format.binlog' if no filename given.
+
+### Validate formatting
+
+- `--verify-no-changes` - Formats files without saving changes to disk. Terminates with a non-zero exit code (`2`) if any files were formatted.

documentation/format/docs/Supported-.editorconfig-options.md

@@ -0,0 +1,31 @@
+# Supported .editorconfig options
+The dotnet-format global tool supports the core set of [EditorConfig options](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties)* as well as the [.NET coding convention settings for EditorConfig](https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2019).
+
+## Core options
+- indent_style
+- indent_size
+- tab_width
+- end_of_line
+- charset
+- insert_final_newline
+- root
+
+[*] The options `trim_trailing_whitespace` and `max_line_length` are not supported. Currently insignificant whitespace is **always** removed by the formatter.
+
+## Removing unnecessary imports
+In order to remove unnecessary imports the IDE0005 (unnecessary import) diagnostic id must be configured in your .editorconfig. When running dotnet-format specify a severity that includes the configured IDE0005 severity.
+
+*Example:*
+
+.editorconfig
+```ini
+root = true
+
+[*.{cs,vb}]
+dotnet_diagnostic.IDE0005.severity = warning
+```
+
+command
+```console
+dotnet format ./format.sln --severity warn
+```

documentation/format/docs/integrations.md

@@ -0,0 +1,90 @@
+# Integrations
+Collection of advice how to auto check/format. Every sample expects dotnet format installed as local tool, unless otherwise noted.
+
+## Git pre-commit hook to reformat
+
+Create file `.git/hooks/pre-commit` with following contents:
+```sh
+#!/bin/sh
+LC_ALL=C
+# Select files to format
+FILES=$(git diff --cached --name-only --diff-filter=ACM "*.cs" | sed 's| |\\ |g')
+[ -z "$FILES" ] && exit 0
+
+# Format all selected files
+echo "$FILES" | cat | xargs | sed -e 's/ /,/g' | xargs dotnet format --include
+
+# Add back the modified files to staging
+echo "$FILES" | xargs git add
+
+exit 0
+
+```
+
+These instructions originally authored by [randulakoralage82](https://medium.com/@randulakoralage82/format-your-net-code-with-git-hooks-a0dc33f68048).
+
+
+## Check on PR in Azure Dev Ops
+
+Add following to your build file:
+
+```yaml
+- task: UseDotNet@2
+  displayName: 'Use .NET 6 sdk'
+  inputs:
+    packageType: 'sdk'
+    version: '6.0.x'
+    includePreviewVersions: true
+
+- task: DotNetCoreCLI@2
+  displayName: 'dotnet-format'
+  inputs:
+    command: 'custom'
+    custom: 'format'
+    arguments: '--verify-no-changes'
+```
+
+These instructions originally authored by [leotsarev](https://github.com/joinrpg/joinrpg-net/).
+
+
+## [pre-commit.com](https://pre-commit.com/) hook to reformat
+
+Add the following block to the `repos` section of your `.pre-commit-config.yaml` file:
+
+```yaml
+-   repo: https://github.com/dotnet/format
+    rev: ""  # Specify a tag or sha here, or run "pre-commit autoupdate"
+    hooks:
+    -   id: dotnet-format
+```
+Note that this will compile and install dotnet format to an isolated environment, using the system installation of the dotnet CLI. See the [pre-commit.com documentation](https://pre-commit.com/#dotnet) for more details. The problem is that dotnet format is using *preview* SDK (even for 5.x versions), and you have to install preview SDK on your machine for compiling it. Another option is to use local feature of pre-commit, as follows:
+
+```yaml
+-   repo: local
+    hooks:
+    #Use dotnet format already installed on your machine
+    -   id: dotnet-format
+        name: dotnet-format
+        language: system 
+        entry: dotnet format --include 
+        types_or: ["c#", "vb"]
+```
+
+These instructions originally authored by [rkm](https://github.com/rkm) & [leotsarev](https://github.com/joinrpg/joinrpg-net/).
+
+
+## Rider reformat on save
+
+1. Open Settings -> Tools -> File Watchers
+1. Press The “Plus Sign” to Add a Custom watcher
+1. Set the name to i.e. “dotnet format on save”
+1. FileType: C#
+1. Scope: Open Files
+1. Program: Write dotnet-format
+1. Arguments: $SolutionPath$ --verbosity diagnostic --include $FileRelativePath$
+1. (Optionally) Append --fix-style warning to fix any style issues automatically on save.
+1. (Optionally) Append --fix-analyzers warning to fix any analyzer warnings on save.
+1. Disable all advanced option checkboxes.
+1. All other values were left default
+
+These instructions originally authored by [Nils Henrik Hals](https://strepto.github.io/Pause/blog/dotnet-format-rider/).