Skip to content

Commit

Permalink
Improve docs for analyze/fix command (#1241)
Browse files Browse the repository at this point in the history
  • Loading branch information
josefpihrt authored Nov 10, 2023
1 parent 963de8d commit 3793592
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 0 deletions.
4 changes: 4 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- [CLI] Add note to docs that Roslynator CLI does not contain any analyzers itself ([PR](https://github.com/dotnet/roslynator/pull/1241))

### Fixed

- Fix [RCS1234](https://josefpihrt.github.io/docs/roslynator/analyzers/RCS1234) ([PR](https://github.com/dotnet/roslynator/pull/1233))
Expand Down
5 changes: 5 additions & 0 deletions src/CommandLine.DocumentationGenerator/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ private static void Main(params string[] args)
? File.ReadAllText(additionalContentFilePath)
: "";

string summaryContentFilePath = Path.Combine(dataDirectoryPath, command.Name + "_summary.md");

if (File.Exists(summaryContentFilePath))
dw.WriteRaw(File.ReadAllText(summaryContentFilePath));

writer.WriteCommandSynopsis(command, application);
writer.WriteArguments(command.Arguments);
writer.WriteOptions(command.Options);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Project or solution should be built before the command is executed.

:::info
Roslynator CLI does not contain any analyzers (such as [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)) itself.

Analyzers are either referenced as NuGet packages or it is possible to add analyzer assemblies with parameter `--analyzer-assemblies`.
:::
7 changes: 7 additions & 0 deletions src/CommandLine.DocumentationGenerator/data/fix_summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Project or solution should be built before the command is executed.

:::info
Roslynator CLI does not contain any analyzers (such as [Roslynator.Analyzers](https://www.nuget.org/packages/roslynator.analyzers)) itself.

Analyzers are either referenced as NuGet packages or it is possible to add analyzer assemblies with parameter `--analyzer-assemblies`.
:::

0 comments on commit 3793592

Please sign in to comment.