Skip to content

feat(tests): add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter (#197, #198) #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WilliamBerryiii wants to merge 12 commits into
base: main
Choose a base branch
from
+2,324 −341
Open

feat(tests): add Pester tests for LintingHelpers and Validate-MarkdownFrontmatter (#197, #198) #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
27055c0
test(scripts): add Pester tests for LintingHelpers module
WilliamBerryiii Jan 17, 2026
1bf1d17
test(scripts): address Copilot review feedback for LintingHelpers tests
WilliamBerryiii Jan 17, 2026
0db187b
refactor(scripts): add typed returns and testability to Validate-Mark…
WilliamBerryiii Jan 17, 2026
81bf3d2
feat(tests): add Pester tests for Validate-MarkdownFrontmatter (#198)
WilliamBerryiii Jan 18, 2026
773ec64
test(scripts): add test:ps npm script and Initialize-JsonSchemaValida…
WilliamBerryiii Jan 18, 2026
7586783
feat(build): add ExcludePaths to frontmatter validation for test fixt…
WilliamBerryiii Jan 18, 2026
601eab6
style(docs): apply markdown table formatting
WilliamBerryiii Jan 18, 2026
b346393
fix(build): exclude test fixtures from CI frontmatter validation
WilliamBerryiii Jan 18, 2026
8eec8cb
fix(build): use recursive glob pattern for test fixture exclusions
WilliamBerryiii Jan 19, 2026
5a69873
fix(build): apply ExcludePaths filter in Files processing branch
WilliamBerryiii Jan 19, 2026
8b19d31
refactor(scripts): address code review feedback
WilliamBerryiii Jan 19, 2026
f875cbb
fix(scripts): restore UTF-8 BOM for PSScriptAnalyzer compliance
WilliamBerryiii Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/frontmatter-validation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ jobs:
$params['WarningsAsErrors'] = $true
}

# Exclude test fixture files (intentionally invalid frontmatter for testing)
$params['ExcludePaths'] = @('scripts/tests/Fixtures/**')

& scripts/linting/Validate-MarkdownFrontmatter.ps1 @params
continue-on-error: true

Expand Down
3 changes: 2 additions & 1 deletion .markdownlint-cli2.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"**/node_modules/**",
"**/packages/**",
".copilot-tracking/**",
"venv/**"
"venv/**",
"scripts/tests/Fixtures/**"
]
}
12 changes: 6 additions & 6 deletions docs/contributing/ai-artifacts-common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,12 @@ The maturity field controls which extension channel includes the artifact:

### Valid Values

| Value | Description | Stable Channel | Pre-release Channel |
|----------------|--------------------------------------------------|----------------|---------------------|
| `stable` | Production-ready, fully tested | ✅ Included | ✅ Included |
| `preview` | Feature-complete, may have rough edges | ❌ Excluded | ✅ Included |
| `experimental` | Early development, may change significantly | ❌ Excluded | ✅ Included |
| `deprecated` | Scheduled for removal | ❌ Excluded | ❌ Excluded |
| Value | Description | Stable Channel | Pre-release Channel |
|----------------|---------------------------------------------|----------------|---------------------|
| `stable` | Production-ready, fully tested | ✅ Included | ✅ Included |
| `preview` | Feature-complete, may have rough edges | ❌ Excluded | ✅ Included |
| `experimental` | Early development, may change significantly | ❌ Excluded | ✅ Included |
| `deprecated` | Scheduled for removal | ❌ Excluded | ❌ Excluded |

### Default for New Contributions

Expand Down
32 changes: 16 additions & 16 deletions docs/contributing/branch-protection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,27 @@ Branch protection rules ensure code quality and security by requiring:

The following CI jobs must pass before a PR can be merged:

| Check Name | Purpose |
| ---------------------------- | ------------------------------------- |
| Spell Check | Validates spelling in markdown |
| Markdown Lint | Enforces markdown formatting |
| Table Format Check | Validates table formatting |
| PowerShell Lint | PSScriptAnalyzer validation |
| Frontmatter Validation | Validates YAML frontmatter |
| Validate Dependency Pinning | Ensures dependencies are pinned |
| npm Security Audit | Scans for vulnerable dependencies |
| CodeQL Security Analysis | Security vulnerability scanning |
| Check Name | Purpose |
|-----------------------------|-----------------------------------|
| Spell Check | Validates spelling in markdown |
| Markdown Lint | Enforces markdown formatting |
| Table Format Check | Validates table formatting |
| PowerShell Lint | PSScriptAnalyzer validation |
| Frontmatter Validation | Validates YAML frontmatter |
| Validate Dependency Pinning | Ensures dependencies are pinned |
| npm Security Audit | Scans for vulnerable dependencies |
| CodeQL Security Analysis | Security vulnerability scanning |

