Ability to set configuration options programmatically with Accessibility Checker API [Feature]:

[jamalmazrui]

Project

accessibility-checker-engine, accessibility-checker for Node

Description

I have searched documentation and examples extensively but not found a way to set configuration options programmatically when using the Node Accessibility-checker API. The technique of using a .achecker.yml configuration file in the project root directory does work, but it is overly restrictive. It requires that directory to be the current directory when running the .js program. It requires desired output formats to be specified in advance, before the program is run. It does not allow flexibility in the names of the output files.

Please add to the API something like a checker.setConfiguration method for passing options at runtime. Please create separate methods for saving the various formats to disk, e.g., report.saveXlsx(sFilePath) for saving Excel output from the report object obtained from the getCompliance method. Similarly, there might be saveCsv, saveJson, and saveHtml methods. If the calling code awaits the return of such methods, that could be a way of ensuring they are fully flushed to disk (see other issue about this).

[tombrunet]

Are you trying to change configuration options during the test? Note that there is a .js version of the configuration file that allows loading configuration via environment variables and such. Trying to better understand exactly how you're trying to use it.

[jamalmazrui]

I want my Node.js program, which requires accessibility-checker, to create a unique directory name to store test results, in multiple formats, for each page tested. The unique name for the output directory is determined at runtime, so I am hoping for a way that my program can set the value of the output directory just before calling the getCompliance method, in order that the output files (results.csv, results.json, results.html, and results.xlsx) are saved in that directory.

[jamalmazrui]

I found a hack as a workaround. My program creates the configuration file at runtime and saves it in the current directory just before calling the getCompliance method. Here is the initial release of my program called TestPage:

https://github.com/jamalmazrui/testpage