@modus/gimbal-plugin-axe
Version:
Plugin to add axe audits to Gimbal
173 lines (172 loc) • 9.06 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __spreadArrays = (this && this.__spreadArrays) || function () {
for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var axe_puppeteer_1 = require("axe-puppeteer");
var deepmerge_1 = __importDefault(require("deepmerge"));
var defaultConfig = {
showSuccesses: true,
thresholds: {
impact: 'none',
},
};
var impactMap = {
none: 0,
minor: 1,
moderate: 2,
serious: 3,
critical: 4,
};
var type = 'axe';
var getThreshold = function (entry, _a) {
var thresholds = _a.thresholds;
var threshold = thresholds[entry.id] || thresholds.impact;
if (typeof threshold === 'number') {
var keys = Object.keys(impactMap);
var match = keys.find(function (key) { return threshold === impactMap[key]; });
return match || thresholds.impact;
}
return threshold;
};
var isSuccessful = function (entry, threshold) {
return threshold == null || !entry.impact ? true : impactMap[threshold] >= impactMap[entry.impact];
};
var parseEntry = function (entry, success, config) {
var threshold = getThreshold(entry, config);
return {
label: entry.id,
rawLabel: entry.id,
rawThreshold: threshold,
rawValue: entry.impact,
success: success || isSuccessful(entry, threshold),
thresholdLimit: 'upper',
threshold: threshold,
type: type,
value: entry.impact == null ? '' : entry.impact,
};
};
var Axe = function (_a, config) {
var bus = _a.bus;
return __awaiter(void 0, void 0, void 0, function () {
var pluginConfig, register;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
pluginConfig = deepmerge_1.default(defaultConfig, config);
return [4 /*yield*/, bus('module/registry')];
case 1:
register = (_b.sent()).register;
register(type, {
thresholdLimit: 'upper',
thresholdType: 'number',
}, function (_a) {
var chrome = _a.chrome, url = _a.url;
return __awaiter(void 0, void 0, void 0, function () {
var page, instance, raw, passes, violations, data, success;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, chrome.newPage()];
case 1:
page = _b.sent();
if (!page) return [3 /*break*/, 6];
return [4 /*yield*/, page.setBypassCSP(true)];
case 2:
_b.sent();
return [4 /*yield*/, page.goto(url)];
case 3:
_b.sent();
instance = new axe_puppeteer_1.AxePuppeteer(page);
if (pluginConfig.disabledRules) {
instance.disableRules(pluginConfig.disabledRules);
}
if (pluginConfig.exclude) {
instance.exclude(pluginConfig.exclude);
}
if (pluginConfig.include) {
instance.include(pluginConfig.include);
}
if (pluginConfig.rules) {
instance.withRules(pluginConfig.rules);
}
if (pluginConfig.tags) {
instance.withTags(pluginConfig.tags);
}
return [4 /*yield*/, instance.analyze()];
case 4:
raw = _b.sent();
passes = raw.passes, violations = raw.violations;
data = __spreadArrays((pluginConfig.showSuccesses
? passes.map(function (entry) { return parseEntry(entry, true, pluginConfig); })
: []), violations.map(function (entry) { return parseEntry(entry, false, pluginConfig); }));
success = data.every(function (item) { return item.success; });
return [4 /*yield*/, page.close()];
case 5:
_b.sent();
return [2 /*return*/, {
data: [
{
data: data,
label: 'Axe Audits',
rawLabel: 'Axe Audits',
success: success,
type: type,
},
],
raw: raw,
success: success,
}];
case 6: throw new Error('Could not open page to analyze with axe');
}
});
});
});
return [2 /*return*/];
}
});
});
};
exports.default = Axe;