Skip to content
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

CHANGE @W-17053004@ Polished run command output #1669

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Conversation

jfeingold35
Copy link
Collaborator

@jfeingold35 jfeingold35 commented Nov 8, 2024

This PR does the following:

  • Moves the Found X violations across Y files message to the Summary portion of the output instead of the View portion.
    • The detail format no longer has a message.
    • The table format just says what the paths are relative to.
  • The Summary portion no longer mentions outfiles at all unless outfiles were created.
  • The engine run progress listener now says "X of Y engines finished" instead of "X of Y engines still executing".

@@ -123,8 +114,7 @@ export class ResultsTableDisplayer extends AbstractResultsDisplayer {
}
});

this.display.displayLog(getMessage(BundleName.ResultsViewer, 'summary.table.found-results', [
violations.length, this.countUniqueFiles(violations), parentFolder]));
this.display.displayLog(getMessage(BundleName.ResultsViewer, 'summary.table.results-relative-to', [parentFolder]));
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we need to show this if there are no results?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It doesn't show if there are no results. The method is only called when there are results to show.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

New messages are the still-relevant ones from the now-deleted run-summary-viewer.md.

@@ -75,6 +75,64 @@ export class RulesActionSummaryViewer extends AbstractActionSummaryViewer {
this.display.displayLog(indent(getMessage(BundleName.ActionSummaryViewer, 'rules-action.rules-item', [ruleCountForEngine, engineName])));
}
}
}

export class RunActionSummaryViewer extends AbstractActionSummaryViewer {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This code is almost identical to the code from RunSummaryViewer.ts, but it's different to accomplish the goals of the story.

@jfeingold35 jfeingold35 merged commit 2bbb76f into dev-5 Nov 15, 2024
21 checks passed
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.

2 participants