-
Notifications
You must be signed in to change notification settings - Fork 0
docs: align design documentation, review sets, tests, and PathHelpers with removal of Linting subsystem #58
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
20b2104
docs: remove linting subsystem, move lint types to configuration desi…
Copilot 8057928
docs: update .reviewmark.yaml to align with code (remove linting, add…
Copilot b23f6bc
test: move linting tests to Configuration, add LintIssueTests, update…
Copilot b641d2f
test: fix test naming convention and update requirements linkage
Copilot cb9e358
fix: sync PathHelpers to TemplateDotNetTool reference implementation
Copilot ea2f68a
Update test/DemaConsulting.VersionMark.Tests/Configuration/LintIssueT…
Malcolmnixon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # LintIssue Unit | ||
|
|
||
| ## Overview | ||
|
|
||
| `LintIssue.cs` contains the types used to surface validation issues found while loading a | ||
| `.versionmark.yaml` configuration file. It defines three public types: the `LintSeverity` | ||
| enumeration, the `LintIssue` record, and the `VersionMarkLoadResult` record. | ||
|
|
||
| ## LintSeverity Enumeration | ||
|
|
||
| `LintSeverity` classifies the severity of a validation issue: | ||
|
|
||
| | Value | Meaning | | ||
| |-----------|----------------------------------------------------------------------------| | ||
| | `Warning` | Non-fatal advisory message; loading continues. | | ||
| | `Error` | Fatal validation failure that prevents the configuration from being built. | | ||
|
|
||
| ## LintIssue Record | ||
|
|
||
| `LintIssue` represents a single issue found during configuration loading. It carries: | ||
|
|
||
| | Property | Type | Description | | ||
| |---------------|----------------|------------------------------------------------| | ||
| | `FilePath` | `string` | Path to the file containing the issue. | | ||
| | `Line` | `long` | One-based line number of the issue. | | ||
| | `Column` | `long` | One-based column number of the issue. | | ||
| | `Severity` | `LintSeverity` | Severity classification. | | ||
| | `Description` | `string` | Human-readable description of the issue. | | ||
|
|
||
| `ToString` formats the record as `"{FilePath}({Line},{Column}): {severity}: {Description}"`, | ||
| where `{severity}` is emitted in lowercase (`warning` or `error`), producing output in | ||
| the familiar `file(line,col): error: message` format understood by CI systems and editors. | ||
|
|
||
| ## VersionMarkLoadResult Record | ||
|
|
||
| `VersionMarkLoadResult` is the return type of `VersionMarkConfig.Load`. It bundles two | ||
| properties: | ||
|
|
||
| | Property | Type | Description | | ||
| |----------|----------------------------|-----------------------------------------------------------------------------| | ||
| | `Config` | `VersionMarkConfig?` | The loaded configuration, or `null` when errors prevented building it. | | ||
| | `Issues` | `IReadOnlyList<LintIssue>` | All validation issues; may contain warnings even when `Config` is non-null. | | ||
|
|
||
| The `ReportIssues` method writes all issues to a `Context`, routing `LintSeverity.Error` | ||
| issues to `context.WriteError` and `LintSeverity.Warning` issues to `context.WriteLine`. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.