Skip to content

Commit a21b17d

Browse files
committed
Updated readme
1 parent 749c065 commit a21b17d

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,15 @@ Below are the list of properties in the config file.
6666
- RunDotnetFormat
6767
- Required
6868
- True to run the `dotnet format` command on all csproj files
69+
- NugetAudit
70+
- Required
71+
- This is an object with 3 properties, each is required. For more information see the Microsoft documentation at https://learn.microsoft.com/en-us/nuget/concepts/auditing-packages#configuring-nuget-audit
72+
- NuGetAudit
73+
- Boolean to enable/disable the NuGet Audit features. Note that even if this is set to false, you still need to provide values for the other 2 properties even though they won't be used.
74+
- AuditMode
75+
- String. Which mode to audit, `direct` dependencies, or `all` dependencies.
76+
- AuditLevel
77+
- String. Minimum severity level to report. Ex: If you set it to moderate, you get `moderate`, `high`, and `critical` advisories. If you set it to `low`, you get all advisories.
6978
- OutputFile
7079
- Optional
7180
- If this is set, it will be the file to write logs to, in addition to the console
@@ -77,14 +86,21 @@ Below are the list of properties in the config file.
7786

7887
```json
7988
{
80-
"RootDirectory": "C:/my-repos/my-app-1",
89+
"RootDirectory": "C:\\GitHub\\ProgrammerAl\\ProgrammerAlSite",
8190
"IgnorePatterns": [],
8291
"NpmBuildCommand": "publish",
8392
"DotNetTargetFramework": "net8.0",
8493
"DotNetLangVersion": "latest",
8594
"EnableNetAnalyzers": true,
8695
"EnforceCodeStyleInBuild": true,
87-
"RunDotnetFormat": true
96+
"RunDotnetFormat": true,
97+
"NugetAudit": {
98+
"NuGetAudit": true,
99+
"AuditMode": "all",
100+
"AuditLevel": "low"
101+
},
102+
"OutputFile": "./code-updater-output.txt",
103+
"LogLevel": "Verbose"
88104
}
89105
```
90106

src/CodeUpdater/CodeUpdater/sampleUpdateOptions.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"RootDirectory": "C:\\GitHub\\ProgrammerAl\\ProgrammerAlSite",
2+
"RootDirectory": "C:/my-repos/my-app-1",
33
"IgnorePatterns": [],
44
"NpmBuildCommand": "publish",
55
"DotNetTargetFramework": "net8.0",

0 commit comments

Comments
 (0)