Skip to content

feat(1004): add OutputPath parameter to Invoke-LinkLanguageCheck.ps1#1229

Merged
WilliamBerryiii merged 7 commits into
microsoft:mainfrom
PratikWayase:feat/1004-add-outputpath-param
Apr 6, 2026
Merged

feat(1004): add OutputPath parameter to Invoke-LinkLanguageCheck.ps1#1229
WilliamBerryiii merged 7 commits into
microsoft:mainfrom
PratikWayase:feat/1004-add-outputpath-param

Conversation

@PratikWayase

Copy link
Copy Markdown
Contributor

Description

This PR adds an -OutputPath parameter to Invoke-LinkLanguageCheck.ps1 to enable callers to redirect the JSON results file without modifying the script.

Changes:

  • Added -OutputPath parameter with default value "logs/link-lang-check-results.json" (maintains backward compatibility)
  • Replaced hardcoded output path references with $OutputPath parameter
  • Updated comment-based help to document the new parameter
  • Added comprehensive Pester tests verifying:
    • Default path behavior (writes to logs/link-lang-check-results.json)
    • Custom path behavior (writes to specified location)
    • Parent directory auto-creation for nested custom paths
    • Output file contains valid JSON structure
  • Fixed PSScriptAnalyzer warning: removed unused $repoRoot variable assignment

Impact: Improves script reusability, testability, and flexibility for CI/CD pipelines without breaking existing invocations.

Related Issue(s)

Closes #1004

Type of Change

Select all that apply:

Code & Documentation:

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature causing existing functionality to change)
  • Documentation update

Infrastructure & Configuration:

  • GitHub Actions workflow
  • Linting configuration (markdown, PowerShell, etc.)
  • Security configuration
  • DevContainer configuration
  • Dependency update

AI Artifacts:

  • Reviewed contribution with prompt-builder agent and addressed all feedback
  • Copilot instructions (.github/instructions/*.instructions.md)
  • Copilot prompt (.github/prompts/*.prompt.md)
  • Copilot agent (.github/agents/*.agent.md)
  • Copilot skill (.github/skills/*/SKILL.md)

Other:

  • Script/automation (.ps1, .sh, .py)
  • Other (please describe):

Testing

Unit Tests:

  • Ran Invoke-Pester -Path "scripts/tests/linting/Invoke-LinkLanguageCheck.Tests.ps1" — 32/32 tests pass
  • Verified default path: script writes to logs/link-lang-check-results.json when -OutputPath omitted
  • Verified custom path: script writes to specified location when -OutputPath provided
  • Verified directory creation: parent directories auto-created for nested custom paths
  • Verified JSON output: file contains valid structure with timestamp, script, summary, and issues fields

Linting:

  • Ran npm run lint:ps — PSScriptAnalyzer passes with no warnings
  • Verified comment-based help is properly formatted

@PratikWayase PratikWayase requested a review from a team as a code owner March 29, 2026 18:00

@katriendg katriendg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @PratikWayase for your contribution.
Two small comments I believe we could update before merging?

Comment thread scripts/tests/linting/Invoke-LinkLanguageCheck.Tests.ps1 Outdated
Comment thread scripts/tests/linting/Invoke-LinkLanguageCheck.Tests.ps1 Outdated

@katriendg katriendg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Four issues found — one is a broken test that needs to be fixed before merging:

  1. High (tests): -OutputPath is commented out in the "writes to custom path" test — it never exercises the custom path and the assertion will fail.
  2. Medium (script): git rev-parse --show-toplevel is called twice — first with output discarded, then again to capture the value. Consolidate to a single call.
  3. Low (script): Duplicate $OutputPath default in the inner function param block — single source of truth violated.
  4. Low (script): No guard for an empty $outputDir when $OutputPath is a bare filename — New-Item -Path "" will throw.

Comment thread scripts/linting/Invoke-LinkLanguageCheck.ps1
Comment thread scripts/linting/Invoke-LinkLanguageCheck.ps1
Comment thread scripts/linting/Invoke-LinkLanguageCheck.ps1
Comment thread scripts/tests/linting/Invoke-LinkLanguageCheck.Tests.ps1
- correct indentation for if-block bodies in Invoke-LinkLanguageCheck.ps1
- pass explicit -OutputPath to existing tests after inner function default removal

