Merge branch 'master' of http://192.168.1.4:3000/Ronnie/SjkScripts

Reviewed-on: #2

.gitea/workflows/documentme.yml

@@ -0,0 +1,24 @@
+on:
+  push:
+    branches:
+      - master
+jobs:
+  generate-docs:
+    runs-on: ubuntu-latest
+    name: Generate Docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 10.0.x
+      - name: Generate Documentation
+        uses: FuLagann/csharp-docs-generator@v1.0
+        with:
+          build-tasks: dotnet build
+          cleanup-tasks: dotnet clean
+          binaries: bin/Debug/net10.0/SjkScripts.dll
+          output-path: docs/api
+          user-email: ronnie.kisner.jr@gmail.com
+          user-name: C# Document Generator

.gitea/workflows/test.yml

@@ -21,23 +21,28 @@ jobs:
 
       - name: Restore
         run: dotnet restore
+      - name: Calculate Version
+        id: version
+        run: |
+          TAG=$(git describe --tags --abbrev=0)
+          COMMITS=$(git rev-list $TAG..HEAD --count)
 
-      - name: Install GitVersion
+          BASE=${TAG#v}
-        uses: gittools/actions/gitversion/setup@v0
-        with:
-          versionSpec: '5.x'
 
-      - name: Determine Version
+          IFS='.' read MAJOR MINOR PATCH <<< "$BASE"
-        id: gitversion
-        uses: gittools/actions/gitversion/execute@v0
 
+          NEW_PATCH=$((PATCH + COMMITS))
+
+          VERSION="$MAJOR.$MINOR.$NEW_PATCH"
+
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
       - name: Build
         run: dotnet build -c Release
 
       - name: Pack
         run: |
           dotnet pack \
-            -p:PackageVersion=${{ steps.gitversion.outputs.semVer }} \
+            -p:PackageVersion=${{ steps.version.outputs.VERSION }} \
             -c Release
 
       - name: Publish

.gitignore

@@ -1,3 +1,2 @@
 obj
-bin
+bin
-.packages

Functional/Tuple.cs

@@ -1,7 +1,44 @@
 namespace SJK.Functional;
 
+/// <summary>
+/// Provides methods to convert values into tuples.
+/// </summary>
 public static class TupleExtensions
 {
+    /// <summary>
+    /// Converts two values of any type into a tuple.
+    /// </summary>
+    /// <typeparam name="T1">The type of the first value.</typeparam>
+    /// <typeparam name="T2">The type of the second value.</typeparam>
+    /// <param name="first">The first value to convert.</param>
+    /// <param name="second">The second value to convert.</param>
+    /// <returns>A tuple containing both values.</returns>
     public static (T1, T2) ToTuple<T1, T2>(this T1 first, T2 second) => (first, second);
+
+    /// <summary>
+    /// Converts three values of any type into a tuple.
+    /// </summary>
+    /// <typeparam name="T1">The type of the first value.</typeparam>
+    /// <typeparam name="T2">The type of the second value.</typeparam>
+    /// <typeparam name="T3">The type of the third value.</typeparam>
+    /// <param name="first">The first value to convert.</param>
+    /// <param name="second">The second value to convert.</param>
+    /// <param name="third">The third value to convert.</param>
+    /// <returns>A tuple containing all three values.</returns>
+    public static (T1, T2, T3) ToTuple<T1, T2, T3>(this T1 first, T2 second, T3 third) => (first, second, third);
+
+    /// <summary>
+    /// Converts four values of any type into a tuple.
+    /// </summary>
+    /// <typeparam name="T1">The type of the first value.</typeparam>
+    /// <typeparam name="T2">The type of the second value.</typeparam>
+    /// <typeparam name="T3">The type of the third value.</typeparam>
+    /// <typeparam name="T4">The type of the fourth value.</typeparam>
+    /// <param name="first">The first value to convert.</param>
+    /// <param name="second">The second value to convert.</param>
+    /// <param name="third">The third value to convert.</param>
+    /// <param name="forth">The fourth value to convert.</param>
+    /// <returns>A tuple containing all four values.</returns>
+    public static (T1, T2, T3, T4) ToTuple<T1, T2, T3, T4>(this T1 first, T2 second, T3 third, T4 forth) => (first, second, third, forth);
 }
 

GitVersion.yml

@@ -1,9 +0,0 @@
-mode: ContinuousDelivery
-
-branches:
-  main:
-    increment: Patch
-  feature:
-    increment: Minor
-  hotfix:
-    increment: Patch

README.md

@@ -0,0 +1,62 @@
+# Project Title
+
+Simple overview of use/purpose.
+
+## Description
+
+An in-depth paragraph about your project and overview of use.
+
+## Getting Started
+
+### Dependencies
+
+* Describe any prerequisites, libraries, OS version, etc., needed before installing program.
+* ex. Windows 10
+
+### Installing
+
+* How/where to download your program
+* Any modifications needed to be made to files/folders
+
+### Executing program
+
+* How to run the program
+* Step-by-step bullets
+```
+code blocks for commands
+```
+
+## Help
+
+Any advise for common problems or issues.
+```
+command to run if program contains helper info
+```
+
+## Authors
+
+Contributors names and contact info
+
+ex. Dominique Pizzie  
+ex. [@DomPizzie](https://twitter.com/dompizzie)
+
+## Version History
+
+* 0.2
+    * Various bug fixes and optimizations
+    * See [commit change]() or See [release history]()
+* 0.1
+    * Initial Release
+
+## License
+
+This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details
+
+## Acknowledgments
+
+Inspiration, code snippets, etc.
+* [awesome-readme](https://github.com/matiassingers/awesome-readme)
+* [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
+* [dbader](https://github.com/dbader/readme-template)
+* [zenorocha](https://gist.github.com/zenorocha/4526327)
+* [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)

SjkScripts.csproj

@@ -5,6 +5,7 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
 </Project>