Skip to content

docs: update installation instructions with recommended PackageReference sample and disabled-by-default rules #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cliedeman merged 2 commits into from
May 31, 2026
Merged

docs: update installation instructions with recommended PackageReference sample and disabled-by-default rules #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dae32a0
docs: use recommended OutputItemType/ReferenceOutputAssembly sample i…
Copilot May 31, 2026
a2bbaa0
docs: add SW002 (disabled by default) to rule configuration sample in…
Copilot May 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Add the package reference to your `.csproj` file:

```xml
<ItemGroup>
<PackageReference Include="Stackworx.Analyzers" Version="*" PrivateAssets="all" />
<PackageReference Include="Stackworx.Analyzers" Version="*" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
</ItemGroup>
```

:::note
The `PrivateAssets="all"` attribute ensures the analyzer package is only used for analysis and isn't included as a dependency when your project is referenced by others.
The `OutputItemType="Analyzer"` and `ReferenceOutputAssembly="false"` attributes ensure the package is used only for analysis and is not included as a runtime dependency.
:::

## Configuration
Expand Down Expand Up @@ -56,6 +56,9 @@ dotnet_diagnostic.SWGQL03.severity = error

# Change a rule to warning (default)
dotnet_diagnostic.SWGQL01.severity = warning

# Enable rules that are disabled by default
dotnet_diagnostic.SW002.severity = warning # Unused method (disabled by default — see SW002 docs for caveats)
```

## Verification
Expand Down
Loading