#242 feat: Add VS Code settings integration for project.json schema support

Author: stiwicourage

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 - `project.json` now has a single authoritative JSON schema hosted at `https://www.novamoduletools.com/schema/v{major}/project.json`.
     - `Invoke-NovaBuild` exports the schema to `docs/schema/v{major}/project.json` during build, creating the directory when missing.
     - `nova init` injects `"$schema": "https://www.novamoduletools.com/schema/v{major}/project.json"` into every scaffolded project.
+    - `nova init` also writes `.vscode/settings.json` mapping `project.json` to the hosted schema URL so VS Code trusts the remote schema automatically without prompting.
     - VS Code picks up the schema automatically to provide field validation, autocomplete, and hover descriptions while editing `project.json`.
     - The two partial internal schemas (`Schema-Build.json`, `Schema-Pester.json`) are removed; `Schema-Project.json` is the new single source.
 
@@ -32,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
     - The progress text now stays simple while the bar itself reflects the real test-driven completion state.
     - The configured Pester output still flows live so `project.json` settings such as `Pester.Output.Verbosity = "Detailed"` remain visible.
 - Progress-enabled private workflows now have stronger mirrored progress-contract tests, and the repository adds a guardrail test so future `Write-Progress` workflows cannot land without matching test ownership.
+- `Package.Types` values in `project.json` now report a human-readable validation error in VS Code instead of showing the raw regex pattern. VS Code now shows the accepted values (`NuGet`, `Zip`, `.nupkg`, `.zip`) directly in the error.
 
 ### Security
 

RELEASE_NOTE.md

@@ -7,6 +7,7 @@ This file summarizes the release notes for NovaModuleTools. **UNRELEASED** chang
 ### Added
 
 - `nova init` now injects a `"$schema"` property into new projects pointing to the hosted versioned JSON schema, enabling VS Code IntelliSense, autocomplete, and hover descriptions while editing `project.json`.
+    - `nova init` also writes `.vscode/settings.json` mapping `project.json` to the schema URL so VS Code trusts it automatically — no manual "Allow" step required.
 
 ### Changed
 
@@ -24,6 +25,7 @@ This file summarizes the release notes for NovaModuleTools. **UNRELEASED** chang
 - `Publish-NovaModule` no longer loses its completion summary after local publish import or CI session refresh steps reload the module.
 - `Test-NovaBuild` and `% nova test` now keep the Nova progress display visibly active during long Pester runs instead of appearing stuck on one step while tests continue.
     - During the long Pester phase, Nova now drives the progress bar from discovered and completed Pester tests instead of elapsed time, keeps the progress text simple, and still shows configured Pester output such as `Pester.Output.Verbosity = "Detailed"`.
+- Invalid `Package.Types` values in `project.json` now show the accepted values (`NuGet`, `Zip`, `.nupkg`, `.zip`) directly in VS Code instead of the raw regex pattern.
 
 ### Security
 

docs/NovaModuleTools/en-US/Initialize-NovaModule.md