**Note**: `Markdown Link Check` uses soft-fail and is not a required check.

## Review Requirements

| Setting | Value | Rationale |
| -------------------- | ------- | -------------------------------------------- |
| Required reviewers | 1 | Team size decision |
| Dismiss stale reviews| Enabled | Prevents post-approval malicious commits |
| Last push approval | Enabled | Requires non-author approval of final changes|
| Code owner review | Enabled | Ensures domain experts review changes |
| Setting | Value | Rationale |
|-----------------------|---------|-----------------------------------------------|
| Required reviewers | 1 | Team size decision |
| Dismiss stale reviews | Enabled | Prevents post-approval malicious commits |
| Last push approval | Enabled | Requires non-author approval of final changes |
| Code owner review | Enabled | Ensures domain experts review changes |

## CODEOWNERS

Expand Down
20 changes: 10 additions & 10 deletions docs/contributing/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,21 +131,21 @@ The VS Code extension is published to two channels with different stability expe

### Extension Channels

| Channel | Stability | Included Maturity Levels | Audience |
|------------|-----------------|-------------------------------------|-------------------|
| Stable | Production-ready | `stable` only | All users |
| Pre-release | Early access | `stable`, `preview`, `experimental` | Early adopters |
| Channel | Stability | Included Maturity Levels | Audience |
|-------------|------------------|-------------------------------------|----------------|
| Stable | Production-ready | `stable` only | All users |
| Pre-release | Early access | `stable`, `preview`, `experimental` | Early adopters |

### Maturity Levels

Each prompt, instruction, and chatmode declares a `maturity` field in its frontmatter:

| Level | Description | Included In |
|----------------|--------------------------------------------------|-------------------|
| `stable` | Production-ready, fully tested | Stable, Pre-release |
| `preview` | Feature-complete but may have rough edges | Pre-release only |
| `experimental` | Early development, may change significantly | Pre-release only |
| `deprecated` | Scheduled for removal, excluded from all builds | Neither |
| Level | Description | Included In |
|----------------|-------------------------------------------------|---------------------|
| `stable` | Production-ready, fully tested | Stable, Pre-release |
| `preview` | Feature-complete but may have rough edges | Pre-release only |
| `experimental` | Early development, may change significantly | Pre-release only |
| `deprecated` | Scheduled for removal, excluded from all builds | Neither |

### Maturity Lifecycle

Expand Down
18 changes: 9 additions & 9 deletions docs/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ For customization or version control, see [Installing HVE-Core](install.md) to c

HVE-Core supports seven installation methods. See the [installation guide](install.md) for a decision matrix to help you choose:

| Method | Best For |
|---------------------------------------------------|--------------------------------|
| [VS Code Extension](methods/extension.md) ⭐ | Simplest, no config needed |
| [Multi-Root Workspace](methods/multi-root.md) | Any environment, portable |
| [Submodule](methods/submodule.md) | Teams needing version control |
| [Peer Directory Clone](methods/peer-clone.md) | Local VS Code, solo |
| [Git-Ignored Folder](methods/git-ignored.md) | Local devcontainer, solo |
| [Mounted Directory](methods/mounted.md) | Advanced devcontainer sharing |
| [GitHub Codespaces](methods/codespaces.md) | Codespaces-only projects |
| Method | Best For |
|-----------------------------------------------|-------------------------------|
| [VS Code Extension](methods/extension.md) ⭐ | Simplest, no config needed |
| [Multi-Root Workspace](methods/multi-root.md) | Any environment, portable |
| [Submodule](methods/submodule.md) | Teams needing version control |
| [Peer Directory Clone](methods/peer-clone.md) | Local VS Code, solo |
| [Git-Ignored Folder](methods/git-ignored.md) | Local devcontainer, solo |
| [Mounted Directory](methods/mounted.md) | Advanced devcontainer sharing |
| [GitHub Codespaces](methods/codespaces.md) | Codespaces-only projects |

## Verifying Setup

