C# Compiler

.github/workflows/build.yaml

@@ -0,0 +1,40 @@
+name: Build Compiler
+
+on:
+  push:
+    branches: [ master ]
+    paths: ["src/**", ".github/workflows/build.yaml"]
+  pull_request:
+    paths: ["src/**", ".github/workflows/build.yaml"]
+  workflow_call:
+    outputs:
+      artifact:
+        value: ${{ github.inputs.artifact }}
+        description: 'The artifact that was built'
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup DotNet
+        uses: actions/setup-dotnet@v4
+        with:
+          cache: true
+          dotnet-version: 8.0.x
+          cache-dependency-path: "src/Compiler/packages.lock.json"
+
+      - name: Install dependencies
+        run: dotnet restore --locked-mode -r win-x64
+
+      - name: Build
+        run: dotnet publish ./src/Compiler/Compiler.csproj --sc -c Release -r win-x64
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Compiler
+          path: ./src/Compiler/bin/Release/win-x64/publish/Compiler.exe

.github/workflows/compiler.yaml → .github/workflows/compile-scripts.yaml

@@ -3,13 +3,9 @@ name: Compiler
 on:
   push:
     branches: [master]
-    paths:
-      - "src/**"
-      - "compiled/**"
-      - "utils/Compiler.ps1"
-      - ".github/workflows/compiler.yaml"
+    paths: [ "src/**/*.ps1", ".github/workflows/compile-scripts.yaml" ]
   pull_request:
-    paths: ["src/**", "compiled/**", "utils/Compiler.ps1"]
+    paths: [ "src/**/*.ps1", ".github/workflows/compile-scripts.yaml" ]
 
 jobs:
   changes:
@@ -23,8 +19,6 @@ jobs:
         uses: actions/checkout@v4
 
         # Checks for changes in the 'compiled' and 'src' directories
-        # We include 'utils/Compiler.ps1' in the 'src' directory incase it is modified
-        # As this can affect all scripts in the src directory.
         # We also check for deleted files so we can cleanup the compiled directory
       - name: Collect Changes for Upcoming Jobs
         uses: dorny/[email protected]
@@ -35,25 +29,9 @@ jobs:
             compiled:
               - 'compiled/**'
             src:
-              - 'src/**'
-              - 'utils/Compiler.ps1'
+              - 'src/**/*.(ps1|psm1)'
             src_deleted:
-              - deleted: 'src/**'
-
-  protect-directory:
-    runs-on: ubuntu-latest
-    needs: changes
-    # Only run if changes have been made to the 'compiled' directory
-    if: ${{ needs.changes.outputs.compiled == 'true' && github.actor != 'github-actions' }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-        # Don't run if the push was forced, as this is likely a cleanup.
-      - if: ${{ github.event_name != 'push' && !github.event.forced }}
-        run: |
-          echo "Manual changes to 'compiled' directory are not allowed."
-          exit 1
+              - deleted: 'src/**/*.(ps1|psm1)'
 
   cleanup-directory:
     runs-on: ubuntu-latest
@@ -83,19 +61,29 @@ jobs:
         with:
           commit_message: "chore(compiled): Remove compiled versions of deleted files"
 
+  build:
+    uses: ./.github/workflows/build.yaml
+
   compile-scripts:
-    runs-on: ubuntu-latest
-    needs: changes
+    runs-on: windows-latest
+    needs: [changes, build]
     if: ${{ needs.changes.outputs.src == 'true' }}
     permissions:
       contents: write
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Compile Scripts
-        shell: pwsh
-        run: ./utils/Invoke-CompileAllScripts.ps1 -Debug -Verbose
+      - name: Download Compiler Artifact
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          workflow: build.yaml
+          workflow_conclusion: success
+          name: Compiler
+
+      - name: Run Compiler
+        run: .\Compiler.exe -i .\src -o .\compiled
 
       - name: Commit Changes
         if: ${{ needs.changes.outputs.src == 'true' && github.event_name == 'push' }}

.github/workflows/documentation.yaml

@@ -2,10 +2,14 @@ name: Documentaion
 
 on:
   push:
-    branches: [ master ]
-    paths: [ 'docs/**', 'src/**', 'utils/Generate-Documentation.ps1', '.github/workflows/documentation.yaml' ]
-  pull_request:
-    paths: [ 'docs/**', 'src/**' ]
+    branches: [master]
+    paths:
+      [
+        "docs/**",
+        "src/**",
+        "utils/Generate-Documentation.ps1",
+        ".github/workflows/documentation.yaml",
+      ]
 
 jobs:
   update_docs:
@@ -23,7 +27,9 @@ jobs:
 
       - name: Generate Documentation
         shell: pwsh
-        run: .\utils\Generate-Documentation.ps1
+        run: |
+          Install-Module -Name platyPS -Scope CurrentUser
+          .\utils\Generate-Documentation.ps1
 
       - name: Check for changes
         id: changes
@@ -43,7 +49,7 @@ jobs:
     name: Deploy Documentation
     runs-on: ubuntu-latest
     needs: update_docs
-    if : ${{ github.event_name == 'push' && needs.update_docs.outputs.changes.docs == 'true' }}
+    if: ${{ github.event_name == 'push' && needs.update_docs.outputs.changes.docs == 'true' }}
     permissions:
       contents: read
       pull-requests: read

.github/workflows/linter.yaml

@@ -1,25 +1,58 @@
 name: Lint
 
-on: [workflow_dispatch]
+on:
+  pull_request:
+    paths: ["src/**", "tests/**", "utils/**", ".github/workflows/**"]
+  push:
+    branches: [master]
+    paths: ["src/**", "tests/**", "utils/**", ".github/workflows/**"]
 
 jobs:
-  lint:
-    name: Lint
+  powershell:
+    name: PowerShell Lint
     runs-on: ubuntu-latest
     permissions:
       contents: read
-      packages: read
-      statuses: write
+      security-events: write
+      actions: read
     steps:
-      - name: Checkout repository
+      - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Super-Linter
-        uses: super-linter/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          EDITORCONFIG_FILE_NAME: ".editorconfig"
-          POWERSHELL_CONFIG_FILE: "PSScriptAnalyzerSettings.psd1"
-          FILTER_REGEX_EXCLUDE: ".*compiled/.*|.*docs/.*|LICENSE"
+      - name: Run PSScriptAnalyzer
+        uses: microsoft/psscriptanalyzer-action@main
+        with:
+          path: .\
+          recurse: true
+          ignorePattern: '"n-sight/cleaners", "compiled/"'
+          settings: .\PSScriptAnalyzerSettings.psd1
+          output: results.sarif
+
+      - name: Upload SARIF results
+        uses: github/codeql-action/upload-sarif@v3
+        if: ${{ always() }}
+        with:
+          sarif_file: results.sarif
+
+  # lint:
+  #   name: Lint
+  #   runs-on: ubuntu-latest
+  #   permissions:
+  #     contents: read
+  #     packages: read
+  #     statuses: write
+  #   steps:
+  #     - name: Checkout repository
+  #       uses: actions/checkout@v4
+  #       with:
+  #         fetch-depth: 0
+
+  #     - name: Super-Linter
+  #       uses: super-linter/[email protected]
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #         POWERSHELL_CONFIG_FILE: .\PSScriptAnalyzerSettings.psd1
+  #         FILTER_REGEX_EXCLUDE: ".*compiled/.*|.*docs/.*|LICENSE"
+  #         SAVE_SUPER_LINTER_OUTPUT: true

.github/workflows/scan-secrets.yaml

@@ -1,6 +1,9 @@
 name: Scan for Secrets
 
-on: [pull_request, push]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
 
 jobs:
   secrets-scan:

.github/workflows/test.yaml

@@ -0,0 +1,59 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+    paths: ["src/**", "tests/**", ".github/workflows/test.yaml"]
+  pull_request:
+    paths: ["src/**", "tests/**", ".github/workflows/test.yaml"]
+
+jobs:
+  test-compiler:
+    runs-on: windows-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup DotNet
+        uses: actions/setup-dotnet@v4
+        with:
+          cache: true
+          dotnet-version: 8.0.x
+          cache-dependency-path: "src/Compiler/packages.lock.json"
+
+      - name: Install dependencies
+        run: dotnet restore --locked-mode -r win-x64
+
+      - name: Test & Collect lcov coverage
+        run: dotnet test --logger trx /p:CollectCoverage=true /p:CoverletOutput=Coverage/ /p:CoverletOutputFormat=lcov
+
+      - name: Upload coverage artifact
+        uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: dotnet-coverage
+          path: ./tests/Compiler/coverage.info
+
+  test-scripts:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Dependencies
+        shell: pwsh
+        run: |
+          Install-Module -Name Pester -Scope CurrentUser -Force
+
+      - name: Run Pester Tests
+        shell: pwsh
+        run: .\utils\Invoke-CodeCoverage.ps1

.gitignore

@@ -1,3 +1,7 @@
 .direnv
 obj
 bin
+Output
+coverage_report
+TestResults
+coverage.info

.vscode/extensions.json

@@ -1,11 +1,15 @@
 {
     "recommendations": [
-        "pspester.pester-test",
-        "markis.code-coverage",
         "editorconfig.editorconfig",
+        "formulahendry.code-runner",
+        "ironmansoftware.powershellprotools",
+        "markis.code-coverage",
+        "ms-dotnettools.csdevkit",
+        "ms-dotnettools.csharp",
+        "ms-vscode.powershell",
+        "pspester.pester-test",
         "ruschaaf.extended-embedded-languages",
         "tylerleonhardt.vscode-inline-values-powershell",
-        "ironmansoftware.powershellprotools",
-        "ms-vscode.powershell"
+        "vadimcn.vscode-lldb",
     ]
 }