accessibility-checker/lib/ACConstants.js

An automated testing tools for accessibility testing using Puppeteer, Selenium, or Zombie

"use strict";
/******************************************************************************
     Copyright:: 2020- IBM, Inc

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
  *****************************************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ACConstants = void 0;
/*******************************************************************************
 * NAME: ACConstants.js
 * DESCRIPTION: Stores all the constants that are used by karma-ibma.
 *******************************************************************************/
// Load all the modules that are needed
var os_1 = require("os");
var pathLib = require("path");
var IEngine_1 = require("./api/IEngine");
// Used to specify all the constant
exports.ACConstants = {
    DEBUG: process.env.DEBUG === "true",
    maxTabs: 1,
    policies: ["IBM_Accessibility"],
    // Specify the default rule pack server to use. (Where to pull the rules and engine from).
    // - JSDelivr CDN
    ruleServer: "https://cdn.jsdelivr.net/npm/accessibility-checker-engine",
    // - IBM Cloud hosting
    // ruleServer: "https://able.ibm.com/rules",
    //Specify the rule set to be use.
    ruleArchive: "latest",
    // Specify default violation levels on which to fail the test.
    // i.e. If specified violation then the testcase will only fail if
    //      a violation is found uring the scan.
    failLevels: [IEngine_1.eRuleLevel.violation, IEngine_1.eRuleLevel.potentialviolation],
    // Specify default violation levels which should be reported.
    // i.e. If specified violation then in the report it would only contain
    //      results which are level of violation.
    reportLevels: [IEngine_1.eRuleLevel.violation, IEngine_1.eRuleLevel.potentialviolation],
    // Specify default value if screenshoot should be captured of the current page that is being scanned.
    captureScreenshots: false,
    // Specify default value for which type should the results be outputted to
    outputFormat: "json",
    // Specify default location where the results should be saved
    outputFolder: "results",
    // Specify default location where the baselines should be saved
    baselineFolder: "baselines",
    // Default cache folder (for ace-node.js / archives.json)
    cacheFolder: "".concat((0, os_1.tmpdir)(), "/accessibility-checker/"),
    // Specify default value for Which file extensions should be checked
    extensions: ["html", "htm", "svg"],
    // List of files to look for in that order, in the case even one is found we stop and load that as the config.
    // Theses files will be checked for in the working directory:
    //  ./.achecker.yml
    //  ./.achecker.yaml
    //  ./achecker.js
    //  ./achecker.json
    //  ./.config/.achecker.yml
    //  ./.config/.achecker.yaml
    //  ./.config/achecker.js
    //  ./.config/achecker.json
    // The node module, require will load js or json depending on which one is present, in the case
    // both json and js are present it loads js first.
    configFiles: [".achecker.yml", ".achecker.yaml", "achecker", "aceconfig", pathLib.join(".config", ".achecker.yml"), pathLib.join(".config", ".achecker.yaml"), pathLib.join(".config", "achecker"), pathLib.join(".config", "aceconfig")],
    ignoreHTTPSErrors: false
};
//# sourceMappingURL=ACConstants.js.map