🔧 - Generated by Copilot
@codecov-commenter

codecov-commenter commented Apr 6, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 90.90909% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 87.72%. Comparing base (ce0e531) to head (d39e86d).
⚠️ Report is 24 commits behind head on main.

Files with missing lines Patch % Lines
scripts/linting/Invoke-LinkLanguageCheck.ps1 90.90% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1229      +/-   ##
==========================================
- Coverage   87.72%   87.72%   -0.01%     
==========================================
  Files          61       61              
  Lines        9321     9326       +5     
==========================================
+ Hits         8177     8181       +4     
- Misses       1144     1145       +1     
Flag Coverage Δ
pester 85.32% <90.90%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
scripts/linting/Invoke-LinkLanguageCheck.ps1 87.67% <90.90%> (+0.90%) ⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@WilliamBerryiii WilliamBerryiii dismissed katriendg’s stale review April 6, 2026 20:35

Feedback addressed.

@WilliamBerryiii WilliamBerryiii merged commit 2aad98e into microsoft:main Apr 6, 2026
40 checks passed
katriendg pushed a commit that referenced this pull request Apr 23, 2026
…1383)

# Pull Request

## Description

`scripts/linting/Invoke-LinkLanguageCheck.ps1` accepts both
`-ExcludePaths` (`string[]`) and `-OutputPath` (`string`, default
`logs/link-lang-check-results.json`), but `scripts/linting/README.md`
only documented Features and Usage. This PR adds the missing Parameters
section, following the structure already used by the sibling
`Invoke-YamlLint.ps1` entry, and adds a usage example for a custom
output path.

The goal is to document both the long-standing `-ExcludePaths` parameter
and the newer `-OutputPath` parameter introduced in #1229 without
changing script behavior.

## Related Issue(s)

Closes #1302.

## Type of Change

Select all that apply:

**Code & Documentation:**

* [ ] Bug fix (non-breaking change fixing an issue)
* [ ] New feature (non-breaking change adding functionality)
* [ ] Breaking change (fix or feature causing existing functionality to
change)
* [x] Documentation update

**Infrastructure & Configuration:**

* [ ] GitHub Actions workflow
* [ ] Linting configuration (markdown, PowerShell, etc.)
* [ ] Security configuration
* [ ] DevContainer configuration
* [ ] Dependency update

**AI Artifacts:**

* [ ] Reviewed contribution with `prompt-builder` agent and addressed
all feedback
* [ ] Copilot instructions (`.github/instructions/*.instructions.md`)
* [ ] Copilot prompt (`.github/prompts/*.prompt.md`)
* [ ] Copilot agent (`.github/agents/*.agent.md`)
* [ ] Copilot skill (`.github/skills/*/SKILL.md`)

