Skip to main content

Build System and Validation

Plugin Generation Pipeline

The plugin generation pipeline transforms collection manifests into distributable plugin output. It runs in three stages:

  1. Generate-Plugins.ps1 reads each collections/*.collection.yml manifest and produces output files under plugins/. Each collection gets its own subdirectory (e.g., plugins/hve-core/, plugins/ado/).

  2. lint:md:fix applies markdownlint auto-fixes to generated markdown files.

  3. format:tables aligns markdown table columns in generated output.

Run the full pipeline with a single command:

npm run plugin:generate

IMPORTANT

Files under plugins/ are generated output. Do not edit them directly. Changes made to plugin files are overwritten on the next generation run.

Schema Validation System

YAML frontmatter in markdown files is validated against JSON schemas stored in scripts/linting/schemas/. The validation system uses glob-based pattern matching to determine which schema applies to each file.

Schema Files

SchemaApplies To
docs-frontmatter.schema.jsondocs/**/*.md
instruction-frontmatter.schema.json.github/**/*.instructions.md
agent-frontmatter.schema.json.github/**/*.agent.md
prompt-frontmatter.schema.json.github/**/*.prompt.md
skill-frontmatter.schema.json.github/skills/**/SKILL.md
chatmode-frontmatter.schema.json.github/**/*.chatmode.md
collection-manifest.schema.jsonCollection YAML manifests
root-community-frontmatter.schema.jsonRoot files (README, CONTRIBUTING)
base-frontmatter.schema.jsonDefault fallback

Pattern Mapping

The scripts/linting/schemas/schema-mapping.json file defines the glob-to-schema mapping. Patterns are evaluated from most specific to least specific, and the first match determines the schema. When no pattern matches, base-frontmatter.schema.json applies as the default.

Adding Custom Schemas

To add validation for a new file type:

  1. Create a JSON schema file in scripts/linting/schemas/
  2. Add a mapping entry to schema-mapping.json with the glob pattern, scope name, and schema filename
  3. Run npm run lint:frontmatter to verify the new schema validates correctly

npm Scripts Reference

All validation, formatting, and testing operations run through npm scripts defined in package.json. The table below groups scripts by purpose.

Linting

ScriptCommandDescription
lint:allnpm run lint:allRuns all linters in sequence
lint:mdnpm run lint:mdMarkdown linting via markdownlint-cli2
lint:md:fixnpm run lint:md:fixMarkdown linting with auto-fix
lint:psnpm run lint:psPowerShell analysis via PSScriptAnalyzer
lint:yamlnpm run lint:yamlYAML syntax and structure validation
lint:linksnpm run lint:linksLink language checking
lint:md-linksnpm run lint:md-linksMarkdown link target validation
lint:frontmatternpm run lint:frontmatterFrontmatter schema validation
lint:collections-metadatanpm run lint:collections-metadataCollection manifest validation
lint:marketplacenpm run lint:marketplaceMarketplace manifest validation
lint:version-consistencynpm run lint:version-consistencyGitHub Action version consistency
lint:permissionsnpm run lint:permissionsWorkflow permissions validation

Validation

ScriptCommandDescription
validate:copyrightnpm run validate:copyrightCopyright header presence check
validate:skillsnpm run validate:skillsSkill directory structure validation

Formatting

ScriptCommandDescription
format:tablesnpm run format:tablesMarkdown table column alignment

Testing

ScriptCommandDescription
test:psnpm run test:psPowerShell Pester test suite

Plugin and Extension

ScriptCommandDescription
plugin:generatenpm run plugin:generateGenerate plugins, auto-fix markdown, format tables
plugin:validatenpm run plugin:validateValidate collection metadata (alias)
extension:preparenpm run extension:preparePrepare VS Code extension for packaging
extension:prepare:prereleasenpm run extension:prepare:prereleasePrepare extension for pre-release
extension:packagenpm run extension:packagePackage VS Code extension
extension:package:prereleasenpm run extension:package:prereleasePackage extension as pre-release

Linting Pipeline

The lint:all script chains every linter in a fixed sequence:

  1. format:tables aligns markdown table columns
  2. lint:md checks markdown style rules (.markdownlint.json)
  3. lint:ps analyzes PowerShell scripts (PSScriptAnalyzer.psd1)
  4. lint:yaml validates YAML file syntax
  5. lint:links checks link text language patterns
  6. lint:frontmatter validates YAML frontmatter against schemas
  7. lint:collections-metadata confirms collection manifest integrity
  8. lint:marketplace validates marketplace manifest
  9. lint:version-consistency checks GitHub Action version alignment
  10. lint:permissions validates workflow permissions
  11. validate:skills verifies skill directory structure

Each linter outputs results to logs/ for inspection. Run individual linters for faster feedback during development:

npm run lint:md -- docs/customization/collections.md

CI Validation

Pull request validation runs linters in parallel CI jobs. Each job executes one or more npm scripts from the list above. To reproduce CI checks locally, run the same npm scripts against your changed files.

Full local validation:

npm run lint:all

Targeted validation for specific files:

npm run lint:md -- path/to/changed-file.md
npm run lint:frontmatter

TIP

Run lint:all before pushing to catch issues that CI would flag. Individual linters provide faster feedback when you know which validation applies to your changes.

Customizing Validation

Markdown Rules

Configure markdownlint rules in .markdownlint.json at the repository root. Each rule maps to a markdownlint rule ID (e.g., MD013 for line length). Disable rules by setting them to false, or customize parameters such as line length limits.

PowerShell Analysis

PSScriptAnalyzer rules are configured in scripts/linting/PSScriptAnalyzer.psd1. Add or exclude rules to match your team's PowerShell coding standards. Run analysis with:

npm run lint:ps

Results appear in logs/psscriptanalyzer-results.json and logs/psscriptanalyzer-summary.json.

Custom Validation Scripts

Add new validation scripts to scripts/linting/ and register them as npm scripts in package.json. Follow the existing pattern: scripts accept file paths or glob patterns as input and write structured results to logs/.

To include a new linter in the full pipeline, add it to the lint:all chain in package.json.

Role Scenarios

Northwind Traders' SRE/Operations lead runs npm run lint:all as a pre-push hook to catch markdown formatting issues, broken links, and frontmatter schema violations before they reach CI. When a new deployment instruction file needs custom frontmatter fields, the lead adds a schema to scripts/linting/schemas/ and registers the pattern in schema-mapping.json.

Adventure Works' security architect extends the validation pipeline with a custom script that checks instruction files for required security disclaimer sections. The script follows the existing pattern of writing JSON results to logs/ and integrates into the lint:all chain through package.json.

🤖 Crafted with precision by ✨Copilot following brilliant human instruction, then carefully refined by our team of discerning human reviewers.