@qualweb/best-practices 0.6.19 → 0.7.0

package/README.md

@@ -6,6 +6,46 @@ Implementation of accessibility best practices for web pages.
 
 **This is an internal module of QualWeb. To use it check either [@qualweb/cli](https://github.com/qualweb/cli) or [@qualweb/core](https://github.com/qualweb/core).**
 
+## How to use
+
+This package is intended to be used with [@qualweb/core](https://github.com/qualweb/core).
+
+Add both packages to your project: 
+
+```bash
+npm i --save @qualweb/core @qualweb/best-practices
+```
+
+In your own code, pass an instance of the `BestPractices` class to QualWeb's evaluate method:
+
+```typescript
+import { BestPractices } from '@qualweb/best-practices';
+import { QualWeb } from '@qualweb/core';
+
+async function main() {
+  const qw = new QualWeb();
+
+  await qw.start();
+
+  const bpInstance = new BestPractices({
+    // Include/exclude specific rules here. Omitting any filters implies *all*
+    // rules are included.
+    levels: ['A', 'AA'],
+  });
+
+  const urlToEvaluate = 'https://www.google.com';
+
+  const report = await qw.evaluate({
+    url: urlToEvaluate,
+    modules: [bpInstance],
+  });
+
+  await qw.stop();
+
+  console.debug(report[urlToEvaluate].metadata);
+}
+```
+
 ## Implemented best practices
 
 | QualWeb best practice ID | Related to | Best practice Name |

package/dist/BestPracticesModule.d.ts

@@ -0,0 +1,10 @@
+import type { EvaluationReport, ModuleOptions } from '@qualweb/core/evaluation';
+import { ExecutableModuleContext, ModuleType } from '@qualweb/core/evaluation';
+import type { TranslationOptions } from '@qualweb/locale';
+import type { QualwebPage } from '@qualweb/core/lib';
+export declare class BestPracticesModule extends ExecutableModuleContext {
+    readonly name = ModuleType.BEST_PRACTICES;
+    protected getModulePackage(): string;
+    protected runModule(page: QualwebPage, options: ModuleOptions, translate: TranslationOptions): Promise<EvaluationReport>;
+}
+//# sourceMappingURL=BestPracticesModule.d.ts.map

package/dist/BestPracticesModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BestPracticesModule.d.ts","sourceRoot":"","sources":["../src/BestPracticesModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,EACL,uBAAuB,EACvB,UAAU,EACX,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,qBAAa,mBAAoB,SAAQ,uBAAuB;IAC9D,SAAgB,IAAI,6BAA6B;IAEjD,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAIpC,SAAS,CAAC,SAAS,CACjB,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,kBAAkB,GAC5B,OAAO,CAAC,gBAAgB,CAAC;CAU7B"}

package/dist/BestPracticesModule.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BestPracticesModule = void 0;
+const evaluation_1 = require("@qualweb/core/evaluation");
+class BestPracticesModule extends evaluation_1.ExecutableModuleContext {
+    constructor() {
+        super(...arguments);
+        this.name = evaluation_1.ModuleType.BEST_PRACTICES;
+    }
+    getModulePackage() {
+        return '@qualweb/best-practices';
+    }
+    runModule(page, options, translate) {
+        return page.evaluate((options, translate) => {
+            return new BestPracticesRunner(options, translate).configure(options).test({}).getReport();
+        }, options, translate);
+    }
+}
+exports.BestPracticesModule = BestPracticesModule;

package/dist/BestPracticesRunner.d.ts

@@ -0,0 +1,9 @@
+import { ModuleTranslator } from '@qualweb/core/locale';
+import { EvaluationModuleDefinition, ModuleOptions } from '@qualweb/core/evaluation';
+import { BestPracticesTester } from './lib/BestPracticesTester.object';
+import { TranslationOptions } from '@qualweb/locale';
+export declare class BestPracticesRunner extends EvaluationModuleDefinition<BestPracticesTester> {
+    protected readonly translator: ModuleTranslator;
+    constructor(moduleOptions: ModuleOptions, translationOptions: TranslationOptions);
+}
+//# sourceMappingURL=BestPracticesRunner.d.ts.map

package/dist/BestPracticesRunner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BestPracticesRunner.d.ts","sourceRoot":"","sources":["../src/BestPracticesRunner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,0BAA0B,EAAE,aAAa,EAA4B,MAAM,0BAA0B,CAAC;AAC/G,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,qBAAa,mBAAoB,SAAQ,0BAA0B,CAAC,mBAAmB,CAAC;IACtF,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE7B,aAAa,EAAE,aAAa,EAAE,kBAAkB,EAAE,kBAAkB;CAgBxF"}

package/dist/BestPracticesRunner.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BestPracticesRunner = void 0;
+const locale_1 = require("@qualweb/core/locale");
+const evaluation_1 = require("@qualweb/core/evaluation");
+const BestPracticesTester_object_1 = require("./lib/BestPracticesTester.object");
+class BestPracticesRunner extends evaluation_1.EvaluationModuleDefinition {
+    constructor(moduleOptions, translationOptions) {
+        const moduleType = evaluation_1.ModuleType.BEST_PRACTICES;
+        const report = new evaluation_1.ModuleReport(moduleType);
+        const tester = new BestPracticesTester_object_1.BestPracticesTester(report);
+        super(moduleType, moduleOptions, translationOptions, report, tester);
+        this.translator = new locale_1.ModuleTranslator(this.type, this.translate);
+        this.tester.init(this.translator);
+    }
+}
+exports.BestPracticesRunner = BestPracticesRunner;