> Note for AI Artifact Contributors:
>
> * Agents: Research, indexing/referencing other project (using standard
VS Code GitHub Copilot/MCP tools), planning, and general implementation
agents likely already exist. Review `.github/agents/` before creating
new ones.
> * Skills: Must include both bash and PowerShell scripts. See
[Skills](../docs/contributing/skills.md).
> * Model Versions: Only contributions targeting the **latest Anthropic
and OpenAI models** will be accepted. Older model versions (e.g.,
GPT-3.5, Claude 3) will be rejected.
> * See [Agents Not
Accepted](../docs/contributing/custom-agents.md#agents-not-accepted) and
[Model Version
Requirements](../docs/contributing/ai-artifacts-common.md#model-version-requirements).

**Other:**

* [ ] Script/automation (`.ps1`, `.sh`, `.py`)
* [ ] Other (please describe):

## Testing

- `npx markdownlint-cli2 scripts/linting/README.md`
- `npx markdown-table-formatter scripts/linting/README.md`
- Cross-checked the new Parameters list against
`scripts/linting/Invoke-LinkLanguageCheck.ps1` to verify names, types,
and defaults.

## Checklist

### Required Checks

* [x] Documentation is updated (if applicable)
* [x] Files follow existing naming conventions
* [x] Changes are backwards compatible (if applicable)
* [ ] Tests added for new functionality (if applicable)

### AI Artifact Contributions

* [ ] Used `/prompt-analyze` to review contribution
* [ ] Addressed all feedback from `prompt-builder` review
* [ ] Verified contribution follows common standards and type-specific
requirements

### Required Automated Checks

The following validation commands must pass before merging:

* [ ] Markdown linting: `npm run lint:md`
* [ ] Spell checking: `npm run spell-check`
* [ ] Frontmatter validation: `npm run lint:frontmatter`
* [ ] Skill structure validation: `npm run validate:skills`
* [ ] Link validation: `npm run lint:md-links`
* [ ] PowerShell analysis: `npm run lint:ps`
* [ ] Plugin freshness: `npm run plugin:generate`
* [ ] Docusaurus tests: `npm run docs:test`

## Security Considerations

* [x] This PR does not contain any sensitive or NDA information
* [x] Any new dependencies have been reviewed for security issues
* [x] Security-related scripts follow the principle of least privilege

## Additional Notes

- This description preserves the original issue references, the
sibling-entry rationale, and the exact targeted verification steps, but
reorganizes them into the repository template requested in review.
- Only the targeted checks listed in `## Testing` were run for this
documentation-only change.

Co-authored-by: Bill Berry <WilliamBerryiii@users.noreply.github.com>
WilliamBerryiii pushed a commit that referenced this pull request Apr 24, 2026
## Pre-Release 3.3.101

### ✨ Features

- add removed maturity tier and retire owasp-docker (#1444)
- add evaluation dataset creator (#1279)
- align RAI planner with guide, remove scoring, improve UX (#1287)
- add PSGallery staleness check and BOM cleanup (#1379)
- ISA-95 network planner agent (#1177)
- auto-generate collection.md with maturity filtering (#1316)
- add folder-consistency check and standardize WARN outp… (#1350)
- add synth-data-generate prompt to data-science collection (#1419)
- add canonical deck workflow and customer-card rendering for design
thinking (#1413)
- add Figma MCP integration for DT artifact export (#1222)
- introduce `owasp-docker` (#1245)
- replace hve-core-specific references with portable discovery-based
language (#1335)
- introduce `owasp-cicd` (#1246)
- add secure-by-design knowledge skill (#1223)
- introduce `owasp-infrastructure` (#1244)
- introduce `owasp-mcp` (#1207)
- add OutputPath parameter to Invoke-LinkLanguageCheck.ps1 (#1229)
- add -OutputPath parameter to Validate-SkillStructure.ps1 (#1225)
- add maintainer-only skip-review label guard (#1293)
- add extension collections overview and integrate into getting started
flow (#950)
- add agentic workflows for automated issue triage, implementation, PR
review, dependency review, and doc-staleness detection (#1219)
- consolidate package-lock.json version sync into
Update-VersionFiles.ps1 (#1240)
- add standards code review agent and full review orchestrator (#1174)
- standardize pytest-mock as Python mocking framework (#1170)
- add Jira backlog workflows and Jira/GitLab skills (#978)
- add centralized version bump script and supply-chain attestation
(#1183)

### 🐛 Bug Fixes

- pin PowerShell-Yaml to 0.4.7 across all install sites (#1378)
- close fork-PR/workflow-file-PR secret-strip gap and normalize
upload-artifact version (#1421)
- replace stream-based lookahead with array indexing in
list-changed-files.sh (#1376)
- centralize ISO 8601 timestamp regex in CIHelpers (#1343)
- update stale documentation date in release-process.md (#1363)
- pin basic-ftp to 5.3.0 to resolve GHSA-rp42-5vxx-qpwr (#1374)
- add bot filter to dependency PR review workflow (#1362)
- resolve pip-audit findings in powerpoint, gitlab, and jira skill lock
files (#1360)
- standardize Timestamp JSON key casing across all lint result files
(#1314)
- add synchronize trigger to PR Review workflow (#1323)
- standardize timestamp in Validate-SkillStructure.ps1 to use
Get-StandardTimestamp (#1280)
- add parallel subagent dispatch and structured JSON contracts to
code-review-full (#1304)
- standardize timestamp in SecurityHelpers.psm1 to use
Get-StandardTimestamp (#1284)
- standardize timestamps in Test-DependencyPinning.ps1 and
SecurityClasses.psm1 (#1282)
- derive collection artifact counts from YAML at build time (#1275)
- standardize timestamp in FrontmatterValidation.psm1 to use
Get-StandardTimestamp (#1285)
- standardize timestamp in Markdown-Link-Check.ps1 to use
Get-StandardTimestamp (#1283)
- escape hyphens in Mermaid diagram on Collections page (#1262)
- add summary timestamp to PSScriptAnalyzer output (#1211)
- fix plugin compatibility and robustness for coding-standards code
review agents (#1289)
- standardize timestamp in Test-CopyrightHeaders.ps1 to use
Get-StandardTimestamp (#1278)
- standardize timestamp in Invoke-YamlLint.ps1 to use
Get-StandardTimestamp (#1270)
- standardize timestamp in Invoke-LinkLanguageCheck.ps1 to use
Get-StandardTimestamp (#1264)
- fix dependency-review path filters and sparse-checkout cone mode
(#1259)
- replace invalid bare tool names with official tool identifiers (#1198)
- fix broken links and remove orphaned reference in code review docs
(#1257)
- exclude Python env dirs from skill validation warnings (#1255)
- pin happy-dom and serialize-javascript to resolve Dependabot
vulnerabilities (#1253)
- remove Mermaid diagram and add missing collection cards (#1247)
- disable MCP servers by default to prevent token limit errors (#1144)
- sync package-lock.json after pre-release version bump (#1236)
- separate mermaid node declarations and add dynamic diagram generation
with tests (#1215)
- replace anchor links in meeting-analyst with bold text references
(#1201)
- remove recursive symlinks in jira and gitlab skill directories (#1233)
- validate-installation scripts now check .github/skills directory
(#1010) (#1206)
- resolve npm audit vulnerabilities via dependency overrides (#1200)
- add post-release triggers to scorecard workflow (#1186)
- add missing .md extensions to relative links in agent documentation
(#1180)

### 📚 Documentation

- broaden Security Review description beyond OWASP (#1385)
- document maintainer advisory mode and skip-review label guard (#1386)
- document ExcludePaths/OutputPath for Invoke-LinkLanguageCheck (#1383)
- CLI getting-started: clarify plugin install commands as alternatives
(-all vs base) (#1251)

### ♻️ Refactoring

- align agent and prompt folder names to collection identifier (#1210)

### 🔧 Maintenance

- pin PSScriptAnalyzer to 1.25.0 and sync stale workflow version
comments (#1389)
- bump lxml from 6.0.2 to 6.1.0 in
/.github/skills/experimental/powerpoint (#1424)
- bump @vscode/vsce from 3.7.1 to 3.9.1 in the npm-dependencies group
(#1390)
- bump the github-actions group across 1 directory with 7 updates
(#1391)
- bump follow-redirects from 1.15.11 to 1.16.0 in /docs/docusaurus
(#1356)
- upgrade Node.js from 20 to 24 and bump cspell to v10 (#1353)
- bump basic-ftp from 5.2.0 to 5.2.1 (#1324)
- update github/gh-aw-actions requirement to
536ea1bad8c6715d098a9dc1afea8d403733acfe in the github-actions group
across 1 directory (#1298)
- update security instruction attributions and compliance (#1294)
- bump the npm-dependencies group with 2 updates (#1297)
- pre-release 3.3.41 (#1252)
- streamline RAI Planner phase structure and documentation (#1273)
- bump happy-dom from 20.8.8 to 20.8.9 in /docs/docusaurus (#1237)
- pre-release 3.3.27 (#1191)
- bump pygments from 2.19.2 to 2.20.0 in /.github/skills/gitlab/gitlab
(#1234)
- bump path-to-regexp from 0.1.12 to 0.1.13 in /docs/docusaurus (#1226)
- bump the github-actions group with 4 updates (#1231)
- add missing folders and alphabetize location lists (#1193)
- bump brace-expansion (#1224)
- bump handlebars from 4.7.8 to 4.7.9 in /docs/docusaurus (#1217)
- bump brace-expansion from 5.0.3 to 5.0.5 in /docs/docusaurus (#1213)
- pre-release 3.3.10 (#1187)
- bump markdownlint-cli2 from 0.21.0 to 0.22.0 in the npm-dependencies
group (#1175)
- bump the github-actions group with 3 updates (#1176)
- pre-release 3.3.1 (#1165)

---
*Managed automatically by pre-release workflow.*

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add -OutputPath parameter to Invoke-LinkLanguageCheck.ps1

5 participants