Skip to content

Commit 505642b

Browse files
digitalcoyotedigitalcoyote
committed
Update Docs
1 parent bee02ce commit 505642b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+351
-214
lines changed

‎Src/NuGetDefense.Lib/Configuration/Settings.cs

+26-27
Original file line numberDiff line numberDiff line change
@@ -48,29 +48,8 @@ public static Settings LoadSettings(string? settingsFilePath = "")
4848

4949
try
5050
{
51-
// Edit to allow it to repeatedly check if hte file exists prior to multiple instances trying to save over it.
52-
if (File.Exists(settingsFilePath))
53-
{
54-
settings = LoadSettingsFile(settingsFilePath);
55-
}
56-
else
57-
{
58-
settings = new();
59-
SpinWait.SpinUntil(() =>
60-
{
61-
try
62-
{
63-
if (SaveSettings(settings, settingsFilePath)) return true;
64-
settings = LoadSettingsFile(settingsFilePath);
65-
66-
return true;
67-
}
68-
catch
69-
{
70-
return false;
71-
}
72-
}, TimeSpan.FromMinutes(5));
73-
}
51+
// Edit to allow it to repeatedly check if the file exists prior to multiple instances trying to save over it.
52+
settings = File.Exists(settingsFilePath) ? LoadSettingsFile(settingsFilePath) : CreateDefaultSettingsFile(settingsFilePath);
7453
}
7554
catch (Exception e)
7655
{
@@ -82,18 +61,38 @@ public static Settings LoadSettings(string? settingsFilePath = "")
8261
#pragma warning disable 618
8362
if (settings.ErrorSettings.BlacklistedPackages != null)
8463
settings.ErrorSettings.BlockedPackages =
85-
settings.ErrorSettings.BlockedPackages.Concat(settings.ErrorSettings.BlacklistedPackages).ToArray();
64+
settings.ErrorSettings.BlockedPackages?.Concat(settings.ErrorSettings.BlacklistedPackages).ToArray();
8665
if (settings.ErrorSettings.WhiteListedPackages != null)
8766
settings.ErrorSettings.AllowedPackages =
88-
settings.ErrorSettings.AllowedPackages.Concat(settings.ErrorSettings.WhiteListedPackages).ToArray();
67+
settings.ErrorSettings.AllowedPackages?.Concat(settings.ErrorSettings.WhiteListedPackages).ToArray();
8968
#pragma warning restore 618
9069

9170
return settings;
9271
}
9372

73+
public static Settings CreateDefaultSettingsFile(string settingsFilePath)
74+
{
75+
var defaultSettings = new Settings();
76+
SpinWait.SpinUntil(() =>
77+
{
78+
try
79+
{
80+
if (SaveSettings(defaultSettings, settingsFilePath)) return true;
81+
// Assume it failed to save because the file exists and try to load it
82+
defaultSettings = LoadSettingsFile(settingsFilePath);
83+
84+
return true;
85+
}
86+
catch
87+
{
88+
return false;
89+
}
90+
}, TimeSpan.FromMinutes(5));
91+
return defaultSettings;
92+
}
93+
9494
public static Settings LoadSettingsFile(string settingsFilePath)
9595
{
96-
Settings settings;
9796
var settingsFileContents = ReadSettingsFileWhenAble(settingsFilePath, TimeSpan.FromMinutes(5));
9897

9998
var ops = new JsonSerializerOptions
@@ -105,7 +104,7 @@ public static Settings LoadSettingsFile(string settingsFilePath)
105104
Converters = { new JsonStringEnumConverter(JsonNamingPolicy.CamelCase) }
106105
};
107106

108-
settings = JsonSerializer.Deserialize<Settings>(settingsFileContents, ops)!;
107+
var settings = JsonSerializer.Deserialize<Settings>(settingsFileContents, ops)!;
109108
return settings;
110109
}
111110

‎Src/NuGetDefense.Lib/Scanner.cs

+2-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public class Scanner
4343
/// </summary>
4444
public static readonly string GlobalConfigFile = Path.Combine(NuGetDefenseFolder, DefaultSettingsFileName);
4545