@@ -25,7 +25,7 @@ PS> Initialize-NovaModule [-Path <string>] [-Example] [-WhatIf] [-Confirm] [<Com
 
 ## DESCRIPTION
 
-`Initialize-NovaModule` creates a new project folder, the standard `src/` layout, and a starter `project.json` file.
+`Initialize-NovaModule` creates a new project folder, the standard `src/` layout, a starter `project.json` file, and a `.vscode/settings.json` entry that maps `project.json` to the versioned JSON schema so VS Code provides IntelliSense without a manual trust prompt.
 
 The standard scaffold `project.json` includes Nova's standard Pester defaults, including an opt-in `CodeCoverage` block with `Enabled=false`, common `src/` coverage paths, JaCoCo output in `artifacts/coverage.xml`, and a `90` percent target that can be enabled later.
 

docs/project-json-reference.html

@@ -206,11 +206,13 @@ <h2>Top-level project settings</h2>
                 <div class="notice">
                     <strong>VS Code IntelliSense.</strong>
                     <p>When <code>nova init</code> scaffolds a new project, it injects a <code>$schema</code> field
-                        that points to the versioned public schema at
-                        <code>https://www.novamoduletools.com/schema/v{major}/project.json</code>. VS Code picks this
-                        up automatically to provide field validation, autocomplete, and hover descriptions while you
-                        edit <code>project.json</code>. You can add the field manually to any existing project by
-                        inserting it as the first key in the file.</p>
+                        pointing to the versioned public schema at
+                        <code>https://www.novamoduletools.com/schema/v{major}/project.json</code>, and also writes a
+                        <code>.vscode/settings.json</code> entry that maps <code>project.json</code> to the same URL.
+                        Together these two outputs let VS Code load the schema and provide IntelliSense, field
+                        validation, and hover descriptions without a manual trust prompt. To enable this on an existing
+                        project, add the <code>$schema</code> field as the first key in <code>project.json</code> and
+                        add the matching <code>json.schemas</code> entry to <code>.vscode/settings.json</code>.</p>
                 </div>
                 <div class="table-scroll">
                     <table>

docs/schema/v3/project.json

@@ -130,7 +130,8 @@
           "description": "List of package types to produce.",
           "items": {
             "type": "string",
-            "pattern": "^(?:[Nn][Uu][Gg][Ee][Tt]|[Zz][Ii][Pp]|\\.[Nn][Uu][Pp][Kk][Gg]|\\.[Zz][Ii][Pp])$"
+            "enum": ["NuGet", "Zip", ".nupkg", ".zip"],
+            "description": "Valid values: NuGet, Zip, .nupkg, .zip (case-insensitive at runtime)."
           }
         },
         "Latest": {

src/private/scaffold/InvokeNovaModuleInitializationWorkflow.ps1

@@ -15,6 +15,10 @@ function Invoke-NovaModuleInitializationWorkflow {
             Write-NovaModuleProjectJson -Answer $WorkflowContext.AnswerSet -ProjectJsonFile $WorkflowContext.Layout.ProjectJsonFile -Example:$WorkflowContext.Example
         }
 
+        Invoke-NovaModuleInitializationStep -Activity $progressActivity -Status 'Writing VS Code settings' -PercentComplete 75 -Action {
+            Write-NovaVsCodeSettings -ProjectRoot $WorkflowContext.Layout.Project
+        }
+
         if ($WorkflowContext.AnswerSet.EnableAgenticCopilot -eq 'Yes') {
             Invoke-NovaModuleInitializationStep -Activity $progressActivity -Status 'Applying Agentic Copilot starter' -PercentComplete 85 -Action {
                 Initialize-NovaModuleAgenticCopilotScaffold -Answer $WorkflowContext.AnswerSet -ProjectRoot $WorkflowContext.Layout.Project -Example:$WorkflowContext.Example

src/private/scaffold/WriteNovaVsCodeSettings.ps1

@@ -0,0 +1,67 @@
+function Write-NovaVsCodeSettings {
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification = 'VS Code settings is the domain term for the .vscode/settings.json file.')]
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory)][string]$ProjectRoot
+    )
+
+    $moduleVersion = $ExecutionContext.SessionState.Module.Version
+    if ($null -eq $moduleVersion) { return }
+
+    $schemaUrl = "https://www.novamoduletools.com/schema/v$($moduleVersion.Major)/project.json"
+    $vsCodeDir = Join-Path $ProjectRoot '.vscode'
+    $settingsFile = Join-Path $vsCodeDir 'settings.json'
+
+    if (Test-Path -LiteralPath $settingsFile) {
+        Add-NovaVsCodeJsonSchemaEntry -SettingsFile $settingsFile -SchemaUrl $schemaUrl
+    } else {
+        New-NovaVsCodeSettingsFile -VsCodeDir $vsCodeDir -SettingsFile $settingsFile -SchemaUrl $schemaUrl
+    }
+}
+
+function Add-NovaVsCodeJsonSchemaEntry {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory)][string]$SettingsFile,
+        [Parameter(Mandatory)][string]$SchemaUrl
+    )
+
+    $settings = Get-Content -LiteralPath $SettingsFile -Raw | ConvertFrom-Json -AsHashtable
+    if (-not $settings) { $settings = @{} }
+    if (-not $settings.ContainsKey('json.schemas')) { $settings['json.schemas'] = @() }
+
+    $schemas = @($settings['json.schemas'])
+    $alreadyMapped = $schemas | Where-Object {
+        $fm = Resolve-NovaFileMatchArray $_
+        ($fm -contains '/project.json') -or ($fm -contains 'project.json')
+    }
+    if ($alreadyMapped) { return }
+
+    $settings['json.schemas'] = $schemas + @{ fileMatch = @('/project.json'); url = $SchemaUrl }
+    $settings | ConvertTo-Json -Depth 10 | Set-Content -LiteralPath $SettingsFile -Encoding utf8NoBOM
+}
+
+function Resolve-NovaFileMatchArray {
+    [CmdletBinding()]
+    param($Entry)
+
+    $raw = if ($Entry -is [hashtable]) { $Entry['fileMatch'] } else { $Entry.fileMatch }
+    return @($raw)
+}
+
+function New-NovaVsCodeSettingsFile {
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '', Justification = 'Private file-writing helper. ShouldProcess is managed at the public Initialize-NovaModule command level.')]
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory)][string]$VsCodeDir,
+        [Parameter(Mandatory)][string]$SettingsFile,
+        [Parameter(Mandatory)][string]$SchemaUrl
+    )
+
+    if (-not (Test-Path -LiteralPath $VsCodeDir)) {
+        New-Item -ItemType Directory -Path $VsCodeDir | Out-Null
+    }
+    @{ 'json.schemas' = @(@{ fileMatch = @('/project.json'); url = $SchemaUrl }) } |
+        ConvertTo-Json -Depth 10 |
+        Set-Content -LiteralPath $SettingsFile -Encoding utf8NoBOM
+}

