-
Notifications
You must be signed in to change notification settings - Fork 60
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
feat: Add ability to always save test file #948
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 |
||||||
Copyright c 2020 | ||||||
|
||||||
--processid Process Id | ||||||
|
@@ -39,6 +39,10 @@ Copyright c 2020 | |||||
|
||||||
--customuia The path to a configuration file specifying custom | ||||||
UI Automation attributes | ||||||
|
||||||
--alwayssavetestfile If specified, always save the test file. By | ||||||
default, the test file is saved only if errors are | ||||||
found. | ||||||
``` | ||||||
|
||||||
To scan an application, you need to specify the application's process via either the `--processId` or `--processName` parameters | ||||||
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
### Scan results | ||||||
A summary of scan results will be displayed after the scan is run. In addition, an `.a11ytest` file will be generated if 1 or more errors were detected. The location of this file will be reported in the tool output (see the documentation of the `--outputDirectory` and `--scanId` parameters for ways to alter the name or location of the output file). This file can then be opened with **Accessibility Insights for Windows**, which is freely available at http://accessibilityinsights.io. If you scan an application with multiple top-level windows, an `.a11ytest` file will be generated for _each_ top-level window, even if no errors are detected. | ||||||
A summary of scan results will be displayed after the scan is run. In addition, an `.a11ytest` file will be generated if 1 or more errors were detected or if the `alwayssavetestfile` option was specified. The location of this file will be reported in the tool output (see the documentation of the `--outputDirectory` and `--scanId` parameters for ways to alter the name or location of the output file). This file can then be opened with **Accessibility Insights for Windows**, which is freely available at http://accessibilityinsights.io. If you scan an application with multiple top-level windows, an `.a11ytest` file will be generated for _each_ top-level window, even if no errors are detected. | ||||||
|
||||||
A detailed description of scan results will also be displayed if you specify verbose output (see the `verbosity` parameter). | ||||||
|
||||||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tweaked this a bit