Expand Down
36 changes: 18 additions & 18 deletions docs/getting-started/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,17 @@ Answer these questions to find your recommended installation method:

### Decision Matrix

| Environment | Team | Updates | Recommended Method |
|---------------------------|------|------------|-------------------------------------------------|
| **Any** (simplest) | Any | Auto | [VS Code Extension](methods/extension.md) ⭐ |
| Local (no container) | Solo | Manual | [Peer Directory Clone](methods/peer-clone.md) |
| Local (no container) | Team | Controlled | [Submodule](methods/submodule.md) |
| Local devcontainer | Solo | Auto | [Git-Ignored Folder](methods/git-ignored.md) |
| Local devcontainer | Team | Controlled | [Submodule](methods/submodule.md) |
| Codespaces only | Solo | Auto | [GitHub Codespaces](methods/codespaces.md) |
| Codespaces only | Team | Controlled | [Submodule](methods/submodule.md) |
| Both local + Codespaces | Any | Any | [Multi-Root Workspace](methods/multi-root.md) |
| Advanced (shared install) | Solo | Auto | [Mounted Directory](methods/mounted.md) |
| Environment | Team | Updates | Recommended Method |
|---------------------------|------|------------|-----------------------------------------------|
| **Any** (simplest) | Any | Auto | [VS Code Extension](methods/extension.md) ⭐ |
| Local (no container) | Solo | Manual | [Peer Directory Clone](methods/peer-clone.md) |
| Local (no container) | Team | Controlled | [Submodule](methods/submodule.md) |
| Local devcontainer | Solo | Auto | [Git-Ignored Folder](methods/git-ignored.md) |
| Local devcontainer | Team | Controlled | [Submodule](methods/submodule.md) |
| Codespaces only | Solo | Auto | [GitHub Codespaces](methods/codespaces.md) |
| Codespaces only | Team | Controlled | [Submodule](methods/submodule.md) |
| Both local + Codespaces | Any | Any | [Multi-Root Workspace](methods/multi-root.md) |
| Advanced (shared install) | Solo | Auto | [Mounted Directory](methods/mounted.md) |

⭐ **VS Code Extension** is the recommended method for most users who don't need customization.

Expand Down Expand Up @@ -109,18 +109,18 @@ Answer these questions to find your recommended installation method:

### Simplest Method (Recommended for Most Users)

| Method | Best For | Complexity |
|-----------------------------------------------|------------------------------------|------------|
| [VS Code Extension](methods/extension.md) ⭐ | Anyone wanting zero-config setup | Minimal |
| Method | Best For | Complexity |
|---------------------------------------------|----------------------------------|------------|
| [VS Code Extension](methods/extension.md) ⭐ | Anyone wanting zero-config setup | Minimal |

### Consumer Methods (Customization + Version Control)

These methods are for projects that want to use and potentially customize HVE-Core's components:

| Method | Best For | Complexity |
|---------------------------------------------------|-------------------------------|------------|
| [Multi-Root Workspace](methods/multi-root.md) | Any environment, portable | Low |
| [Submodule](methods/submodule.md) | Teams needing version control | Medium |
| Method | Best For | Complexity |
|-----------------------------------------------|-------------------------------|------------|
| [Multi-Root Workspace](methods/multi-root.md) | Any environment, portable | Low |
| [Submodule](methods/submodule.md) | Teams needing version control | Medium |

### Developer Methods

Expand Down
30 changes: 15 additions & 15 deletions docs/getting-started/methods/extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,12 @@ HVE-Core chatmodes create ephemeral workflow artifacts in a `.copilot-tracking/`

The extension provides all HVE-Core components:

| Component | Examples |
|--------------|-----------------------------------------------|
| Chat Agents | task-planner, pr-review, adr-creation |
| Prompts | git-commit, pull-request, ado-create-pr |
| Instructions | markdown, python-script, commit-message |
| Dev Tools | Generate-PrReference.ps1, pr-ref-gen.sh |
| Component | Examples |
|--------------|-----------------------------------------|
| Chat Agents | task-planner, pr-review, adr-creation |
| Prompts | git-commit, pull-request, ado-create-pr |
| Instructions | markdown, python-script, commit-message |
| Dev Tools | Generate-PrReference.ps1, pr-ref-gen.sh |

## Updating

Expand Down Expand Up @@ -254,15 +254,15 @@ If you need customization:

## Limitations