src/resources/Schema-Project.json

@@ -130,7 +130,8 @@
           "description": "List of package types to produce.",
           "items": {
             "type": "string",
-            "pattern": "^(?:[Nn][Uu][Gg][Ee][Tt]|[Zz][Ii][Pp]|\\.[Nn][Uu][Pp][Kk][Gg]|\\.[Zz][Ii][Pp])$"
+            "enum": ["NuGet", "Zip", ".nupkg", ".zip"],
+            "description": "Valid values: NuGet, Zip, .nupkg, .zip (case-insensitive at runtime)."
           }
         },
         "Latest": {

tests/private/scaffold/InvokeNovaModuleInitializationWorkflow.TestSupport.ps1

@@ -1,4 +1,5 @@
 function Initialize-NovaModuleScaffold {param($Answer, $Paths, [switch]$Example)}
 function Write-NovaModuleProjectJson {param($Answer, [string]$ProjectJsonFile, [switch]$Example)}
+function Write-NovaVsCodeSettings {param([string]$ProjectRoot)}
 function Initialize-NovaModuleAgenticCopilotScaffold {param($Answer, [string]$ProjectRoot, [switch]$Example)}
 function Write-Message {param([Parameter(ValueFromPipeline = $true)]$InputObject, [string]$color)}

tests/private/scaffold/InvokeNovaModuleInitializationWorkflow.Tests.ps1

@@ -17,6 +17,7 @@ Describe 'Invoke-NovaModuleInitializationWorkflow' {
     It 'initializes the scaffold and writes the project.json before announcing completion' {
         Mock Initialize-NovaModuleScaffold {}
         Mock Write-NovaModuleProjectJson {}
+        Mock Write-NovaVsCodeSettings {}
         Mock Initialize-NovaModuleAgenticCopilotScaffold {}
         Mock Write-Message {}
         Mock Write-Progress {}
@@ -25,14 +26,18 @@ Describe 'Invoke-NovaModuleInitializationWorkflow' {
 
         Assert-MockCalled Initialize-NovaModuleScaffold -Times 1
         Assert-MockCalled Write-NovaModuleProjectJson -Times 1
+        Assert-MockCalled Write-NovaVsCodeSettings -Times 1 -ParameterFilter { $ProjectRoot -eq '/tmp/DemoModule' }
         Assert-MockCalled Initialize-NovaModuleAgenticCopilotScaffold -Times 0
-        Assert-MockCalled Write-Progress -Times 3
+        Assert-MockCalled Write-Progress -Times 4
         Assert-MockCalled Write-Progress -Times 1 -ParameterFilter {
             $Status -eq 'Creating scaffold files' -and $PercentComplete -eq 25
         }
         Assert-MockCalled Write-Progress -Times 1 -ParameterFilter {
             $Status -eq 'Writing project.json' -and $PercentComplete -eq 60
         }
+        Assert-MockCalled Write-Progress -Times 1 -ParameterFilter {
+            $Status -eq 'Writing VS Code settings' -and $PercentComplete -eq 75
+        }
         Assert-MockCalled Write-Progress -Times 1 -ParameterFilter {$Completed}
         Assert-MockCalled Write-Message -Times 4
         Assert-MockCalled Write-Message -Times 1 -ParameterFilter {
@@ -46,6 +51,7 @@ Describe 'Invoke-NovaModuleInitializationWorkflow' {
     It 'invokes the Agentic Copilot scaffold step when the answer set requests it' {
         Mock Initialize-NovaModuleScaffold {}
         Mock Write-NovaModuleProjectJson {}
+        Mock Write-NovaVsCodeSettings {}
         Mock Initialize-NovaModuleAgenticCopilotScaffold {}
         Mock Write-Message {}
         Mock Write-Progress {}
@@ -58,7 +64,7 @@ Describe 'Invoke-NovaModuleInitializationWorkflow' {
         Invoke-NovaModuleInitializationWorkflow -WorkflowContext $contextWithAgentic
 
         Assert-MockCalled Initialize-NovaModuleAgenticCopilotScaffold -Times 1
-        Assert-MockCalled Write-Progress -Times 4
+        Assert-MockCalled Write-Progress -Times 5
         Assert-MockCalled Write-Progress -Times 1 -ParameterFilter {
             $Status -eq 'Applying Agentic Copilot starter' -and $PercentComplete -eq 85
         }
@@ -68,6 +74,7 @@ Describe 'Invoke-NovaModuleInitializationWorkflow' {
     It 'suggests Test-NovaBuild as the next step for the example scaffold' {
         Mock Initialize-NovaModuleScaffold {}
         Mock Write-NovaModuleProjectJson {}
+        Mock Write-NovaVsCodeSettings {}
         Mock Initialize-NovaModuleAgenticCopilotScaffold {}
         Mock Write-Message {}
         Mock Write-Progress {}