Merge pull request #31 from basicx-StrgV/develop

Release 4.0.0

Author: basicx-StrgV

.nuke/build.schema.json

@@ -0,0 +1,134 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$ref": "#/definitions/build",
+  "title": "Build Schema",
+  "definitions": {
+    "build": {
+      "type": "object",
+      "properties": {
+        "Continue": {
+          "type": "boolean",
+          "description": "Indicates to continue a previously failed build attempt"
+        },
+        "DoxygenBin": {
+          "type": "string",
+          "description": "The path of the doxygen bin directory (Default: C:\\Program Files\\doxygen\\bin)"
+        },
+        "Help": {
+          "type": "boolean",
+          "description": "Shows the help text for this build assembly"
+        },
+        "Host": {
+          "type": "string",
+          "description": "Host for execution. Default is 'automatic'",
+          "enum": [
+            "AppVeyor",
+            "AzurePipelines",
+            "Bamboo",
+            "Bitbucket",
+            "Bitrise",
+            "GitHubActions",
+            "GitLab",
+            "Jenkins",
+            "Rider",
+            "SpaceAutomation",
+            "TeamCity",
+            "Terminal",
+            "TravisCI",
+            "VisualStudio",
+            "VSCode"
+          ]
+        },
+        "KeepVersion": {
+          "type": "boolean",
+          "description": "Don't update the version (Default: Minor version will be updated)"
+        },
+        "Major": {
+          "type": "boolean",
+          "description": "Update the major version (Default: Minor version will be updated)"
+        },
+        "NoDocs": {
+          "type": "boolean",
+          "description": "Sets that no docs should be created (Default: Automatically updating the version from the build config)"
+        },
+        "NoLogo": {
+          "type": "boolean",
+          "description": "Disables displaying the NUKE logo"
+        },
+        "Partition": {
+          "type": "string",
+          "description": "Partition to use on CI"
+        },
+        "Patch": {
+          "type": "boolean",
+          "description": "Update the patch version (Default: Minor version will be updated)"
+        },
+        "Plan": {
+          "type": "boolean",
+          "description": "Shows the execution plan (HTML)"
+        },
+        "Profile": {
+          "type": "array",
+          "description": "Defines the profiles to load",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Root": {
+          "type": "string",
+          "description": "Root directory during build execution"
+        },
+        "Skip": {
+          "type": "array",
+          "description": "List of targets to be skipped. Empty list skips all dependencies",
+          "items": {
+            "type": "string",
+            "enum": [
+              "Compile",
+              "Docs",
+              "Info",
+              "LoadConfig",
+              "Pack",
+              "Restore",
+              "UpdateConfig"
+            ]
+          }
+        },
+        "Solution": {
+          "type": "string",
+          "description": "Path to a solution file that is automatically loaded"
+        },
+        "Target": {
+          "type": "array",
+          "description": "List of targets to be invoked. Default is '{default_target}'",
+          "items": {
+            "type": "string",
+            "enum": [
+              "Compile",
+              "Docs",
+              "Info",
+              "LoadConfig",
+              "Pack",
+              "Restore",
+              "UpdateConfig"
+            ]
+          }
+        },
+        "Verbosity": {
+          "type": "string",
+          "description": "Logging verbosity during build execution. Default is 'Normal'",
+          "enum": [
+            "Minimal",
+            "Normal",
+            "Quiet",
+            "Verbose"
+          ]
+        },
+        "Version": {
+          "type": "string",
+          "description": "Provide a new version for the package"
+        }
+      }
+    }
+  }
+}

.nuke/parameters.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "/build.schema.json",
+  "Solution": "src/WGet.Net.sln"
+}

README.md

@@ -7,20 +7,34 @@
 
 ## ❓ What is WGet.NET
 
