@axe-core/webdriverjs 4.3.3-alpha.218 → 4.3.3-alpha.219
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.
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/types.d.ts +2 -1
- package/dist/utils/index.d.ts +2 -1
- package/dist/utils/index.js +9 -11
- package/dist/utils/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +12 -5
- package/src/types.ts +3 -1
- package/src/utils/index.ts +11 -13
- package/tests/axe-webdriverjs.spec.ts +77 -24
- package/tests/fixtures/context.html +4 -0
- package/tests/fixtures/iframe-one.html +14 -0
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { WebDriver } from 'selenium-webdriver';
|
|
2
2
|
import { RunOptions, Spec, AxeResults } from 'axe-core';
|
|
3
|
-
import { CallbackFunction, BuilderOptions } from './types';
|
|
3
|
+
import { CallbackFunction, BuilderOptions, Selector } from './types';
|
|
4
4
|
declare class AxeBuilder {
|
|
5
5
|
private driver;
|
|
6
6
|
private axeSource;
|
|
@@ -15,12 +15,12 @@ declare class AxeBuilder {
|
|
|
15
15
|
* Selector to include in analysis.
|
|
16
16
|
* This may be called any number of times.
|
|
17
17
|
*/
|
|
18
|
-
include(selector:
|
|
18
|
+
include(selector: Selector): this;
|
|
19
19
|
/**
|
|
20
20
|
* Selector to exclude in analysis.
|
|
21
21
|
* This may be called any number of times.
|
|
22
22
|
*/
|
|
23
|
-
exclude(selector:
|
|
23
|
+
exclude(selector: Selector): this;
|
|
24
24
|
/**
|
|
25
25
|
* Set options to be passed into axe-core
|
|
26
26
|
*/
|
package/dist/index.js
CHANGED
|
@@ -68,6 +68,7 @@ var AxeBuilder = /** @class */ (function () {
|
|
|
68
68
|
* This may be called any number of times.
|
|
69
69
|
*/
|
|
70
70
|
AxeBuilder.prototype.include = function (selector) {
|
|
71
|
+
selector = Array.isArray(selector) ? selector : [selector];
|
|
71
72
|
this.includes.push(selector);
|
|
72
73
|
return this;
|
|
73
74
|
};
|
|
@@ -76,6 +77,7 @@ var AxeBuilder = /** @class */ (function () {
|
|
|
76
77
|
* This may be called any number of times.
|
|
77
78
|
*/
|
|
78
79
|
AxeBuilder.prototype.exclude = function (selector) {
|
|
80
|
+
selector = Array.isArray(selector) ? selector : [selector];
|
|
79
81
|
this.excludes.push(selector);
|
|
80
82
|
return this;
|
|
81
83
|
};
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,qCAAkC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,qCAAkC;AAOlC,uCAAiD;AACjD,+CAAyC;AACzC,qCAMmB;AACnB,+BAAiC;AAEjC;IAUE,oBACE,MAAiB,EACjB,SAAyB,EACzB,cAA+B;QALzB,eAAU,GAAG,KAAK,CAAC;QAOzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,iBAAM,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,cAAc,GAAG,cAAc,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,4BAAO,GAAd,UAAe,QAAkB;QAC/B,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC3D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,4BAAO,GAAd,UAAe,QAAkB;QAC/B,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC3D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,4BAAO,GAAd,UAAe,OAAmB;QAChC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,8BAAS,GAAhB,UAAiB,KAAwB;QACvC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG;YACpB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,6BAAQ,GAAf,UAAgB,IAAuB;QACrC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG;YACpB,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI;SACb,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,iCAAY,GAAnB,UAAoB,KAAwB;QAC1C,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC;QACvB,KAAmB,UAAK,EAAL,eAAK,EAAL,mBAAK,EAAL,IAAK,EAAE;YAArB,IAAM,IAAI,cAAA;YACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,8BAAS,GAAhB,UAAiB,MAAY;QAC3B,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;SACH;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACU,4BAAO,GAApB,UAAqB,QAA2B;;;;gBAC9C,sBAAO,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;wBACjC,OAAO,KAAI,CAAC,cAAc,EAAE;6BACzB,IAAI,CAAC,UAAC,OAAmB;4BACxB,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,IAAI,EAAE,OAAO,CAAC,CAAC;4BAC1B,OAAO,CAAC,OAAO,CAAC,CAAC;wBACnB,CAAC,CAAC;6BACD,KAAK,CAAC,UAAC,GAAU;4BAChB,oHAAoH;4BACpH,IAAI,QAAQ,EAAE;gCACZ,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;6BAC7B;iCAAM;gCACL,MAAM,CAAC,GAAG,CAAC,CAAC;6BACb;wBACH,CAAC,CAAC,CAAC;oBACP,CAAC,CAAC,EAAC;;;KACJ;IAED;;;;;;OAMG;IACI,kCAAa,GAApB,UAAqB,UAAiB;QAAjB,2BAAA,EAAA,iBAAiB;QACpC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACW,mCAAc,GAA5B;;;;;;wBACQ,OAAO,GAAG,IAAA,wBAAgB,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;wBAC/D,qBAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,cAAc,EAAE,EAAA;;wBAA7C,SAA6C,CAAC;wBACd,qBAAM,IAAA,yBAAe,EACnD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,CACZ,EAAA;;wBAJO,mBAAmB,GAAK,CAAA,SAI/B,CAAA,oBAJ0B;wBAK3B,IAAI,mBAAmB,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE;4BACnD,sBAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAC;yBAChC;wBAEgB,qBAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,EAAA;;wBAAxD,QAAQ,GAAG,SAA6C;;;;wBAGrD,qBAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAA;4BAArC,sBAAO,SAA8B,EAAC;;;wBAEtC,MAAM,IAAI,KAAK,CAEV,OAAe,CAAC,OAAO,sHACyF,CACpH,CAAC;;;;;KAEL;IAED;;OAEG;IACW,8BAAS,GAAvB,UAAwB,OAAsB;;;;;;wBACtC,KAAwC,IAAI,EAA1C,MAAM,YAAA,EAAE,SAAS,eAAA,EAAE,cAAc,oBAAA,CAAU;wBAC/C,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;wBACzB,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE;4BAC5B,MAAM,yBACD,CAAC,MAAM,IAAI,EAAE,CAAC,KACjB,cAAc,EAAE,CAAC,sBAAsB,CAAC,GACzC,CAAC;yBACH;wBACK,QAAQ,GAAG,IAAI,sBAAW,CAAC;4BAC/B,MAAM,QAAA;4BACN,SAAS,WAAA;4BACT,MAAM,QAAA;4BACN,cAAc,gBAAA;yBACf,CAAC,CAAC;wBACH,qBAAM,QAAQ,CAAC,mBAAmB,EAAE,EAAA;;wBAApC,SAAoC,CAAC;wBACrC,sBAAO,IAAA,sBAAY,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,EAAC;;;;KACrE;IAED;;OAEG;IACW,wCAAmB,GAAjC,UACE,OAAsB,EACtB,SAAiB;QAAjB,0BAAA,EAAA,iBAAiB;;;;;;6BAEb,CAAC,SAAS,EAAV,wBAAU;wBACZ,qBAAM,IAAA,yBAAe,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,EAAA;;wBAA/D,SAA+D,CAAC;;4BAG5C,qBAAM,IAAA,4BAAkB,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EAAA;;wBAA9D,aAAa,GAAG,SAA8C;wBAElE,qBAAM,IAAA,uBAAa,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,EAAA;;wBADlD,QAAQ;4BACZ,SAAsD;yBACvD;8BAEiE,EAAb,+BAAa;;;6BAAb,CAAA,2BAAa,CAAA;wBAAvD,wBAAsC,EAApC,YAAY,kBAAA,EAAE,aAAa,mBAAA,EAAE,KAAK,WAAA;wBACzC,aAAa,GAAG,KAAK,CAAC;;;;wBAExB,MAAM,CAAC,KAAK,EAAE,uBAAoB,aAAa,qBAAiB,CAAC,CAAC;wBAClE,qBAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAA;;wBAAzC,SAAyC,CAAC;wBAC1C,aAAa,GAAG,IAAI,CAAC;6BACrB,CAAA,KAAA,QAAQ,CAAC,IAAI,CAAA;8BAAb,QAAQ;wBAAU,qBAAM,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAA;;wBAA9D,wBAAiB,CAAC,SAA4C,CAAC,IAAE;wBACjE,qBAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,EAAA;;wBAA1C,SAA0C,CAAC;;;;6BAEvC,aAAa,EAAb,yBAAa;wBACf,qBAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,EAAA;;wBAA1C,SAA0C,CAAC;;;wBAE7C,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;;;wBAZ2B,IAAa,CAAA;;6BAelE,sBAAO,QAAQ,EAAC;;;;KACjB;IAED;;OAEG;IACW,8BAAS,GAAvB,UAAwB,QAAkB;;;;;;wBAClC,KAAwC,IAAI,EAA1C,MAAM,YAAA,EAAE,SAAS,eAAA,EAAE,MAAM,YAAA,EAAE,MAAM,YAAA,CAAU;wBAEvC,qBAAM,MAAM,CAAC,eAAe,EAAE,EAAA;;wBAApC,GAAG,GAAG,SAA8B;;;;wBAGxC,qBAAM,MAAM,CAAC,aAAa,CAAC,4BAA4B,CAAC,EAAA;;wBAAxD,SAAwD,CAAC;wBACxC,qBAAM,MAAM,CAAC,mBAAmB,EAAE,EAAA;;wBAA7C,QAAQ,GAAG,SAAkC;wBACnD,qBAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAA;;wBAA7D,SAA6D,CAAC;wBAC9D,qBAAM,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,EAAA;;wBAA/B,SAA+B,CAAC;;;;wBAEhC,MAAM,IAAI,KAAK,CACb,iFAA+E,OAAO,CACvF,CAAC;4BAGQ,qBAAM,IAAA,sBAAY,EAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAA;;wBAArE,GAAG,GAAG,SAA+D;wBAC3E,qBAAM,MAAM,CAAC,KAAK,EAAE,EAAA;;wBAApB,SAAoB,CAAC;wBACrB,qBAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAA;;wBAAnC,SAAmC,CAAC;wBACpC,sBAAO,GAAG,EAAC;;;;KACZ;IACH,iBAAC;AAAD,CAAC,AAtPD,IAsPC;AAED,OAAO,GAAG,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC;AAEtC,kBAAe,UAAU,CAAC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { WebDriver } from 'selenium-webdriver';
|
|
2
|
-
import type { Spec, AxeResults } from 'axe-core';
|
|
2
|
+
import type { Spec, AxeResults, BaseSelector } from 'axe-core';
|
|
3
3
|
import * as axe from 'axe-core';
|
|
4
4
|
export interface Options {
|
|
5
5
|
driver: WebDriver;
|
|
@@ -16,3 +16,4 @@ export interface AxeInjectorParams extends Options {
|
|
|
16
16
|
export declare type CallbackFunction = (error: string | null, results: AxeResults | null) => void;
|
|
17
17
|
export declare type InjectCallback = (err?: Error) => void;
|
|
18
18
|
export declare type PartialResults = Parameters<typeof axe.finishRun>[0];
|
|
19
|
+
export declare type Selector = BaseSelector | BaseSelector[];
|
package/dist/utils/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { ContextObject } from 'axe-core';
|
|
2
|
+
import { Selector } from '../types';
|
|
2
3
|
/**
|
|
3
4
|
* Get running context
|
|
4
5
|
*/
|
|
5
|
-
export declare const normalizeContext: (include:
|
|
6
|
+
export declare const normalizeContext: (include: Selector[], exclude: Selector[]) => ContextObject;
|
package/dist/utils/index.js
CHANGED
|
@@ -5,19 +5,17 @@ exports.normalizeContext = void 0;
|
|
|
5
5
|
* Get running context
|
|
6
6
|
*/
|
|
7
7
|
var normalizeContext = function (include, exclude) {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
8
|
+
var _a;
|
|
9
|
+
var base = {
|
|
10
|
+
exclude: []
|
|
11
|
+
};
|
|
12
|
+
if (exclude.length && Array.isArray(base.exclude)) {
|
|
13
|
+
(_a = base.exclude).push.apply(_a, exclude);
|
|
13
14
|
}
|
|
14
|
-
if (
|
|
15
|
-
|
|
15
|
+
if (include.length) {
|
|
16
|
+
base.include = include;
|
|
16
17
|
}
|
|
17
|
-
return
|
|
18
|
-
include: include,
|
|
19
|
-
exclude: exclude
|
|
20
|
-
};
|
|
18
|
+
return base;
|
|
21
19
|
};
|
|
22
20
|
exports.normalizeContext = normalizeContext;
|
|
23
21
|
//# sourceMappingURL=index.js.map
|
package/dist/utils/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACI,IAAM,gBAAgB,GAAG,UAC9B,OAAmB,EACnB,OAAmB;;IAEnB,IAAM,IAAI,GAAkB;QAC1B,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,IAAI,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QACjD,CAAA,KAAA,IAAI,CAAC,OAAO,CAAA,CAAC,IAAI,WAAI,OAAO,EAAE;KAC/B;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;KACxB;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAdW,QAAA,gBAAgB,oBAc3B"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@axe-core/webdriverjs",
|
|
3
|
-
"version": "4.3.3-alpha.
|
|
3
|
+
"version": "4.3.3-alpha.219+c7c50fb",
|
|
4
4
|
"description": "Provides a method to inject and analyze web pages using axe",
|
|
5
5
|
"contributors": [
|
|
6
6
|
{
|
|
@@ -105,5 +105,5 @@
|
|
|
105
105
|
"functions": 85,
|
|
106
106
|
"lines": 85
|
|
107
107
|
},
|
|
108
|
-
"gitHead": "
|
|
108
|
+
"gitHead": "c7c50fbe6ba91c51c3693ac1220fbd6470532a88"
|
|
109
109
|
}
|
package/src/index.ts
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
import { WebDriver } from 'selenium-webdriver';
|
|
2
2
|
import { RunOptions, Spec, AxeResults, ContextObject } from 'axe-core';
|
|
3
3
|
import { source } from 'axe-core';
|
|
4
|
-
import {
|
|
4
|
+
import {
|
|
5
|
+
CallbackFunction,
|
|
6
|
+
BuilderOptions,
|
|
7
|
+
PartialResults,
|
|
8
|
+
Selector
|
|
9
|
+
} from './types';
|
|
5
10
|
import { normalizeContext } from './utils/index';
|
|
6
11
|
import AxeInjector from './axe-injector';
|
|
7
12
|
import {
|
|
@@ -16,8 +21,8 @@ import * as assert from 'assert';
|
|
|
16
21
|
class AxeBuilder {
|
|
17
22
|
private driver: WebDriver;
|
|
18
23
|
private axeSource: string;
|
|
19
|
-
private includes:
|
|
20
|
-
private excludes:
|
|
24
|
+
private includes: Selector[];
|
|
25
|
+
private excludes: Selector[];
|
|
21
26
|
private option: RunOptions;
|
|
22
27
|
private config: Spec | null;
|
|
23
28
|
private builderOptions: BuilderOptions;
|
|
@@ -41,7 +46,8 @@ class AxeBuilder {
|
|
|
41
46
|
* Selector to include in analysis.
|
|
42
47
|
* This may be called any number of times.
|
|
43
48
|
*/
|
|
44
|
-
public include(selector:
|
|
49
|
+
public include(selector: Selector): this {
|
|
50
|
+
selector = Array.isArray(selector) ? selector : [selector];
|
|
45
51
|
this.includes.push(selector);
|
|
46
52
|
return this;
|
|
47
53
|
}
|
|
@@ -50,7 +56,8 @@ class AxeBuilder {
|
|
|
50
56
|
* Selector to exclude in analysis.
|
|
51
57
|
* This may be called any number of times.
|
|
52
58
|
*/
|
|
53
|
-
public exclude(selector:
|
|
59
|
+
public exclude(selector: Selector): this {
|
|
60
|
+
selector = Array.isArray(selector) ? selector : [selector];
|
|
54
61
|
this.excludes.push(selector);
|
|
55
62
|
return this;
|
|
56
63
|
}
|
package/src/types.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { WebDriver } from 'selenium-webdriver';
|
|
2
|
-
import type { Spec, AxeResults } from 'axe-core';
|
|
2
|
+
import type { Spec, AxeResults, BaseSelector } from 'axe-core';
|
|
3
3
|
import * as axe from 'axe-core';
|
|
4
4
|
|
|
5
5
|
export interface Options {
|
|
@@ -25,3 +25,5 @@ export type CallbackFunction = (
|
|
|
25
25
|
export type InjectCallback = (err?: Error) => void;
|
|
26
26
|
|
|
27
27
|
export type PartialResults = Parameters<typeof axe.finishRun>[0];
|
|
28
|
+
|
|
29
|
+
export type Selector = BaseSelector | BaseSelector[];
|
package/src/utils/index.ts
CHANGED
|
@@ -1,23 +1,21 @@
|
|
|
1
1
|
import type { ContextObject } from 'axe-core';
|
|
2
|
+
import { Selector } from '../types';
|
|
2
3
|
|
|
3
4
|
/**
|
|
4
5
|
* Get running context
|
|
5
6
|
*/
|
|
6
7
|
export const normalizeContext = (
|
|
7
|
-
include:
|
|
8
|
-
exclude:
|
|
8
|
+
include: Selector[],
|
|
9
|
+
exclude: Selector[]
|
|
9
10
|
): ContextObject => {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
const base: ContextObject = {
|
|
12
|
+
exclude: []
|
|
13
|
+
};
|
|
14
|
+
if (exclude.length && Array.isArray(base.exclude)) {
|
|
15
|
+
base.exclude.push(...exclude);
|
|
15
16
|
}
|
|
16
|
-
if (
|
|
17
|
-
|
|
17
|
+
if (include.length) {
|
|
18
|
+
base.include = include;
|
|
18
19
|
}
|
|
19
|
-
return
|
|
20
|
-
include,
|
|
21
|
-
exclude
|
|
22
|
-
};
|
|
20
|
+
return base;
|
|
23
21
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import 'mocha';
|
|
2
|
-
import { Spec } from 'axe-core';
|
|
2
|
+
import { AxeResults, Spec } from 'axe-core';
|
|
3
3
|
import { WebDriver } from 'selenium-webdriver';
|
|
4
4
|
import * as express from 'express';
|
|
5
5
|
import * as chromedriver from 'chromedriver';
|
|
@@ -404,48 +404,101 @@ describe('@axe-core/webdriverjs', () => {
|
|
|
404
404
|
});
|
|
405
405
|
|
|
406
406
|
describe('include/exclude', () => {
|
|
407
|
+
const flatPassesTargets = (results: AxeResults): string[] => {
|
|
408
|
+
return results.passes
|
|
409
|
+
.reduce((acc, pass) => {
|
|
410
|
+
return acc.concat(pass.nodes as any);
|
|
411
|
+
}, [])
|
|
412
|
+
.reduce((acc, node: any) => {
|
|
413
|
+
return acc.concat(node.target);
|
|
414
|
+
}, []);
|
|
415
|
+
};
|
|
407
416
|
it('with include and exclude', async () => {
|
|
408
|
-
let error: Error | null = null;
|
|
409
417
|
await driver.get(`${addr}/context.html`);
|
|
410
418
|
const builder = new AxeBuilder(driver)
|
|
411
419
|
.include('.include')
|
|
412
420
|
.exclude('.exclude');
|
|
421
|
+
const results = await builder.analyze();
|
|
413
422
|
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
} catch (e) {
|
|
417
|
-
error = e as Error;
|
|
418
|
-
}
|
|
419
|
-
|
|
420
|
-
assert.strictEqual(error, null);
|
|
423
|
+
assert.isTrue(flatPassesTargets(results).includes('.include'));
|
|
424
|
+
assert.isFalse(flatPassesTargets(results).includes('.exclude'));
|
|
421
425
|
});
|
|
422
426
|
|
|
423
427
|
it('with only include', async () => {
|
|
424
|
-
let error: Error | null = null;
|
|
425
428
|
await driver.get(`${addr}/context.html`);
|
|
426
429
|
const builder = new AxeBuilder(driver).include('.include');
|
|
430
|
+
const results = await builder.analyze();
|
|
427
431
|
|
|
428
|
-
|
|
429
|
-
await builder.analyze();
|
|
430
|
-
} catch (e) {
|
|
431
|
-
error = e as Error;
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
assert.strictEqual(error, null);
|
|
432
|
+
assert.isTrue(flatPassesTargets(results).includes('.include'));
|
|
435
433
|
});
|
|
436
434
|
|
|
437
435
|
it('with only exclude', async () => {
|
|
438
|
-
let error: Error | null = null;
|
|
439
436
|
await driver.get(`${addr}/context.html`);
|
|
440
437
|
const builder = new AxeBuilder(driver).exclude('.exclude');
|
|
438
|
+
const results = await builder.analyze();
|
|
441
439
|
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
}
|
|
440
|
+
assert.isFalse(flatPassesTargets(results).includes('.exclude'));
|
|
441
|
+
});
|
|
442
|
+
|
|
443
|
+
it('with chaining only include', async () => {
|
|
444
|
+
await driver.get(`${addr}/context.html`);
|
|
445
|
+
const builder = new AxeBuilder(driver)
|
|
446
|
+
.include('.include')
|
|
447
|
+
.include('.include2');
|
|
448
|
+
const results = await builder.analyze();
|
|
449
|
+
|
|
450
|
+
assert.isTrue(flatPassesTargets(results).includes('.include'));
|
|
451
|
+
assert.isTrue(flatPassesTargets(results).includes('.include2'));
|
|
452
|
+
});
|
|
453
|
+
|
|
454
|
+
it('with chaining only exclude', async () => {
|
|
455
|
+
await driver.get(`${addr}/context.html`);
|
|
456
|
+
const builder = new AxeBuilder(driver)
|
|
457
|
+
.exclude('.exclude')
|
|
458
|
+
.exclude('.exclude2');
|
|
459
|
+
const results = await builder.analyze();
|
|
460
|
+
|
|
461
|
+
assert.isFalse(flatPassesTargets(results).includes('.exclude'));
|
|
462
|
+
assert.isFalse(flatPassesTargets(results).includes('.exclude2'));
|
|
463
|
+
});
|
|
464
|
+
|
|
465
|
+
it('with chaining include and exclude', async () => {
|
|
466
|
+
await driver.get(`${addr}/context.html`);
|
|
467
|
+
const builder = new AxeBuilder(driver)
|
|
468
|
+
.include('.include')
|
|
469
|
+
.include('.include2')
|
|
470
|
+
.exclude('.exclude')
|
|
471
|
+
.exclude('.exclude2');
|
|
472
|
+
const results = await builder.analyze();
|
|
473
|
+
|
|
474
|
+
assert.isTrue(flatPassesTargets(results).includes('.include'));
|
|
475
|
+
assert.isTrue(flatPassesTargets(results).includes('.include2'));
|
|
476
|
+
assert.isFalse(flatPassesTargets(results).includes('.exclude'));
|
|
477
|
+
assert.isFalse(flatPassesTargets(results).includes('.exclude2'));
|
|
478
|
+
});
|
|
479
|
+
|
|
480
|
+
it('with include and exclude iframe selectors with no violations', async () => {
|
|
481
|
+
await driver.get(`${addr}/context.html`);
|
|
482
|
+
const builder = new AxeBuilder(driver)
|
|
483
|
+
.include(['#ifr-one', 'html'])
|
|
484
|
+
.exclude(['#ifr-one', 'main'])
|
|
485
|
+
.exclude(['#ifr-one', 'img']);
|
|
486
|
+
|
|
487
|
+
const results = await builder.analyze();
|
|
488
|
+
|
|
489
|
+
assert.lengthOf(results.violations, 0);
|
|
490
|
+
});
|
|
491
|
+
|
|
492
|
+
it('with include and exclude iframe selectors with violations', async () => {
|
|
493
|
+
await driver.get(`${addr}/context.html`);
|
|
494
|
+
const builder = new AxeBuilder(driver)
|
|
495
|
+
.include(['#ifr-one', 'html'])
|
|
496
|
+
.exclude(['#ifr-one', 'main']);
|
|
497
|
+
const results = await builder.analyze();
|
|
447
498
|
|
|
448
|
-
assert.
|
|
499
|
+
assert.lengthOf(results.violations, 2);
|
|
500
|
+
assert.strictEqual(results.violations[0].id, 'image-alt');
|
|
501
|
+
assert.strictEqual(results.violations[1].id, 'region');
|
|
449
502
|
});
|
|
450
503
|
});
|
|
451
504
|
|
|
@@ -6,6 +6,10 @@
|
|
|
6
6
|
<body>
|
|
7
7
|
<h1>Context Test</h1>
|
|
8
8
|
<div class="include">include me</div>
|
|
9
|
+
<div class="include2">include me two</div>
|
|
9
10
|
<div class="exclude">exclude me</div>
|
|
11
|
+
<div class="exclude2">exclude me two</div>
|
|
12
|
+
|
|
13
|
+
<iframe src="iframe-one.html" id="ifr-one"></iframe>
|
|
10
14
|
</body>
|
|
11
15
|
</html>
|