@axe-core/cli 4.7.1 → 4.7.2-alpha.389

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/dist/package.json +91 -0
  2. package/dist/src/bin/cli.d.ts +2 -0
  3. package/dist/src/bin/cli.js +39 -0
  4. package/dist/src/bin/cli.js.map +1 -0
  5. package/dist/src/bin/cli.test.d.ts +1 -0
  6. package/dist/src/bin/cli.test.js +241 -0
  7. package/dist/src/bin/cli.test.js.map +1 -0
  8. package/dist/src/bin/index.d.ts +5 -0
  9. package/dist/src/bin/index.js +120 -0
  10. package/dist/src/bin/index.js.map +1 -0
  11. package/dist/src/lib/axe-test-urls.d.ts +4 -0
  12. package/dist/src/lib/axe-test-urls.js +89 -0
  13. package/dist/src/lib/axe-test-urls.js.map +1 -0
  14. package/dist/src/lib/axe-test-urls.test.d.ts +1 -0
  15. package/dist/src/lib/axe-test-urls.test.js +73 -0
  16. package/dist/src/lib/axe-test-urls.test.js.map +1 -0
  17. package/dist/src/lib/events.d.ts +10 -0
  18. package/dist/src/lib/events.js +57 -0
  19. package/dist/src/lib/events.js.map +1 -0
  20. package/dist/src/lib/events.test.d.ts +1 -0
  21. package/dist/src/lib/events.test.js +31 -0
  22. package/dist/src/lib/events.test.js.map +1 -0
  23. package/dist/src/lib/index.d.ts +4 -0
  24. package/dist/src/lib/index.js +36 -0
  25. package/dist/src/lib/index.js.map +1 -0
  26. package/dist/src/lib/utils.d.ts +15 -0
  27. package/dist/src/lib/utils.js +120 -0
  28. package/dist/src/lib/utils.js.map +1 -0
  29. package/dist/src/lib/utils.test.d.ts +1 -0
  30. package/dist/src/lib/utils.test.js +140 -0
  31. package/dist/src/lib/utils.test.js.map +1 -0
  32. package/dist/src/lib/webdriver.d.ts +4 -0
  33. package/dist/src/lib/webdriver.js +46 -0
  34. package/dist/src/lib/webdriver.js.map +1 -0
  35. package/dist/src/lib/webdriver.test.d.ts +1 -0
  36. package/dist/src/lib/webdriver.test.js +102 -0
  37. package/dist/src/lib/webdriver.test.js.map +1 -0
  38. package/dist/src/testutils/index.d.ts +19 -0
  39. package/dist/src/testutils/index.js +51 -0
  40. package/dist/src/testutils/index.js.map +1 -0
  41. package/dist/src/types.d.ts +36 -0
  42. package/dist/src/types.js +18 -0
  43. package/dist/src/types.js.map +1 -0
  44. package/package.json +7 -17
  45. package/src/bin/cli.test.ts +3 -1
  46. package/tsconfig.json +3 -9
  47. package/dist/cli.js +0 -464
  48. package/dist/index.d.ts +0 -71
  49. package/dist/index.js +0 -229
  50. package/dist/index.mjs +0 -197
  51. package/esmTest.mjs +0 -6
