feat: Add ability to always save test file #948
Merged
Conversation
This file contains 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
DaveTryon
commented
Jul 4, 2023
| @@ -16,7 +16,7 @@ You invoke the scanner by running `AxeWindowsCLI.exe`. By default, this tool get | |||
| If you run the tool without parameters, you'll be presented with the help screen. An example follows: | |||
|
|
|||
| ``` | |||
| AxeWindowsCLI 2.1.1 | |||
| AxeWindowsCLI 2.1.4 | |||
There was a problem hiding this comment.
Future note--we should bump this when we update package versions after each release. It would appear that we overlooked this in the last 3 releases
codeofdusk
approved these changes
Jul 4, 2023
src/Automation/Data/Config.cs
Outdated
| @@ -117,6 +120,15 @@ public Builder WithCustomUIAConfig(string path) | |||
| return this; | |||
| } | |||
|
|
|||
| /// <summary> | |||
| /// Override the default behavior of only creating a11ytest files if errors are found. | |||
There was a problem hiding this comment.
Suggested change
| /// Override the default behavior of only creating a11ytest files if errors are found. | |
| /// Configure Axe.Windows to always save an a11ytest file, even if no errors are found. |
There was a problem hiding this comment.
I tweaked this a bit
src/CLI/README.MD
Outdated
| @@ -55,9 +59,10 @@ verbosity|Identifies the level of detail you want in the output. Valid values ar | |||
| showThirdPartyNotices|If specified, displays the third party notices for components used by AxeWindowsCLI. This information is also available in the `thirdpartynotices.html` file that is installed with AxeWindowsCLI. | |||
| delayInSeconds|Optionally inserts a delay before triggering the scan. This allows transient controls (menus, drop-down-lists, etc.) to be scanned. | |||
| customUia|Optionally provides a path to a [custom UIA configuration file](../../docs/CustomUIA.md). By default, only system-defined UIA properties will be included in the scan. | |||
| alwayssavetestfile|Optionally causes the test file to always be saved. By defualt, the test file is saved only if errors are found. | |||
There was a problem hiding this comment.
Suggested change
| alwayssavetestfile|Optionally causes the test file to always be saved. By defualt, the test file is saved only if errors are found. | |
| alwayssavetestfile|Optionally causes the test file to always be saved. By default, the test file is saved only if errors are found. |
Codecov Report
@@ Coverage Diff @@
## main #948 +/- ##
==========================================
+ Coverage 73.70% 74.74% +1.04%
==========================================
Files 398 423 +25
Lines 12046 13053 +1007
==========================================
+ Hits 8878 9757 +879
- Misses 3168 3296 +128
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Details
#935 requests that we provide a way for CLI users to create an
.a11ytestfile even when no errors are reported. This adds a--alwayssavetestfileoption to the CLI, then plumbs it through to take effect. People using the automation interface can access this directly via theConfig.Builder.WithAlwaysSaveTestFilemethod.Motivation
Address #935
Context
Pull request checklist