feat: DOC-02 auto-fix by davidnmbond · Pull Request #204 · panoramicdata/PanoramicData.NugetManagement

davidnmbond · 2026-11-13T14:16:15Z

Adds the DOC-02 remediation: inserts the supported-versions sentence into README.md and rewrites stale plain .NET versions when exactly one is supported. Leaves Framework/Standard/Core, target-specific monikers and multi-version cases alone. Reads files strictly as UTF-8 with a byte-preserving Latin-1 fallback. 2420 offline tests pass.

…tes stale versions Adds the sentence the rule requires to README.md after the title and badges. When exactly one modern .NET version is supported it also rewrites plain stale mentions (.NET 10, net10.0) in the files the rule names. Several supported versions, .NET Framework/Standard/Core mentions and target-specific monikers are left for a person or the AI. Reads only the advisory data the rule already emits. Cannot merge until the DOC-02 rule itself is committed, because EveryRegisteredRuleId_IsARealRule requires a rule for every remediation.

codacy-production · 2026-11-13T14:18:33Z

Not up to standards ⛔

🔴 Issues 2 medium

Alerts:
⚠ 2 issues (≤ 0 issues of at least minor severity)

Results:
2 new issues

Category Results

Complexity 2 medium

View in Codacy

🟢 Metrics 96 complexity · 0 duplication

Metric Results

Complexity 96

Duplication 0

View in Codacy

🟢 Coverage 96.48% diff coverage · +0.25% coverage variation

Metric Results

Coverage variation ✅ +0.25% coverage variation (-1.00%)

Diff coverage ✅ 96.48% diff coverage

View coverage diff in Codacy

Coverage variation details

Coverable lines Covered lines Coverage

Common ancestor commit (c97435f) 22793 14520 63.70%

Head commit (7b3d58b) 22938 (+145) 14670 (+150) 63.96% (+0.25%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

Coverable lines Covered lines Diff coverage

Pull request (#204) 142 137 96.48%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

_{TIP This summary will be updated as you push new changes.}

codacy-production

Pull Request Overview

⚠️ Resolve issues before merging

Three high-confidence issues should be addressed before merging: repository paths derived from advisory data are not validated for containment, project-file rewrites can affect structured MSBuild content, and version matching can rewrite historical or partial version references incorrectly. The implementation also lacks coverage for direct application without the required phrase, missing source files, and spacing after nonblank title/badge lines.

Test suggestions

Prompt proposal for missing tests

Consider implementing these tests if applicable:
1. Apply safely when the required phrase is absent, including direct Apply invocation
2. Handle a reported source file that does not exist
3. Insert after a nonblank title/badge line while preserving spacing

_{TIP How was this review? Give us feedback}

codacy-production · 2026-11-13T14:19:59Z

+
+		foreach (var file in Strings(result, "unsupported_mentions").Select(SourceFile).Distinct(StringComparer.OrdinalIgnoreCase))
+		{
+			if (RewriteMentions(Path.Combine(localPath, file), current))


_{🔴 HIGH RISK}

Restrict project-file replacements to the reported documentation text, preserving MSBuild properties and conditions. Likewise, limit Markdown edits to prose and exclude links and code blocks.

_{TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.}

codacy-production · 2026-11-13T14:19:59Z

+
+	private static (string Text, Encoding Encoding) Read(string path)
+	{
+		var bytes = File.ReadAllBytes(path);


_{🔴 HIGH RISK}

Validate every path derived from advisory mentions after normalization and reject rooted paths or paths that escape the repository root before reading or writing. Preserve legitimate repository subdirectories and apply the check consistently to both operations.

See Issue in Codacy
See Issue in Codacy

_{TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.}

codacy-production · 2026-11-13T14:19:59Z

+	[GeneratedRegex(@"\s<[^>]+>$")]
+	private static partial Regex PropertySuffixRegex();
+
+	[GeneratedRegex(@"\.NET\s+(?:(?<kind>Framework|Standard|Core)\s+)?(?<version>\d+(?:\.\d+)?)(?!\.\d)")]


_{🟡 MEDIUM RISK}

Require a complete version boundary so patch versions and qualified versions are not partially matched. Add regression tests for multi-digit patch versions and platform-qualified versions.

_{TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.}

codacy-production · 2026-11-13T14:19:59Z

+		var updated = ProseRegex().Replace(text, match =>
+			match.Groups["kind"].Success || Normalise(match.Groups["version"].Value) == current
+				? match.Value
+				: ".NET " + current);


_{🟡 MEDIUM RISK}

Do not automatically rewrite historical version statements; leave them for manual remediation and add a regression test covering that case.

_{TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.}

…se and non-historical lines

… version boundary, history in descriptions

…nd write

davidnmbond added 2 commits November 13, 2026 14:16

fix: DOC-02 auto-fix preserves non-UTF-8 README bytes

ec46faa

codacy-production Bot reviewed Nov 13, 2026

View reviewed changes

davidnmbond added 3 commits November 13, 2026 14:28

fix: DOC-02 auto-fix stays inside the repo, project descriptions, pro…

43c2e8e

…se and non-historical lines

fix: DOC-02 auto-fix validates paths at the file access, whole-number…

b489278

… version boundary, history in descriptions

fix: DOC-02 auto-fix resolves and checks the path inside every read a…

7b3d58b

…nd write

davidnmbond merged commit 4241718 into main Nov 13, 2026
7 of 8 checks passed

Navigation Menu

Repository navigation

feat: DOC-02 auto-fix - #204

feat: DOC-02 auto-fix#204
davidnmbond merged 5 commits into
mainfrom
feat/doc-02-autofix-v2

davidnmbond commented Nov 13, 2026

Uh oh!

codacy-production Bot commented Nov 13, 2026 •

edited

Loading

Uh oh!

codacy-production Bot left a comment

Uh oh!

codacy-production Bot Nov 13, 2026

Uh oh!

codacy-production Bot Nov 13, 2026

Uh oh!

codacy-production Bot Nov 13, 2026

Uh oh!

codacy-production Bot Nov 13, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

davidnmbond commented Nov 13, 2026

Uh oh!

codacy-production Bot commented Nov 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Not up to standards ⛔

Uh oh!

codacy-production Bot left a comment

Choose a reason for hiding this comment

Pull Request Overview

Test suggestions

Uh oh!

codacy-production Bot Nov 13, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Nov 13, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Nov 13, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Nov 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

codacy-production Bot commented Nov 13, 2026 •

edited

Loading