package/dist/index.js DELETED
@@ -1,229 +0,0 @@
1
- var __create = Object.create;
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __getProtoOf = Object.getPrototypeOf;
6
- var __hasOwnProp = Object.prototype.hasOwnProperty;
7
- var __export = (target, all) => {
8
- for (var name in all)
9
- __defProp(target, name, { get: all[name], enumerable: true });
10
- };
11
- var __copyProps = (to, from, except, desc) => {
12
- if (from && typeof from === "object" || typeof from === "function") {
13
- for (let key of __getOwnPropNames(from))
14
- if (!__hasOwnProp.call(to, key) && key !== except)
15
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
16
- }
17
- return to;
18
- };
19
- var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
20
- // If the importer is in node compatibility mode or this is not an ESM
21
- // file that has been converted to a CommonJS file using a Babel-
22
- // compatible transform (i.e. "__esModule" has not been set), then set
23
- // "default" to the CommonJS "module.exports" for node compatibility.
24
- isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
25
- mod
26
- ));
27
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
28
-
29
- // src/lib/index.ts
30
- var lib_exports = {};
31
- __export(lib_exports, {
32
- saveOutcome: () => saveOutcome,
33
- testPages: () => axe_test_urls_default,
34
- utils: () => utils_exports
35
- });
36
- module.exports = __toCommonJS(lib_exports);
37
-
38
- // src/lib/axe-test-urls.ts
39
- var import_webdriverjs = __toESM(require("@axe-core/webdriverjs"));
40
- var testPages = async (urls, config, events) => {
41
- const driver = await config.driver;
42
- if (urls.length === 0) {
43
- await driver.quit();
44
- return Promise.resolve([]);
45
- }
46
- return new Promise((resolve, reject) => {
47
- const currentUrl = urls[0].replace(/[,;]$/, "");
48
- if (events?.onTestStart) {
49
- events?.onTestStart(currentUrl);
50
- }
51
- if (config.timer) {
52
- events?.startTimer("axe page load time");
53
- }
54
- driver.get(currentUrl).then(() => {
55
- if (config.timer) {
56
- events?.endTimer("axe page load time");
57
- }
58
- if (config.loadDelay) {
59
- events?.waitingMessage(config.loadDelay);
60
- }
61
- return new Promise((resolve2) => {
62
- setTimeout(resolve2, config.loadDelay);
63
- });
64
- }).then(() => {
65
- const axe = new import_webdriverjs.default(driver, config.axeSource);
66
- if (Array.isArray(config.include)) {
67
- config.include.forEach((include) => axe.include(include));
68
- }
69
- if (Array.isArray(config.exclude)) {
70
- config.exclude.forEach((exclude) => axe.exclude(exclude));
71
- }
72
- if (config.tags) {
73
- axe.withTags(config.tags);
74
- } else if (config.rules) {
75
- axe.withRules(config.rules);
76
- }
77
- if (config.disable) {
78
- axe.disableRules(config.disable);
79
- }
80
- if (config.timer) {
81
- events?.startTimer("axe-core execution time");
82
- }
83
- axe.analyze((err, results) => {
84
- if (config.timer) {
85
- events?.endTimer("axe-core execution time");
86
- }
87
- if (err) {
88
- return reject(err);
89
- }
90
- if (events?.onTestComplete) {
91
- events?.onTestComplete(results);
92
- }
93
- testPages(urls.slice(1), config, events).then((out) => {
94
- resolve([results].concat(out));
95
- });
96
- });
97
- }).catch(async (e) => {
98
- await driver.quit();
99
- reject(e);
100
- });
101
- });
102
- };
103
- var axe_test_urls_default = testPages;
104
-
105
- // src/lib/utils.ts
106
- var utils_exports = {};
107
- __export(utils_exports, {
108
- bold: () => bold,
109
- error: () => error,
110
- getAxeSource: () => getAxeSource,
111
- getAxeVersion: () => getAxeVersion,
112
- green: () => green,
113
- italics: () => italics,
114
- link: () => link,
115
- parseBrowser: () => parseBrowser,
116
- parseUrl: () => parseUrl,
117
- reporter: () => reporter,
118
- saveOutcome: () => saveOutcome,
119
- selectorToString: () => selectorToString,
120
- splitList: () => splitList
121
- });
122
- var import_fs = __toESM(require("fs"));
123
- var import_path = __toESM(require("path"));
124
- var import_colors = __toESM(require("colors"));
125
- var saveOutcome = (outcome, fileName, dir) => {
126
- if (typeof fileName !== "string") {
127
- fileName = "axe-results-" + Date.now() + ".json";
128
- }
129
- if (typeof dir !== "string") {
130
- dir = process.cwd();
131
- } else if (!import_path.default.isAbsolute(dir)) {
132
- dir = import_path.default.join(process.cwd(), dir);
133
- }
134
- const filePath = import_path.default.join(dir, fileName);
135
- if (!import_fs.default.existsSync(filePath)) {
136
- import_fs.default.mkdirSync(dir, { recursive: true });
137
- }
138
- import_fs.default.writeFileSync(filePath, JSON.stringify(outcome, null, 2), "utf-8");
139
- return filePath;
140
- };
141
- var parseUrl = (url) => {
142
- if (!/[a-z]+:\/\//.test(url)) {
143
- return "http://" + url;
144
- }
145
- return url;
146
- };
147
- var parseBrowser = (browser) => {
148
- if (!browser) {
149
- return "chrome-headless";
150
- }
151
- const l = browser.length;
152
- switch (browser.toLowerCase()) {
153
- case "ff":
154
- case "firefox".substr(0, l):
155
- case "gecko".substr(0, l):
156
- case "marionette".substr(0, l):
157
- return "firefox";
158
- case "chrome".substr(0, l):
159
- return "chrome";
160
- case "ie":
161
- case "explorer".substr(0, l):
162
- case "internetexplorer".substr(0, l):
163
- case "internet_explorer".substr(0, l):
164
- case "internet-explorer".substr(0, l):
165
- return "ie";
166
- case "safari".substr(0, l):
167
- return "safari";
168
- case "edge".substr(0, l):
169
- case "microsoftedge".substr(0, l):
170
- return "MicrosoftEdge";
171
- default:
172
- throw new Error("Unknown browser " + browser);
173
- }
174
- };
175
- var getAxeSource = (axePath) => {
176
- if (axePath && !import_fs.default.existsSync(axePath)) {
177
- return;
178
- }
179
- if (!axePath) {
180
- axePath = import_path.default.join(process.cwd(), "axe.js");
181
- }
182
- if (!import_fs.default.existsSync(axePath)) {
183
- axePath = import_path.default.join(process.cwd(), "node_modules", "axe-core", "axe.js");
184
- }
185
- if (!import_fs.default.existsSync(axePath)) {
186
- axePath = import_path.default.join(
187
- __dirname,
188
- "..",
189
- "..",
190
- "..",
191
- "node_modules",
192
- "axe-core",
193
- "axe.js"
194
- );
195
- }
196
- return import_fs.default.readFileSync(axePath, "utf-8");
197
- };
198
- var getAxeVersion = (source) => {
199
- const match = source.match(/\.version\s*=\s'([^']+)'/);
200
- return match ? match[1] : "unknown version";
201
- };
202
- var splitList = (val) => {
203
- return val.split(/[,;]/).map((str) => str.trim());
204
- };
205
- var selectorToString = (selectors, separator) => {
206
- separator = separator || " ";
207
- return selectors.reduce((prev, curr) => prev.concat(curr), []).join(separator);
208
- };
209
- var reporter = (noReporter, silentMode) => {
210
- if (!noReporter || silentMode) {
211
- return () => {
212
- };
213
- } else {
214
- return (...args) => {
215
- console.log(...args);
216
- };
217
- }
218
- };
219
- var link = import_colors.default.underline.blue;
220
- var error = import_colors.default.red.bold;
221
- var bold = import_colors.default.bold;
222
- var green = import_colors.default.green;
223
- var italics = import_colors.default.italic;
224
- // Annotate the CommonJS export names for ESM import in node:
225
- 0 && (module.exports = {
226
- saveOutcome,
227
- testPages,
228
- utils
229
- });
package/dist/index.mjs DELETED
@@ -1,197 +0,0 @@
1
- var __defProp = Object.defineProperty;
2
- var __export = (target, all) => {
3
- for (var name in all)
4
- __defProp(target, name, { get: all[name], enumerable: true });
5
- };
6
-
7
- // src/lib/axe-test-urls.ts
8
- import AxeBuilder from "@axe-core/webdriverjs";
9
- var testPages = async (urls, config, events) => {
10
- const driver = await config.driver;
11
- if (urls.length === 0) {
12
- await driver.quit();
13
- return Promise.resolve([]);
14
- }
15
- return new Promise((resolve, reject) => {
16
- const currentUrl = urls[0].replace(/[,;]$/, "");
17
- if (events?.onTestStart) {
18
- events?.onTestStart(currentUrl);
19
- }
20
- if (config.timer) {
21
- events?.startTimer("axe page load time");
22
- }
23
- driver.get(currentUrl).then(() => {
24
- if (config.timer) {
25
- events?.endTimer("axe page load time");
26
- }
27
- if (config.loadDelay) {
28
- events?.waitingMessage(config.loadDelay);
29
- }
30
- return new Promise((resolve2) => {
31
- setTimeout(resolve2, config.loadDelay);
32
- });
33
- }).then(() => {
34
- const axe = new AxeBuilder(driver, config.axeSource);
35
- if (Array.isArray(config.include)) {
36
- config.include.forEach((include) => axe.include(include));
37
- }
38
- if (Array.isArray(config.exclude)) {
39
- config.exclude.forEach((exclude) => axe.exclude(exclude));
40
- }
41
- if (config.tags) {
42
- axe.withTags(config.tags);
43
- } else if (config.rules) {
44
- axe.withRules(config.rules);
45
- }
46
- if (config.disable) {
47
- axe.disableRules(config.disable);
48
- }
49
- if (config.timer) {
50
- events?.startTimer("axe-core execution time");
51
- }
52
- axe.analyze((err, results) => {
53
- if (config.timer) {
54
- events?.endTimer("axe-core execution time");
55
- }
56
- if (err) {
57
- return reject(err);
58
- }
59
- if (events?.onTestComplete) {
60
- events?.onTestComplete(results);
61
- }
62
- testPages(urls.slice(1), config, events).then((out) => {
63
- resolve([results].concat(out));
64
- });
65
- });
66
- }).catch(async (e) => {
67
- await driver.quit();
68
- reject(e);
69
- });
70
- });
71
- };
72
- var axe_test_urls_default = testPages;
73
-
74
- // src/lib/utils.ts
75
- var utils_exports = {};
76
- __export(utils_exports, {
77
- bold: () => bold,
78
- error: () => error,
79
- getAxeSource: () => getAxeSource,
80
- getAxeVersion: () => getAxeVersion,
81
- green: () => green,
82
- italics: () => italics,
83
- link: () => link,
84
- parseBrowser: () => parseBrowser,
85
- parseUrl: () => parseUrl,
86
- reporter: () => reporter,
87
- saveOutcome: () => saveOutcome,
88
- selectorToString: () => selectorToString,
89
- splitList: () => splitList
90
- });
91
- import fs from "fs";
92
- import path from "path";
93
- import colors from "colors";
94
- var saveOutcome = (outcome, fileName, dir) => {
95
- if (typeof fileName !== "string") {
96
- fileName = "axe-results-" + Date.now() + ".json";
97
- }
98
- if (typeof dir !== "string") {
99
- dir = process.cwd();
100
- } else if (!path.isAbsolute(dir)) {
101
- dir = path.join(process.cwd(), dir);
102
- }
103
- const filePath = path.join(dir, fileName);
104
- if (!fs.existsSync(filePath)) {
105
- fs.mkdirSync(dir, { recursive: true });
106
- }
107
- fs.writeFileSync(filePath, JSON.stringify(outcome, null, 2), "utf-8");
108
- return filePath;
109
- };
110
- var parseUrl = (url) => {
111
- if (!/[a-z]+:\/\//.test(url)) {
112
- return "http://" + url;
113
- }
114
- return url;
115
- };
116
- var parseBrowser = (browser) => {
117
- if (!browser) {
118
- return "chrome-headless";
119
- }
120
- const l = browser.length;
121
- switch (browser.toLowerCase()) {
122
- case "ff":
123
- case "firefox".substr(0, l):
124
- case "gecko".substr(0, l):
125
- case "marionette".substr(0, l):
126
- return "firefox";
127
- case "chrome".substr(0, l):
128
- return "chrome";
129
- case "ie":
130
- case "explorer".substr(0, l):
131
- case "internetexplorer".substr(0, l):
132
- case "internet_explorer".substr(0, l):
133
- case "internet-explorer".substr(0, l):
134
- return "ie";
135
- case "safari".substr(0, l):
136
- return "safari";
137
- case "edge".substr(0, l):
138
- case "microsoftedge".substr(0, l):
139
- return "MicrosoftEdge";
140
- default:
141
- throw new Error("Unknown browser " + browser);
142
- }
143
- };
144
- var getAxeSource = (axePath) => {
145
- if (axePath && !fs.existsSync(axePath)) {
146
- return;
147
- }
148
- if (!axePath) {
149
- axePath = path.join(process.cwd(), "axe.js");
150
- }
151
- if (!fs.existsSync(axePath)) {
152
- axePath = path.join(process.cwd(), "node_modules", "axe-core", "axe.js");
153
- }
154
- if (!fs.existsSync(axePath)) {
155
- axePath = path.join(
156
- __dirname,
157
- "..",
158
- "..",
159
- "..",
160
- "node_modules",
161
- "axe-core",
162
- "axe.js"
163
- );
164
- }
165
- return fs.readFileSync(axePath, "utf-8");
166
- };
167
- var getAxeVersion = (source) => {
168
- const match = source.match(/\.version\s*=\s'([^']+)'/);
169
- return match ? match[1] : "unknown version";
170
- };
171
- var splitList = (val) => {
172
- return val.split(/[,;]/).map((str) => str.trim());
173
- };
174
- var selectorToString = (selectors, separator) => {
175
- separator = separator || " ";
176
- return selectors.reduce((prev, curr) => prev.concat(curr), []).join(separator);
177
- };
178
- var reporter = (noReporter, silentMode) => {
179
- if (!noReporter || silentMode) {
180
- return () => {
181
- };
182
- } else {
183
- return (...args) => {
184
- console.log(...args);
185
- };
186
- }
187
- };
188
- var link = colors.underline.blue;
189
- var error = colors.red.bold;
190
- var bold = colors.bold;
191
- var green = colors.green;
192
- var italics = colors.italic;
193
- export {
194
- saveOutcome,
195
- axe_test_urls_default as testPages,
196
- utils_exports as utils
197
- };
package/esmTest.mjs DELETED
@@ -1,6 +0,0 @@
1
- import { testPages } from './dist/index.mjs';
2
- import assert from 'assert';
3
-
4
- const exportIsFunction = typeof(testPages) === 'function';
5
- assert(exportIsFunction, 'export is not a function');
6
-