Merge pull request #218 from sunnamed434/dotnet-global-tool

Add .NET Global Tool, might be not stable yet, bug fixes

Author: sunnamed434

.deepsource.toml

@@ -5,7 +5,7 @@ inputs:
     description: 'Path to .nuspec'
     required: true
   nuget_push:
-    description: 'Push to Nuget?'
+    description: 'Push to NuGet?'
     required: false
     default: false
   nuget_key:

.github/actions/nuget-pack/action.yaml

@@ -7,12 +7,16 @@ inputs:
   target_framework:
     description: 'The target framework to build on'
     required: true
+  use_runtime:
+    description: 'Include runtime flag? Set to true for self-contained builds, false (default) for global tools.'
+    required: false
+    default: true
   runtime_version:
-    description: 'Build runtime version default linux-x64'
+    description: 'Build runtime version (default linux-x64) if using a runtime flag'
     required: false
     default: 'linux-x64'
   nuget_push:
-    description: 'Push to Nuget on release?'
+    description: 'Push to NuGet on release?'
     required: false
     default: false
   nuget_key:
@@ -34,35 +38,46 @@ runs:
     # Generate semver compatible version from current tag and commit hash
     - name: Create version
       id: get-version
-      run: echo "version=$(git describe --tags `git rev-list --tags --max-count=1`)+$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+      run: echo "version=$(git describe --tags $(git rev-list --tags --max-count=1))+$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
       shell: bash
 
     - name: Check Prerelease
       id: check-prerelease
-      run: "if ${{ contains(steps.get-version.outputs.version, '-') }}; then
-              echo is_prerelease=true >> $GITHUB_OUTPUT;
-            else
-              echo is_prerelease=false >> $GITHUB_OUTPUT;
-            fi"
+      run: |
+        if [[ "${{ steps.get-version.outputs.version }}" == *"-"* ]]; then
+          echo "is_prerelease=true" >> $GITHUB_OUTPUT
+        else
+          echo "is_prerelease=false" >> $GITHUB_OUTPUT
+        fi
+      shell: bash
+
+    # Determine whether to include the --runtime flag.
+    - name: Set runtime flag
+      id: set-runtime-flag
+      run: |
+        if [ "${{ inputs.use_runtime }}" = "true" ]; then
+          echo "runtime=--runtime ${{ inputs.runtime_version }}" >> $GITHUB_OUTPUT
+        else
+          echo "runtime=" >> $GITHUB_OUTPUT
+        fi
       shell: bash
 
     # Commands that are used multiple times.
-    # Placed in one place to make sure that the arguments would always be the same
     - name: Common commands
       id: common-commands
       run: |
-        echo "dotnet-restore=dotnet restore \$PROJECT_PATH --runtime ${{ inputs.runtime_version }} -p:Configuration=Release -p:TargetFramework=${{ inputs.target_framework }}" >> $GITHUB_OUTPUT
-        echo "dotnet-build=dotnet build \$PROJECT_PATH --configuration Release --no-restore --runtime ${{ inputs.runtime_version }} -p:TargetFramework=${{ inputs.target_framework }} -p:BitMonoVersion=${{ steps.get-version.outputs.version }}" >> $GITHUB_OUTPUT
-        echo "dotnet-test=dotnet test \$PROJECT_PATH --configuration Release --no-restore --no-build --runtime ${{ inputs.runtime_version }} -p:TargetFramework=${{ inputs.target_framework }}" >> $GITHUB_OUTPUT
+        echo "dotnet-restore=dotnet restore \$PROJECT_PATH ${{ steps.set-runtime-flag.outputs.runtime }} -p:Configuration=Release -p:TargetFramework=${{ inputs.target_framework }}" >> $GITHUB_OUTPUT
+        echo "dotnet-build=dotnet build \$PROJECT_PATH --configuration Release --no-restore ${{ steps.set-runtime-flag.outputs.runtime }} -p:TargetFramework=${{ inputs.target_framework }} -p:BitMonoVersion=${{ steps.get-version.outputs.version }}" >> $GITHUB_OUTPUT
+        echo "dotnet-test=dotnet test \$PROJECT_PATH --configuration Release --no-restore --no-build ${{ steps.set-runtime-flag.outputs.runtime }} -p:TargetFramework=${{ inputs.target_framework }}" >> $GITHUB_OUTPUT
       shell: bash
 
-    # Install dependencies (this needs to be a separate step from build for caching)
+    # Install dependencies (separate step for caching)
     - name: Install dependencies
       run: |
         ${{ steps.common-commands.outputs.dotnet-restore }}
         pwsh -File .github/actions/project-build/run-command-for-every-tests-project.ps1 "$GITHUB_WORKSPACE/tests" '${{ steps.common-commands.outputs.dotnet-restore }}'
       env:
-        PROJECT_PATH: ${{ inputs.project_path }} # Used by commands in `common-commands` step
+        PROJECT_PATH: ${{ inputs.project_path }}
       shell: bash
 
     # Build project
@@ -71,27 +86,29 @@ runs:
         ${{ steps.common-commands.outputs.dotnet-build }}
         pwsh -File .github/actions/project-build/run-command-for-every-tests-project.ps1 "$GITHUB_WORKSPACE/tests" '${{ steps.common-commands.outputs.dotnet-build }}'
       env:
-        PROJECT_PATH: ${{ inputs.project_path }} # Used by commands in `common-commands` step
+        PROJECT_PATH: ${{ inputs.project_path }}
       shell: bash
 
     # Test project
     - name: Test
       run: |
         pwsh -File .github/actions/project-build/run-command-for-every-tests-project.ps1 "$GITHUB_WORKSPACE/tests" '${{ steps.common-commands.outputs.dotnet-test }}'
       env:
-        PROJECT_PATH: ${{ inputs.project_path }} # Used by commands in `common-commands` step
+        PROJECT_PATH: ${{ inputs.project_path }}
       shell: bash
 
-    # Push to GitHub packages on each commit and release
+    # Push to GitHub packages on each commit and release (Nightly)
     - name: Push to NuGet (Nightly)