46-
private string _nuGetFile;
46+
private string? _nuGetFile;
4747
private string _projectFileName;
4848
private Dictionary<string, NuGetPackage[]> _projects;
4949
private Settings _settings;
@@ -85,7 +85,7 @@ private void LoadSettings(ScanOptions options)
8585
string? settingsFilePath = null;
8686
if (!string.IsNullOrWhiteSpace(options.ProjectFile?.DirectoryName))
8787
{
88-
var projectSettingsPath = Path.Combine(options.ProjectFile?.DirectoryName, DefaultSettingsFileName);
88+
var projectSettingsPath = Path.Combine(options.ProjectFile?.DirectoryName!, DefaultSettingsFileName);
8989
// Check Project Directory First for Settings
9090
if (File.Exists(projectSettingsPath))
9191
{
@@ -104,7 +104,6 @@ private void LoadSettings(ScanOptions options)
104104
// If SettingsPath is still not decided, use the global settings file or create it.
105105
if (string.IsNullOrWhiteSpace(settingsFilePath))
106106
{
107-
108107
Log.Logger.Information($"NuGetDefense: Using global level settings file at: {GlobalConfigFile}");
109108
settingsFilePath = GlobalConfigFile;
110109
}

‎Src/NuGetDefense/Program.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ private static async void Update(FileInfo? vulnDataFile, string? apiKey, FileInf
110110
}
111111
else
112112
{
113-
Settings.LoadSettings();
113+
Settings.CreateDefaultSettingsFile(Scanner.GlobalConfigFile);
114114
}
115115
}
116116
if (vulnDataFile == null)

‎docs/404.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<html lang="en" dir="ltr" class="plugin-native plugin-id-default" data-has-hydrated="false">
33
<head>
44
<meta charset="UTF-8">
5-
<meta name="generator" content="Docusaurus v3.1.1">
6-
<title data-rh="true">Page Not Found | NuGetDefense</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://digitalcoyote.github.io/NuGetDefense/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | NuGetDefense"><link data-rh="true" rel="icon" href="/NuGetDefense/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://digitalcoyote.github.io/NuGetDefense/404.html"><link data-rh="true" rel="alternate" href="https://digitalcoyote.github.io/NuGetDefense/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://digitalcoyote.github.io/NuGetDefense/404.html" hreflang="x-default"><link rel="stylesheet" href="/NuGetDefense/assets/css/styles.c9fb29fa.css">
7-
<script src="/NuGetDefense/assets/js/runtime~main.4bf8e612.js" defer="defer"></script>
8-
<script src="/NuGetDefense/assets/js/main.173b9c25.js" defer="defer"></script>
5+
<meta name="generator" content="Docusaurus v3.3.2">
6+
<title data-rh="true">Page Not Found | NuGetDefense</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://digitalcoyote.github.io/NuGetDefense/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | NuGetDefense"><link data-rh="true" rel="icon" href="/NuGetDefense/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://digitalcoyote.github.io/NuGetDefense/404.html"><link data-rh="true" rel="alternate" href="https://digitalcoyote.github.io/NuGetDefense/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://digitalcoyote.github.io/NuGetDefense/404.html" hreflang="x-default"><link rel="stylesheet" href="/NuGetDefense/assets/css/styles.6f4f6aaa.css">
7+
<script src="/NuGetDefense/assets/js/runtime~main.addf4fa6.js" defer="defer"></script>
8+
<script src="/NuGetDefense/assets/js/main.8e8b5fde.js" defer="defer"></script>
99
</head>
1010
<body class="navigation-with-keyboard">
1111
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/NuGetDefense/"><div class="navbar__logo"><img src="/NuGetDefense/img/logo.svg" alt="NuGetDefense Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/NuGetDefense/img/logo.svg" alt="NuGetDefense Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">NuGetDefense</b></a><a class="navbar__item navbar__link" href="/NuGetDefense/docs/intro">Docs</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/digitalcoyote/NuGetDefense" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link" class="header-github-link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/NuGetDefense/docs/intro">Tutorial</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://twitter.com/CodingCoyote" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://blog.codingcoyote.dev/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/digitalcoyote/NuGetDefense" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 Curtis Carter. Built with Docusaurus.</div></div></div></footer></div>

‎docs/assets/css/styles.c9fb29fa.css ‎docs/assets/css/styles.6f4f6aaa.css

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/js/0a5b0734.448ad7c4.js

-1
This file was deleted.

0 commit comments

Comments
 (0)