| Aspect | Status |
|------------------|-------------------------------------------------------------|
| Customization | ❌ Cannot modify components |
| Version control | ⚠️ Extension updates only, no git control |
| Team enforcement | ⚠️ Each member installs independently |
| Dev/testing | ⚠️ Pre-release channel only, not custom branches |
| Portable paths | ✅ Works everywhere |
| Setup complexity | ✅ Simplest possible |
| Disk usage | ✅ Single installation across all projects |
| Aspect | Status |
|------------------|--------------------------------------------------|
| Customization | ❌ Cannot modify components |
| Version control | ⚠️ Extension updates only, no git control |
| Team enforcement | ⚠️ Each member installs independently |
| Dev/testing | ⚠️ Pre-release channel only, not custom branches |
| Portable paths | ✅ Works everywhere |
| Setup complexity | ✅ Simplest possible |
| Disk usage | ✅ Single installation across all projects |

## Next Steps

Expand Down
26 changes: 13 additions & 13 deletions extension/PACKAGING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Install-Module -Name PowerShell-Yaml -Scope CurrentUser

The extension is automatically packaged and published through GitHub Actions:

| Workflow | Trigger | Purpose |
|--------------------------------------------|-------------------|---------------------------------------------|
| `.github/workflows/extension-package.yml` | Reusable workflow | Packages extension with flexible versioning |
| `.github/workflows/extension-publish.yml` | Release/manual | Publishes to VS Code Marketplace |
| `.github/workflows/main.yml` | Push to main | Includes extension packaging in CI |
| Workflow | Trigger | Purpose |
|-------------------------------------------|-------------------|---------------------------------------------|
| `.github/workflows/extension-package.yml` | Reusable workflow | Packages extension with flexible versioning |
| `.github/workflows/extension-publish.yml` | Release/manual | Publishes to VS Code Marketplace |
| `.github/workflows/main.yml` | Push to main | Includes extension packaging in CI |

## Packaging the Extension

Expand Down Expand Up @@ -196,10 +196,10 @@ The extension supports dual-channel publishing to VS Code Marketplace with separ

### EVEN/ODD Versioning Strategy

| Minor Version | Channel | Example | Agent Maturity Included |
|---------------|--------------|----------|-----------------------------------|
| EVEN (0, 2, 4...)| Stable | 1.0.0, 1.2.0 | `stable` only |
| ODD (1, 3, 5...) | Pre-Release| 1.1.0, 1.3.0 | `stable`, `preview`, `experimental` |
| Minor Version | Channel | Example | Agent Maturity Included |
|-------------------|-------------|--------------|-------------------------------------|
| EVEN (0, 2, 4...) | Stable | 1.0.0, 1.2.0 | `stable` only |
| ODD (1, 3, 5...) | Pre-Release | 1.1.0, 1.3.0 | `stable`, `preview`, `experimental` |

Users can switch between channels in VS Code via the "Switch to Pre-Release Version" button on the extension page.

Expand Down Expand Up @@ -233,10 +233,10 @@ The workflow validates the version is ODD before proceeding.

When packaging, agents and chatmodes are filtered by their `maturity` frontmatter field:

| Channel | Included Maturity Levels |
|-------------|----------------------------------------|
| Stable | `stable` |
| PreRelease | `stable`, `preview`, `experimental` |
| Channel | Included Maturity Levels |
|------------|-------------------------------------|
| Stable | `stable` |
| PreRelease | `stable`, `preview`, `experimental` |

See [Agent Maturity Levels](../docs/contributing/ai-artifacts-common.md#maturity-field-requirements) for contributor guidance on setting maturity levels.

Expand Down
8 changes: 4 additions & 4 deletions extension/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@ Prompts are available in the Copilot Chat prompt picker and can be used to gener

HVE Core offers two installation channels:

| Channel | Description | Maturity Levels |
|-------------|----------------------------------------------------------|-------------------------------------|
| Stable | Production-ready artifacts only | `stable` |
| Pre-release | Early access to new features and experimental artifacts | `stable`, `preview`, `experimental` |
| Channel | Description | Maturity Levels |
|-------------|---------------------------------------------------------|-------------------------------------|
| Stable | Production-ready artifacts only | `stable` |
| Pre-release | Early access to new features and experimental artifacts | `stable`, `preview`, `experimental` |

To install the pre-release version, select **Install Pre-Release Version** from the extension page in VS Code, or use the Extensions view and switch to the pre-release channel.

Expand Down
Loading
Loading