-      run: if ${{ inputs.nuget_push == 'true' && (github.event_name == 'push' || (github.event_name == 'create' && github.event.ref_type == 'tag')) }}; then
-        dotnet nuget push ${{ inputs.project_path }}/bin/Release/*.nupkg --api-key ${{ inputs.github_token }} --skip-duplicate --source https://nuget.pkg.github.com/sunnamed434/index.json;
+      run: |
+        if [ "${{ inputs.nuget_push }}" = "true" ] && ( [ "${{ github.event_name }}" = "push" ] || ( [ "${{ github.event_name }}" = "create" ] && [ "${{ github.event.ref_type }}" = "tag" ] ) ); then
+          dotnet nuget push ${{ inputs.project_path }}/bin/Release/*.nupkg --api-key ${{ inputs.github_token }} --skip-duplicate --source https://nuget.pkg.github.com/sunnamed434/index.json;
         fi
       shell: bash
 
-    # Push to NuGet on each tag, but only if the tag is not a pre-release version
+    # Push to NuGet on each tag, but only if not a pre-release version (Release)
     - name: Push to NuGet (Release)
-      run: if ${{ inputs.nuget_push == 'true' && github.event_name == 'create' && github.event.ref_type == 'tag' && steps.check-prerelease.outputs.is_prerelease == 'false' }}; then
-        dotnet nuget push ${{ inputs.project_path }}/bin/Release/*.nupkg --api-key ${{ inputs.nuget_key }} --skip-duplicate --source https://api.nuget.org/v3/index.json;
+      run: |
+        if [ "${{ inputs.nuget_push }}" = "true" ] && [ "${{ github.event_name }}" = "create" ] && [ "${{ github.event.ref_type }}" = "tag" ] && [ "${{ steps.check-prerelease.outputs.is_prerelease }}" = "false" ]; then
+          dotnet nuget push ${{ inputs.project_path }}/bin/Release/*.nupkg --api-key ${{ inputs.nuget_key }} --skip-duplicate --source https://api.nuget.org/v3/index.json;
         fi
-      shell: bash
+      shell: bash

.github/actions/project-build/action.yaml

@@ -0,0 +1,42 @@
+name: BitMono.GlobalTool
+
+on:
+  create:
+    tags:
+      - "*"
+  push:
+    branches: [ main ]
+    paths:
+      - '.github/workflows/BitMono.GlobalTool.yaml'
+      - 'src/BitMono.GlobalTool/**'
+      - 'src/props/**'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - '.github/workflows/BitMono.GlobalTool.yaml'
+      - 'src/BitMono.GlobalTool/**'
+      - 'src/props/**'
+
+jobs:
+  build:
+    name: "BitMono.GlobalTool Build"
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-dotnet@v4
+      name: Setup .NET
+      with:
+        dotnet-version: 9.x
+        
+    - uses: ./.github/actions/project-build
+      id: project-build
+      with:
+        project_path: src/BitMono.GlobalTool
+        github_token: ${{ secrets.PAT }}
+        nuget_key: ${{ secrets.NUGET_DEPLOY_KEY }}
+        nuget_push: true
+        use_runtime: false  # Because this is a dotnet tool.

.github/workflows/BitMono.GlobalTool.yaml

@@ -61,6 +61,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BitMono.Obfuscation.TestCas
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sandbox", "test\Sandbox\Sandbox.csproj", "{C5BD413C-89AF-4480-870D-985AE6C44A38}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "src\BitMono.GlobalTool", "src\BitMono.GlobalTool\BitMono.GlobalTool.csproj", "{EFBBB7CA-39C7-42A7-A965-7A2F172B1707}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -139,6 +141,10 @@ Global
 		{C5BD413C-89AF-4480-870D-985AE6C44A38}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C5BD413C-89AF-4480-870D-985AE6C44A38}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C5BD413C-89AF-4480-870D-985AE6C44A38}.Release|Any CPU.Build.0 = Release|Any CPU
+		{EFBBB7CA-39C7-42A7-A965-7A2F172B1707}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{EFBBB7CA-39C7-42A7-A965-7A2F172B1707}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{EFBBB7CA-39C7-42A7-A965-7A2F172B1707}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{EFBBB7CA-39C7-42A7-A965-7A2F172B1707}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -164,6 +170,7 @@ Global
 		{49E6076C-FEC8-4411-B7AE-4DB6112370C1} = {1EF50257-AFD3-48A3-9E22-03BDC25550A7}
 		{E73C9803-971F-4F7D-A21B-9097C2EC1A80} = {A431DCB4-6EF9-4BEF-8902-FA704D62624E}
 		{C5BD413C-89AF-4480-870D-985AE6C44A38} = {1EF50257-AFD3-48A3-9E22-03BDC25550A7}
+		{EFBBB7CA-39C7-42A7-A965-7A2F172B1707} = {D87066C4-1144-4BD8-96E9-9F4676001397}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {7DA0BB43-C1D4-4688-BE43-A9ED2D6F78EE}

BitMono.sln

@@ -106,7 +106,7 @@ To download the latest release of BitMono, follow these steps:
 - **Targeting Mono or Unity Engine Runtime**: If your target file is built for .NET Framework and runs on Mono or Unity, use the .NET Framework version:
   `BitMono-v0.25.3+e64e54d3-CLI-net462-win-x64.zip`
 
-> **Note:** Be sure to select the correct version of BitMono that matches your Target Framework. Using the wrong version could result in compatibility issues.
+> **Note:** Be sure to select the correct version of BitMono that matches your Target Framework. Using the wrong version could result in compatibility issues, however, if that works ok anyway or if you know what you're doing, you can ignore it.
 
 ### Pre-Require
 

README.md

@@ -5,7 +5,7 @@ public class JsonConfigurationAccessor : IConfigurationAccessor
     protected JsonConfigurationAccessor(string file)
     {
         Configuration = new ConfigurationBuilder()
-            .AddJsonFile(file, true, true)
+            .AddJsonFile(file, false, true)
             .Build();
     }
 

src/BitMono.API/Configuration/JsonConfigurationAccessor.cs

@@ -4,7 +4,6 @@
     <OutputType>Exe</OutputType>
     <TargetFrameworks>net9.0;net8.0;net7.0;net6.0;net462;netstandard2.1;netstandard2.0;</TargetFrameworks>
     <ApplicationIcon>BitMonoLogo.ico</ApplicationIcon>
-    <SolutionDir>$([System.IO.Path]::GetFullPath($(MSBuildProjectDirectory)/../../))</SolutionDir>
   </PropertyGroup>
 
   <Import Project="$(MSBuildThisFileDirectory)..\..\props\SharedProjectProps.props"/>

src/BitMono.CLI/BitMono.CLI.csproj

@@ -7,5 +7,17 @@ internal class ObfuscationNeeds
     public string FileBaseDirectory { get; set; }
     public string ReferencesDirectoryName { get; set; }
     public string OutputPath { get; set; }
+    public ObfuscationNeedsWay Way { get; set; }
 #pragma warning restore CS8618
+}
+
+/// <summary>
+/// The way <see cref="ObfuscationNeeds"/> was created.
+/// </summary>
+public enum ObfuscationNeedsWay
+{
+    Unknown,
+    Readline,
+    Options,
+    Other,
 }

src/BitMono.CLI/Modules/ObfuscationNeeds.cs

@@ -43,7 +43,8 @@ public OptionsObfuscationNeedsFactory(string[] args,
                 FileName = filePath,
                 FileBaseDirectory = fileBaseDirectory,
                 ReferencesDirectoryName = fileBaseDirectory,
-                OutputPath = fileBaseDirectory
+                OutputPath = fileBaseDirectory,
+                Way = ObfuscationNeedsWay.Options
             };
         }
         else
@@ -57,7 +58,8 @@ public OptionsObfuscationNeedsFactory(string[] args,
                     : Path.Combine(fileBaseDirectory, _obfuscationSettings.ReferencesDirectoryName),
                 OutputPath = options.Output?.IsNullOrEmpty() == false
                     ? options.Output
-                    : Path.Combine(fileBaseDirectory, _obfuscationSettings.OutputDirectoryName)
+                    : Path.Combine(fileBaseDirectory, _obfuscationSettings.OutputDirectoryName),
+                Way = ObfuscationNeedsWay.Options
             };
         }
 

src/BitMono.CLI/Modules/OptionsObfuscationNeedsFactory.cs

@@ -16,30 +16,29 @@ public ReadlineObfuscationNeedsFactory(string[] args, ObfuscationSettings obfusc
     public ObfuscationNeeds Create(CancellationToken cancellationToken)
     {
         var fileName = GetFileName(_args);
-        var specifyingFile = true;
-        while (specifyingFile)
+        while (true)
         {
             try
             {
-                _logger.Information("Please, specify file or drag-and-drop in BitMono CLI");
-
                 cancellationToken.ThrowIfCancellationRequested();
 
+                _logger.Information("Please, specify file or drag-and-drop in BitMono CLI");
+
                 fileName = PathFormatterUtility.Format(Console.ReadLine());
-                if (string.IsNullOrWhiteSpace(fileName) == false)
+                cancellationToken.ThrowIfCancellationRequested();
+                if (!string.IsNullOrWhiteSpace(fileName))
                 {
                     if (File.Exists(fileName))
                     {
-                        specifyingFile = false;
                         _logger.Information("File successfully specified: {0}", fileName);
+                        break;
                     }
-                    else
-                    {
-                        _logger.Warning("File cannot be found, please, try again!");
-                    }
+
+                    _logger.Warning("File cannot be found, please, try again!");
                 }
                 else
                 {
+                    cancellationToken.ThrowIfCancellationRequested();
                     _logger.Warning("Unable to specify empty null or whitespace file, please, try again!");
                 }
             }
@@ -65,10 +64,9 @@ public ObfuscationNeeds Create(CancellationToken cancellationToken)
         {
             outputDirectoryName = Path.Combine(fileBaseDirectory, _obfuscationSettings.OutputDirectoryName);
             dependenciesDirectoryName = Path.Combine(fileBaseDirectory, _obfuscationSettings.ReferencesDirectoryName);
-            if (Directory.Exists(dependenciesDirectoryName) == false)
+            if (!Directory.Exists(dependenciesDirectoryName))
             {
-                var specifyingDependencies = true;
-                while (specifyingDependencies)
+                while (true)
                 {
                     try
                     {
@@ -78,20 +76,19 @@ public ObfuscationNeeds Create(CancellationToken cancellationToken)
                         {
                             _logger.Information("Dependencies (libs) successfully found automatically: {0}!",
                                 dependenciesDirectoryName);
-                            specifyingDependencies = false;
                             break;
                         }
 
                         _logger.Information("Please, specify dependencies (libs) path: ");
                         var newDependenciesDirectoryName = PathFormatterUtility.Format(Console.ReadLine());
-                        if (string.IsNullOrWhiteSpace(newDependenciesDirectoryName) == false)
+                        if (!string.IsNullOrWhiteSpace(newDependenciesDirectoryName))
                         {
                             if (Directory.Exists(newDependenciesDirectoryName))
                             {
                                 dependenciesDirectoryName = newDependenciesDirectoryName;
                                 _logger.Information("Dependencies (libs) successfully specified: {0}!",
                                     newDependenciesDirectoryName);
-                                specifyingDependencies = false;
+                                break;
                             }
                             else
                             {
@@ -127,14 +124,15 @@ public ObfuscationNeeds Create(CancellationToken cancellationToken)
             FileName = fileName,
             FileBaseDirectory = fileBaseDirectory,
             ReferencesDirectoryName = dependenciesDirectoryName,
-            OutputPath = outputDirectoryName
+            OutputPath = outputDirectoryName,
+            Way = ObfuscationNeedsWay.Readline
         };
     }
 
     private string GetFileName(string[] args)
     {
         string? file = null;
-        if (args.IsEmpty() == false)
+        if (!args.IsEmpty())
         {
             file = PathFormatterUtility.Format(args[0]);
         }