Skip to content

Commit 65494e8

Browse files
author
Prabha Kylasamiyer Sundara Rajan
committed
Added prerequisites in description
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
1 parent 4193b01 commit 65494e8

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/topics/rules-development/create-csharp-custom-rule.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ You can create custom rules for `C#` applications based on the following example
1111

1212
You can use the following custom rule to check if {ProductShortName} triggers an incident when it detects the `WebMatrix.WebData.WebSecurity` class in the `nerd-dinner` example project.
1313

14+
.Prerequisites
15+
16+
* You installed `.NET` SDK 9.x or higher
17+
* You installed `ilspycmd` and `paket` for dependency analysis
18+
* You exported the dotnet tools path by using the `export PATH="$PATH:<path/to/.dotnet/tools"` command
19+
1420
.Procedure
1521
. Create a `csharp-rule.yaml` file in your `Home` directory.
1622

docs/topics/rules-development/yaml-dotnet-provider.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `csharp` provider is an external provider used to analyze `.NET` and `C#` so
1111

1212
The `csharp` provider uses a gRPC interface to perform a semantic analysis of an application source code. The provider parses the code by using tree-sitter and uses stack graph for the analysis to find references to types, methods, classes, and fields. Based on the `C#` rule defenition, the analyzer identifies violations in your code that you must resolve before the application migration.
1313

14+
The `csharp` provider you to install `.NET` software development kit (SDK) 9.x or higher and optionally, the dotnet compiler `ilspycmd` and the packet manager `paket` for dependency analysis.
15+
1416
.`referenced`
1517

1618
The `csharp` provider supports `referenced` capability in rules to define fields such as `pattern`,`location` and `file_path` based on which the provider searches the code for violations.

0 commit comments

Comments
 (0)