-WGet.NET is a WinGet wrapper library for .Net.
+WGet.NET is a WinGet wrapper library for **.Net** that allows you to easily install, update, uninstall and more, with the help of **WinGet**, from your application. 
 
 ![WGet.NET Icon](https://raw.githubusercontent.com/basicx-StrgV/WGet.NET/main/repo_design/WGet.NET_Icon_Small.png) 
 
-I created it for another project and then made a library out of it in hope it might be useful to someone else too.  
-**If you tried this library, please give me some feedback. And if you miss a feature, you can create an issue to let me know.**
+I created it for another project and then made a library out of it in the hope it might be useful to someone else too.  
+
+**If you miss a feature or find a problem with the library, feel free to create an [issue](https://github.com/basicx-StrgV/WGet.NET/issues).**
+
+## ✨ Version 4.0
+
+Version 4.0 is intended as a “health” update for the library and therefore includes changes to the structure, classes and functions.  
+This includes breaking changes to the usage of the library. 
+
+***But fear not, no functionality is lost and all breaking changes are documented and provide information on how to change the implementation.***
+
+You can find the full migration documentation [here](https://github.com/basicx-StrgV/WGet.NET/blob/develop/migration_info/V3-V4.md).
+
+This was done to improve maintainability and the experience of using the library, by improving the data structure, removing redundant or useless functions and making the implementation more consistent.
+
+***More information about version 4.0 can be found [here](https://github.com/basicx-StrgV/WGet.NET/releases/tag/4.0.0).***
 
 ## 📓 Documentation
 
 https://basicx-strgv.github.io/WGet.NET/
 
 ## ⚡ Features
 
-**Supported Frameworks:** .Net Core 3.1, .Net Standard 2.0
+**[Supported Framework Versions](https://www.nuget.org/packages/WGet.NET/#supportedframeworks-body-tab)**
 
 - WinGet
   - [x] Get a list of installed packages
@@ -41,7 +55,7 @@ https://basicx-strgv.github.io/WGet.NET/
   - [x] Reset sources
   - [x] Calculate file hash
   - [x] Export Settings
-  - [x] Download package installer
+  - [x] Download package installers
   - [x] Manage pinned packages
   - [x] Access info of the WinGet installation
 - Other
@@ -60,16 +74,18 @@ If WinGet is not installed on your system you can get it here: https://github.co
 ## 💡 Getting started 
 
 The needed namespace is **WGetNET** (`using WGetNET;`).  
-This namespace contains the three main classes that are used to perform actions or get information with winget, plus all additional classes that are needed.
+This namespace contains the three main classes that are used to perform actions or get information with winget, plus additional classes that are needed.
+
+Exceptions are located in the `WGetNET.Exceptions` namespace.
 
 ### WinGetInfo:  
-The ***WinGetInfo*** class can be used to get information about WinGet itself.  
+The ***WinGet*** class can be used to get information about WinGet itself.  
 This class is inherited by the ***WinGetPackageManager*** and ***WinGetSourceManager*** class.
 
-USing this class to check if winget is installed could look like this:
+Using this class to check if winget is installed could look like this:
 ```csharp
-WinGetInfo wingetInfo = new WinGetInfo();
-if (wingetInfo.WinGetInstalled)
+WinGet winget = new WinGet();
+if (winget.IsInstalled)
 {
      Console.WriteLine("WinGet is installed.");
 }
@@ -113,8 +129,8 @@ WinGetPackageManager packageManager = new WinGetPackageManager();
 string packageId = "nkdAgility.AzureDevOpsMigrationTools";
 WinGetPackage package = packageManager.GetInstalledPackages(packageId, true).FirstOrDefault();
 
-if (package.AvailableVersionObject > package.VersionObject)
+if (package.AvailableVersion > package.Version)
 {
-    Console.WriteLine("You are currently running version {currentVersion} and a newer version ({latestVersion}) is available. You should update now using Winget command 'winget {packageId}' from the Windows Terminal.", package.VersionObject, package.AvailableVersionObject, packageId);
+    Console.WriteLine("You are currently running version {currentVersion} and a newer version ({latestVersion}) is available. You should update now using Winget command 'winget {packageId}' from the Windows Terminal.", package.Version, package.AvailableVersion, packageId);
 }
 ```

docs/WGet.NET_Icon.png

@@ -0,0 +1,40 @@
+<script type="text/javascript" src="./doxygen-custom-page-injector.js"></script>
+
+<div id="injection-wrapper" nav-to="about.html" style="display: none;">
+    <div class="header">
+        <div class="headertitle">
+            <div class="title">
+                About
+            </div>
+        </div>
+    </div>
+    <div class="contents">
+        <div class="textblock">
+            <!--General info-->
+            <p><b>WGet.Net</b> was created and is maintained by <b>basic-StrgV</b>.</p>
+            <p>Thanks to all <a href="https://github.com/basicx-StrgV/WGet.NET/graphs/contributors">contributors</a> and people that opened issues, for helping in improving the library.</p>
+            <p><b>License:</b> <a href="https://github.com/basicx-StrgV/WGet.NET/blob/main/LICENSE">MIT</a></p>
+            <p><b>GitHub Repository:</b> <a href="https://github.com/basicx-StrgV/WGet.NET">https://github.com/basicx-StrgV/WGet.NET</a></p>
+            <!--Contact info-->
+            <h1>Contact</h1>
+            <p>
+                <b>GitHub:</b> <a href="https://github.com/basicx-StrgV">https://github.com/basicx-StrgV</a>
+                <br>
+                <b>E-Mail:</b> <a href="mailto:basicx.strgv@gmail.com">basicx.strgv@gmail.com</a>
+            </p>
+            <!--Docs info-->
+            <h1>Docs</h1>
+            <p>The documentation was generated with the help of <a href="https://www.doxygen.nl/">Doxygen</a>.</p>
+            <p>
+                The base style, dark/light mode toggling and other UI improvements are done with <a href="https://github.com/jothepro/doxygen-awesome-css">doxygen-awesome-css</a>.
+                <br>
+                There are additional custom styles and scripts, and the <b>doxygen-awesome-darkmode-toggle.js</b> script was modified for this project.
+            </p>
+            <p>
+                Custom html pages, like this "<i>About</i>" page, are done with the
+                <a href="https://github.com/basicx-StrgV/doxygen-custom-page-injector">doxygen-custom-page-injector</a>, which was initially created for this project.
+            </p>
+        </div>
+    </div>
+</div>
+