├── .changeset ├── README.md └── config.json ├── .eslintignore ├── .eslintrc ├── .github ├── actions │ └── install_and_cache_dependencies │ │ └── action.yml └── workflows │ ├── release.yml │ └── unit_tests.yml ├── .gitignore ├── .prettierrc ├── CHANGELOG.md ├── LICENSE ├── README.md ├── docs ├── assets │ ├── css │ │ └── main.css │ ├── images │ │ ├── icons.png │ │ ├── icons@2x.png │ │ ├── widgets.png │ │ └── widgets@2x.png │ └── js │ │ ├── main.js │ │ └── search.js ├── classes │ └── qualweb.html ├── index.html └── modules.html ├── package.json ├── src └── index.ts ├── test ├── core.spec.mjs ├── counter.spec.mjs ├── crawler.spec.mjs ├── file.spec.mjs ├── html.spec.mjs ├── locale.spec.mjs ├── log.spec.mjs ├── parallel.spec.mjs ├── plugin.spec.mjs ├── test.html ├── urls.spec.mjs ├── urls.txt ├── validator.spec.mjs └── wappalyzer.spec.mjs └── tsconfig.json /.changeset/README.md: -------------------------------------------------------------------------------- 1 | # Changesets 2 | 3 | Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works 4 | with multi-package repos, or single-package repos to help you version and publish your code. You can 5 | find the full documentation for it [in our repository](https://github.com/changesets/changesets) 6 | 7 | We have a quick list of common questions to get you started engaging with this project in 8 | [our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) 9 | 10 | ## Adding a changeset 11 | 12 | Use `npx changeset` to add a changeset. Pick the patch type that matches the changes you made (we use semantic versioning), and write a summary. This will be logged in a changeset file that you must commit to git. A recommended git message is of the form "docs(changeset):

". 13 | 14 | The changeset file is just markdown (after the frontmatter) and will be used to generate a changelog when we release. 15 | 16 | Some changes do not (or should not) require a version bump. In order to log a changeset for such a change, use `npx changeset --blank` instead. -------------------------------------------------------------------------------- /.changeset/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json", 3 | "changelog": "@changesets/cli/changelog", 4 | "commit": false, 5 | "fixed": [], 6 | "linked": [], 7 | "access": "public", 8 | "baseBranch": "master", 9 | "updateInternalDependencies": "patch", 10 | "ignore": [] 11 | } 12 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | test -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "parser": "@typescript-eslint/parser", 4 | "plugins": [ 5 | "@typescript-eslint", 6 | "sonarjs", 7 | "prettier" 8 | ], 9 | "extends": [ 10 | "eslint:recommended", 11 | "plugin:@typescript-eslint/eslint-recommended", 12 | "plugin:@typescript-eslint/recommended", 13 | "plugin:sonarjs/recommended", 14 | "prettier" 15 | ], 16 | "rules": { 17 | "prettier/prettier": 2 18 | } 19 | } -------------------------------------------------------------------------------- /.github/actions/install_and_cache_dependencies/action.yml: -------------------------------------------------------------------------------- 1 | name: Install dependencies 2 | author: Johannes L. Borresen 3 | runs: 4 | using: composite 5 | steps: 6 | - name: Setup Node.js 7 | 8 | uses: actions/setup-node@v3.8.1 9 | with: 10 | node-version: "19" 11 | 12 | # The steps that have been commented out are specific for caching the PNPM 13 | # store (central dependency cache) between builds. It has been kept in case 14 | # you want to use it. 15 | 16 | # - name: Setup pnpm 17 | # uses: pnpm/action-setup@v2.4.0 18 | # with: 19 | # run_install: false 20 | 21 | # - name: Detect PNPM store directory 22 | # shell: bash 23 | # run: | 24 | # echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV 25 | 26 | # - name: Setup cache 27 | # uses: actions/cache@v3 28 | # with: 29 | # path: ${{ env.STORE_PATH }} 30 | # key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} 31 | # restore-keys: | 32 | # ${{ runner.os }}-pnpm-store- 33 | 34 | # Note: if caching is re-introduced, avoid use of `npm ci` as this command 35 | # removes node_modules before running. 36 | - name: Install dependencies 37 | shell: bash 38 | run: npm i -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | # This file's workflow invokes changesets to generate and publish a release. 2 | # If pushing to the master branch, the changesets action is used to maintain a 3 | # release-specific pull request, and trigger an actual release if that PR is 4 | # merged. 5 | # If pushing to develop, a snapshot release is published to the @develop tag 6 | # instead. 7 | 8 | name: Release 9 | on: 10 | push: 11 | branches: 12 | - master 13 | - develop 14 | 15 | permissions: write-all 16 | 17 | jobs: 18 | # Run unit tests by calling the workflow in unit_tests.yml 19 | unit_tests: 20 | name: Unit tests 21 | uses: ./.github/workflows/unit_tests.yml 22 | 23 | release: 24 | name: Release 25 | runs-on: ubuntu-latest 26 | # needs: unit_tests # Release step will ONLY run if unit tests complete. 27 | steps: 28 | - name: Checkout 29 | uses: actions/checkout@v4 30 | 31 | - name: Setup (cache, dependencies) 32 | uses: ./.github/actions/install_and_cache_dependencies 33 | 34 | - name: Build 35 | run: npm run build 36 | 37 | # For stable branch, use changeset action to maintain a PR and finally 38 | # publish when appropriate. 39 | - name: Create release (or Pull Request) 40 | if: github.ref_name == 'master' 41 | uses: changesets/action@v1 42 | env: 43 | NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 44 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 45 | with: 46 | publish: npm run release 47 | 48 | # Snapshot releases don't need the changeset action to put together PRs. 49 | - name: Create snapshot release 50 | if: github.ref_name == 'develop' 51 | env: 52 | NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 53 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 54 | run: | 55 | echo //registry.npmjs.org/:_authToken=${NPM_TOKEN} > .npmrc 56 | npm run build 57 | npx changeset version --snapshot develop 58 | npx changeset publish --tag develop 59 | -------------------------------------------------------------------------------- /.github/workflows/unit_tests.yml: -------------------------------------------------------------------------------- 1 | 2 | name: Unit Tests 3 | on: 4 | pull_request: 5 | branches: 6 | - develop 7 | workflow_call: 8 | inputs: 9 | unused: 10 | type: boolean 11 | description: Unused, but it seems you must define *something* for workflow_call. 12 | 13 | jobs: 14 | test: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - name: Checkout 18 | uses: actions/checkout@v4 19 | 20 | - name: Setup (cache, dependencies) 21 | uses: ./.github/actions/install_and_cache_dependencies 22 | 23 | - name: Build 24 | run: npm run build 25 | 26 | - name: Test 27 | run: npm test -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /dist 2 | /node_modules 3 | /.yalc 4 | yalc.lock 5 | package-lock.json 6 | qualweb-errors-*.log -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": true, 3 | "trailingComma": "none", 4 | "singleQuote": true, 5 | "printWidth": 120 6 | } -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## [0.7.46] - 23/10/2023 4 | 5 | ### Updated 6 | 7 | - dependencies 8 | 9 | ## [0.7.45] - 19/10/2023 10 | 11 | ### Updated 12 | 13 | - dependencies 14 | 15 | ## [0.7.44] - 28/09/2023 16 | 17 | ### Updated 18 | 19 | - dependencies 20 | 21 | ## [0.7.43] - 27/09/2023 22 | 23 | ### Updated 24 | 25 | - dependencies 26 | 27 | ## [0.7.42] - 26/09/2023 28 | 29 | ### Updated 30 | 31 | - dependencies 32 | 33 | ## [0.7.41] - 19/09/2023 34 | 35 | ### Updated 36 | 37 | - dependencies 38 | 39 | ## [0.7.40] - 07/09/2023 40 | 41 | ### Updated 42 | 43 | - dependencies 44 | 45 | ## [0.7.39] - 05/09/2023 46 | 47 | ### Updated 48 | 49 | - dependencies 50 | 51 | ## [0.7.38] - 04/09/2023 52 | 53 | ### Updated 54 | 55 | - dependencies 56 | 57 | ## [0.7.37] - 18/07/2023 58 | 59 | ### Updated 60 | 61 | - dependencies 62 | 63 | ## [0.7.35] - 07/06/2023 64 | 65 | ### Updated 66 | 67 | - dependencies 68 | 69 | ## [0.7.34] - 30/05/2023 70 | 71 | ### Updated 72 | 73 | - dependencies 74 | 75 | ## [0.7.33] - 08/03/2023 76 | 77 | ### Updated 78 | 79 | - dependencies 80 | 81 | ## [0.7.32] - 01/02/2023 82 | 83 | ### Updated 84 | 85 | - dependencies 86 | 87 | ## [0.7.31] - 17/01/2023 88 | 89 | ### Updated 90 | 91 | - dependencies 92 | 93 | ## [0.7.30] - 17/01/2023 94 | 95 | ### Updated 96 | 97 | - dependencies 98 | 99 | ## [0.7.29] - 11/01/2023 100 | 101 | ### Updated 102 | 103 | - dependencies 104 | 105 | ## [0.7.28] - 29/06/2022 106 | 107 | ### Updated 108 | 109 | - dependencies 110 | 111 | ## [0.7.27] - 28/06/2022 112 | 113 | ### Updated 114 | 115 | - dependencies 116 | 117 | ## [0.7.26] - 26/05/2022 118 | 119 | ### Updated 120 | 121 | - dependencies 122 | 123 | ## [0.7.25] - 26/05/2022 124 | 125 | ### Updated 126 | 127 | - dependencies 128 | 129 | ## [0.7.24] - 23/05/2022 130 | 131 | ### Updated 132 | 133 | - dependencies 134 | 135 | ## [0.7.23] - 23/05/2022 136 | 137 | ### Updated 138 | 139 | - dependencies 140 | 141 | ## [0.7.22] - 19/05/2022 142 | 143 | ### Updated 144 | 145 | - dependencies 146 | 147 | ## [0.7.21] - 12/04/2022 148 | 149 | ### Updated 150 | 151 | - dependencies 152 | 153 | ## [0.7.20] - 28/03/2022 154 | 155 | ### Updated 156 | 157 | - dependencies 158 | 159 | ## [0.7.19] - 21/02/2022 160 | 161 | ### Updated 162 | 163 | - dependencies 164 | 165 | ## [0.7.18] - 01/02/2022 166 | 167 | ### Updated 168 | 169 | - puppeteer from 13.1.2 to 13.1.3 170 | 171 | ## [0.7.17] - 26/01/2022 172 | 173 | ### Updated 174 | 175 | - puppeteer from 10.4.0 to 13.1.2 176 | - @qualweb/evaluation from 0.3.10 to 0.3.11 177 | 178 | ## [0.7.16] - 06/01/2022 179 | 180 | ### Updated 181 | 182 | - dependencies 183 | 184 | ## [0.7.15] - 06/01/2022 185 | 186 | ### Updated 187 | 188 | - dependencies 189 | 190 | ## [0.7.14] - 24/12/2021 191 | 192 | ### Updated 193 | 194 | - dependencies 195 | 196 | ## [0.7.13] - 10/12/2021 197 | 198 | ### Updated 199 | 200 | - dependencies 201 | 202 | ## [0.7.12] - 06/12/2021 203 | 204 | ### Updated 205 | 206 | - @qualweb/locale 207 | 208 | ## [0.7.11] - 03/12/2021 209 | 210 | ### Updated 211 | 212 | - dependencies 213 | 214 | ## [0.7.10] - 15/11/2021 215 | 216 | ### Updated 217 | 218 | - dependencies 219 | 220 | ## [0.7.9] - 28/10/2021 221 | 222 | ### Updated 223 | 224 | - @qualweb/crawler 225 | 226 | ## [0.7.8] - 21/10/2021 227 | 228 | ### Updated 229 | 230 | - dependencies 231 | 232 | ## [0.7.7] - 21/10/2021 233 | 234 | ### Updated 235 | 236 | - crawler method with viewport and waitUntil options 237 | - dependencies 238 | 239 | ## [0.7.6] - 12/10/2021 240 | 241 | ### Updated 242 | 243 | - dependencies 244 | 245 | ## [0.7.5] - 01/10/2021 246 | 247 | ### Updated 248 | 249 | - dependencies 250 | 251 | ## [0.7.4] - 29/09/2021 252 | 253 | ### Added 254 | 255 | - Finnish locale to @qualweb/locale package 256 | 257 | ### Updated 258 | 259 | - dependencies 260 | 261 | ## [0.7.3] - 09/08/2021 262 | 263 | ### Added 264 | 265 | - logging options (log files are now not generated by default) 266 | 267 | ## [0.7.2] - 28/07/2021 268 | 269 | ## BREAKING CHANGES 270 | 271 | - result codes from evaluation modules have changed from "RCx" to "Px" (Passed), "Wx" (Warning), "Fx" (Failed) and "Ix" (Inapplicable) 272 | 273 | ### Updated 274 | 275 | - dependencies 276 | 277 | ## [0.7.1-alpha] - 27/07/2021 278 | 279 | ### Updated 280 | 281 | - localization support 282 | - dependencies 283 | 284 | ## [0.6.14] - 23/07/2021 285 | 286 | ### Updated 287 | 288 | - dependencies 289 | - test files 290 | 291 | ## [0.6.14] - 22/07/2021 292 | 293 | ### Updated 294 | 295 | - dependencies 296 | 297 | ## [0.6.13] - 21/07/2021 298 | 299 | ### Updated 300 | 301 | - dependencies 302 | 303 | ## [0.6.12] - 30/06/2021 304 | 305 | ### Updated 306 | 307 | - dependencies 308 | 309 | ## [0.6.11] - 21/06/2021 310 | 311 | ### Updated 312 | 313 | - dependencies 314 | 315 | ## [0.6.10] - 14/06/2021 316 | 317 | ### Fixed 318 | 319 | - error when using `html` option 320 | 321 | ### Updated 322 | 323 | - dependencies 324 | 325 | ## [0.6.9] - 25/05/2021 326 | 327 | ### Updated 328 | 329 | - dependencies 330 | 331 | ## [0.6.8] - 19/05/2021 332 | 333 | ### Updated 334 | 335 | - dependencies 336 | 337 | ## [0.6.7] - 12/05/2021 338 | 339 | ### Updated 340 | 341 | - dependencies 342 | 343 | ## [0.6.6] - 11/05/2021 344 | 345 | ### Changes 346 | 347 | - qualweb error log file is now deleted if every evaluation succeeded 348 | 349 | ### Updated 350 | 351 | - dependencies 352 | 353 | ## [0.6.5] - 10/05/2021 354 | 355 | ### Updated 356 | 357 | - dependencies 358 | 359 | ## [0.7.0-alpha] - 05/05/2021 360 | 361 | ### Added 362 | 363 | - localization support 364 | 365 | ## [0.6.4] - 03/05/2021 366 | 367 | ### Updated 368 | 369 | - dependencies 370 | 371 | ## [0.6.3-alpha] - 27/04/2021 372 | 373 | ### Updated 374 | 375 | - dependencies 376 | 377 | ## [0.5.7] - 27/04/2021 378 | 379 | ### Updated 380 | 381 | - dependencies 382 | 383 | ## [0.5.6] - 23/04/2021 384 | 385 | ### Updated 386 | 387 | - dependencies 388 | 389 | ## [0.6.2-alpha] - 26/04/2021 390 | 391 | ### Changed 392 | 393 | - qualweb-errors.log to qualweb-errors-.log 394 | - now a new error.log file is created for every call of the evaluate() function 395 | 396 | ## [0.6.1-alpha] - 22/04/2021 397 | 398 | ### Updated 399 | 400 | - @qualweb/types 401 | - README.md 402 | 403 | ## [0.6.0-alpha] - 21/04/2021 404 | 405 | ### Added 406 | 407 | - puppeteer-extra with AdBlocker and Stealth plugins (optional) 408 | - puppeteer-cluster to enable faster evaluations of multiple webpages 409 | 410 | ### Updated 411 | 412 | - puppeteer to version 9.0.0 413 | 414 | ## [0.5.5] - 15/04/2021 415 | 416 | ### Updated 417 | 418 | - dependencies 419 | - code optimizations 420 | 421 | ## [0.5.4] - 13/04/2021 422 | 423 | ### Updated 424 | 425 | - dependencies 426 | - documentation 427 | 428 | ## [0.5.3] - 01/04/2021 429 | 430 | ### Updated 431 | 432 | - dependencies 433 | 434 | ## [0.5.2] - 31/03/2021 435 | 436 | ### Changes 437 | 438 | - Removed QW-ACT-R8 since it was deprecated (https://act-rules.github.io/rules/9eb3f6) 439 | - Changed dom data structure in the final evaluation report 440 | - now it only shows the processed dom information, instead of both source page and processed page 441 | - Removed a lot of third party dependencies on all modules 442 | 443 | ### Updated 444 | 445 | - dependencies 446 | 447 | ## [0.5.1] - 23/03/2021 448 | 449 | ### Added 450 | 451 | - code documentation 452 | 453 | ### Updated 454 | 455 | - earl-reporter 456 | - @qualweb/types 457 | 458 | ## [0.5.0] - 23/03/2021 459 | 460 | ### Updated 461 | 462 | - puppeteer to version 8.0.0 463 | 464 | ## [0.4.69] - 22/03/2021 465 | 466 | ### Updated 467 | 468 | - dependencies 469 | - exported functions 470 | 471 | ## [0.4.68] - 22/03/2021 472 | 473 | ### Updated 474 | 475 | - dependencies 476 | 477 | ## [0.4.67] - 22/03/2021 478 | 479 | ### Updated 480 | 481 | - dependencies 482 | 483 | ### Changed 484 | 485 | ## [0.4.66] - 12/03/2021 486 | 487 | ### Changed 488 | 489 | - downgraded puppeteer from version 8.0.0 to 5.5.0 due to inconsistent certificate validation 490 | 491 | ## [0.4.65] - 11/03/2021 492 | 493 | ### Updated 494 | 495 | - dependencies 496 | - README.md 497 | 498 | ## [0.4.64] - 11/03/2021 499 | 500 | ### Updated 501 | 502 | - dependencies 503 | - README.md 504 | 505 | ## [0.4.63] - 10/03/2021 506 | 507 | ### Updated 508 | 509 | - dependencies 510 | 511 | ## [0.4.62] - 08/03/2021 512 | 513 | ### Updated 514 | 515 | - dependencies 516 | 517 | ## [0.4.61] - 08/03/2021 518 | 519 | ### Updated 520 | 521 | - dependencies 522 | 523 | ## [0.4.60] - 03/03/2021 524 | 525 | ### Updated 526 | 527 | - dependencies 528 | 529 | ## [0.4.59] - 03/03/2021 530 | 531 | ### Added 532 | 533 | - element and role counter 534 | 535 | ## [0.4.58] - 01/03/2021 536 | 537 | ### Updated 538 | 539 | - dependencies 540 | 541 | ## [0.4.57] - 27/02/2021 542 | 543 | ### Updated 544 | 545 | - dependencies 546 | 547 | ## [0.4.56] - 26/02/2021 548 | 549 | ### Updated 550 | 551 | - dependencies 552 | 553 | ## [0.4.55] - 25/02/2021 554 | 555 | ### Updated 556 | 557 | - dependencies 558 | 559 | ## [0.4.54] - 23/02/2021 560 | 561 | ### Updated 562 | 563 | - dependencies 564 | 565 | ## [0.4.53] - 20/02/2021 566 | 567 | ### Updated 568 | 569 | - dependencies 570 | - README.md 571 | 572 | ## [0.4.51] - 08/02/2021 573 | 574 | ### Updated 575 | 576 | - dependencies 577 | 578 | ## [0.4.50] - 25/01/2021 579 | 580 | ### Updated 581 | 582 | - dependencies 583 | 584 | ## [0.4.49] - 25/01/2021 585 | 586 | ### Updated 587 | 588 | - dependencies 589 | 590 | ## [0.4.48] - 25/01/2021 591 | 592 | ### Updated 593 | 594 | - dependencies 595 | 596 | ## [0.4.47] - 23/01/2021 597 | 598 | ### Updated 599 | 600 | - dependencies 601 | 602 | ## [0.4.46] - 11/01/2021 603 | 604 | ### Updated 605 | 606 | - dependencies 607 | 608 | ## [0.4.45] - 06/01/2021 609 | 610 | ### Updated 611 | 612 | - dependencies 613 | 614 | ## [0.4.44] - 06/01/2021 615 | 616 | ### Updated 617 | 618 | - dependencies 619 | 620 | ## [0.4.43] - 16/12/2020 621 | 622 | ### Updated 623 | 624 | - dependencies 625 | 626 | ## [0.4.42] - 10/12/2020 627 | 628 | ### Updated 629 | 630 | - dependencies 631 | 632 | ## [0.4.41] - 1/12/2020 633 | 634 | ### Updated 635 | 636 | - dependencies 637 | 638 | ## [0.4.40] - 09/12/2020 639 | 640 | ### Updated 641 | 642 | - dependencies 643 | 644 | ## [0.4.39] - 11/11/2020 645 | 646 | ### Updated 647 | 648 | - dependencies 649 | 650 | ## [0.4.38] - 11/11/2020 651 | 652 | ### Updated 653 | 654 | - dependencies 655 | 656 | ## [0.4.37] - 10/11/2020 657 | 658 | ### Updated 659 | 660 | - README.md 661 | 662 | ## [0.4.36] - 10/11/2020 663 | 664 | ### Updated 665 | 666 | - dependencies 667 | 668 | ## [0.4.35] - 05/11/2020 669 | 670 | ### Updated 671 | 672 | - dependencies 673 | 674 | ## [0.4.34] - 02/11/2020 675 | 676 | ### Updated 677 | 678 | - dependencies 679 | 680 | ## [0.4.33] - 21/10/2020 681 | 682 | ### Updated 683 | 684 | - dependencies 685 | 686 | ## [0.4.32] - 15/10/2020 687 | 688 | ### Updated 689 | 690 | - dependencies 691 | 692 | ## [0.4.31] - 12/10/2020 693 | 694 | ### Updated 695 | 696 | - tsconfig.json 697 | 698 | ## [0.4.30] - 12/10/2020 699 | 700 | ### Updated 701 | 702 | - dependencies 703 | 704 | ## [0.4.29] - 08/10/2020 705 | 706 | ### Updated 707 | 708 | - dependencies 709 | 710 | ## [0.4.28] - 08/10/2020 711 | 712 | ### Updated 713 | 714 | - dependencies 715 | - code refactor 716 | - tests 717 | 718 | ## [0.4.27] - 03/10/2020 719 | 720 | ### Updated 721 | 722 | - dependencies 723 | - core interface 724 | 725 | ## [0.4.26] - 29/09/2020 726 | 727 | ### Updated 728 | 729 | - dependencies 730 | 731 | ## [0.4.25] - 23/09/2020 732 | 733 | ### Updated 734 | 735 | - deleted logs 736 | 737 | ## [0.4.24] - 23/09/2020 738 | 739 | ### Updated 740 | 741 | - dom and evaluation dependencies 742 | 743 | ## [0.4.23] - 23/09/2020 744 | 745 | ### Updated 746 | 747 | - dom and evaluation dependencies 748 | 749 | ## [0.4.22] - 23/09/2020 750 | 751 | ### Updated 752 | 753 | - dom and evaluation dependencies 754 | 755 | ## [0.4.21] - 23/09/2020 756 | 757 | ### Updated 758 | 759 | - dom and evaluation dependencies 760 | 761 | ## [0.4.20] - 18/09/2020 762 | 763 | ### Updated 764 | 765 | - dom and evaluation dependencies 766 | 767 | ## [0.4.19] - 16/09/2020 768 | 769 | ### Updated 770 | 771 | - dom and evaluation dependencies 772 | 773 | ## [0.4.18] - 07/09/2020 774 | 775 | ### Updated 776 | 777 | - dependencies 778 | 779 | ## [0.4.17] - 25/08/2020 780 | 781 | ### Updated 782 | 783 | - dependencies 784 | 785 | ## [0.4.16] - 16/08/2020 786 | 787 | ### Updated 788 | 789 | - dependencies 790 | 791 | ## [0.4.15] - 06/08/2020 792 | 793 | ### Updated 794 | 795 | - dependencies 796 | 797 | ## [0.4.14] - 29/07/2020 798 | 799 | ### Updated 800 | 801 | - dependencies 802 | 803 | ## [0.4.13] - 28/07/2020 804 | 805 | ### Updated 806 | 807 | - dependencies 808 | 809 | ## [0.4.12] - 27/07/2020 810 | 811 | ### Updated 812 | 813 | - dependencies 814 | 815 | ## [0.4.11] - 11/07/2020 816 | 817 | ### Updated 818 | 819 | - dependencies 820 | 821 | ## [0.4.10] - 11/07/2020 822 | 823 | ### Updated 824 | 825 | - dependencies 826 | 827 | ## [0.4.10] - 03/07/2020 828 | 829 | ### Updated 830 | 831 | - dependencies 832 | 833 | ## [0.4.9] - 03/07/2020 834 | 835 | ### Updated 836 | 837 | - dependencies 838 | - code optimization 839 | 840 | ## [0.4.8] - 25/06/2020 841 | 842 | ### Fixed 843 | 844 | - Updated dependencies 845 | 846 | ## [0.4.7] - 25/06/2020 847 | 848 | ### Fixed 849 | 850 | - Updated dependencies 851 | 852 | ## [0.4.6] - 23/06/2020 853 | 854 | ### Fixed 855 | 856 | - Updated dependencies 857 | 858 | ## [0.4.5] - 21/06/2020 859 | 860 | ### Fixed 861 | 862 | - Updated dependencies 863 | 864 | ## [0.4.4] - 18/06/2020 865 | 866 | ### Fixed 867 | 868 | - Updated dependencies 869 | 870 | ## [0.4.3] - 08/06/2020 871 | 872 | ### Fixed 873 | 874 | - Updated dependencies 875 | 876 | ## [0.4.2] - 08/06/2020 877 | 878 | ### Fixed 879 | 880 | - Updated dependencies and added evaluate and dom 881 | 882 | ## [0.4.1] - 15/05/2020 883 | 884 | ### Fixed 885 | 886 | - qwPage.js dependency path 887 | 888 | ## [0.4.0] - 15/05/2020 889 | 890 | ### Updated 891 | 892 | - evaluation modules 893 | - architecture 894 | 895 | ## [0.3.20] - 07/05/2020 896 | 897 | ### Downgraded 898 | 899 | - @qualweb/crawler to version 0.1.1 before the keyboard event 900 | 901 | ## [0.3.19] - 06/05/2020 902 | 903 | ### Added 904 | 905 | - new input method: plain html 906 | 907 | ## [0.3.18] - 06/05/2020 908 | 909 | ### Updated 910 | 911 | - dependencies 912 | - tests 913 | - README.md 914 | 915 | ## [0.3.16] - 22/03/2020 916 | 917 | ### Updated 918 | 919 | - act-rules module 920 | - puppeteer to version 3 921 | - the way qualweb obtains the page source html 922 | 923 | ## [0.3.16] - 19/03/2020 924 | 925 | ### Updated 926 | 927 | - act-rules module 928 | 929 | ## [0.3.15] - 18/03/2020 930 | 931 | ### Updated 932 | 933 | - act-rules module 934 | - html-techniques module 935 | 936 | ## [0.3.14] - 21/02/2020 937 | 938 | ### Updated 939 | 940 | - act-rules module 941 | 942 | ## [0.3.13] - 17/02/2020 943 | 944 | ### Updated 945 | 946 | - act-rules module 947 | - system and modules manager 948 | 949 | ## [0.3.12] - 22/01/2020 950 | 951 | ### Updated 952 | 953 | - act-rules module 954 | 955 | ## [0.3.11] - 22/01/2020 956 | 957 | ### Updated 958 | 959 | - earl-reporter module 960 | 961 | ## [0.3.10] - 21/01/2020 962 | 963 | ### Updated 964 | 965 | - act-rules module 966 | - earl-reporter module 967 | 968 | ## [0.3.9] - 17/01/2020 969 | 970 | ### Updated 971 | 972 | - act-rules module 973 | - css-techniques module 974 | - best-practices module 975 | - earl-reporter module 976 | 977 | ## [0.3.8] - 15/01/2020 978 | 979 | ### Updated 980 | 981 | - act-rules module 982 | 983 | ## [0.3.7] - 14/01/2020 984 | 985 | ### Updated 986 | 987 | - act-rules module 988 | - README.md 989 | 990 | ## [0.3.6] - 14/01/2020 991 | 992 | ### Updated 993 | 994 | - act-rules module 995 | - README.md 996 | 997 | ## [0.3.5] - 13/01/2020 998 | 999 | ### Updated 1000 | 1001 | - act-rules module 1002 | 1003 | ## [0.3.4] - 09/01/2020 1004 | 1005 | ### Updated 1006 | 1007 | - act-rules module 1008 | 1009 | ## [0.3.3] - 08/01/2020 1010 | 1011 | ### Fixed 1012 | 1013 | - some bugs 1014 | 1015 | ## [0.3.2] - 08/01/2020 1016 | 1017 | ### Updated 1018 | 1019 | - act-rules module 1020 | 1021 | ## [0.3.1] - 08/01/2020 1022 | 1023 | ### Fixed 1024 | 1025 | - a bug with the inpage stylesheets 1026 | 1027 | ## [0.3.0] - 08/01/2020 1028 | 1029 | ### Updated 1030 | 1031 | - act-rules module 1032 | - README.md 1033 | 1034 | ## [0.2.17] - 07/01/2020 1035 | 1036 | ### Fixed 1037 | 1038 | - some bugs 1039 | 1040 | ## [0.2.16] - 07/01/2020 1041 | 1042 | ### Fixed 1043 | 1044 | - some bugs 1045 | 1046 | ## [0.2.15] - 07/01/2020 1047 | 1048 | ### Updated 1049 | 1050 | - act-rules module 1051 | - type definitions 1052 | 1053 | ## [0.2.15] - 07/01/2020 1054 | 1055 | ### Updated 1056 | 1057 | - act-rules module 1058 | 1059 | ### Fixed 1060 | 1061 | - some bugs 1062 | 1063 | ## [0.2.14] - 07/01/2020 1064 | 1065 | ### Updated 1066 | 1067 | - act-rules module 1068 | 1069 | ## [0.2.13] - 06/01/2020 1070 | 1071 | ### Updated 1072 | 1073 | - act-rules module 1074 | 1075 | ## [0.2.12] - 18/12/2019 1076 | 1077 | ### Fixed 1078 | 1079 | - code optimization 1080 | 1081 | ### Updated 1082 | 1083 | - dependencies 1084 | 1085 | ## [0.2.11] - 18/12/2019 1086 | 1087 | ### Fixed 1088 | 1089 | - code optimization 1090 | 1091 | ## [0.2.10] - 18/12/2019 1092 | 1093 | ### Fixed 1094 | 1095 | - some core bugs 1096 | - code optimization 1097 | 1098 | ### Updated 1099 | 1100 | - @qualweb/types module 1101 | 1102 | ## [0.2.9] - 16/12/2019 1103 | 1104 | ### Updated 1105 | 1106 | - css-techniques module 1107 | - best-practices module 1108 | 1109 | ## [0.2.8] - 11/12/2019 1110 | 1111 | ### Updated 1112 | 1113 | - css-techniques module 1114 | - best-practices module 1115 | 1116 | ## [0.2.7] - 09/12/2019 1117 | 1118 | ### Updated 1119 | 1120 | - html-techniques module 1121 | 1122 | ## [0.2.6] - 05/12/2019 1123 | 1124 | ### Updated 1125 | 1126 | - html-techniques module 1127 | 1128 | ## [0.2.5] - 05/12/2019 1129 | 1130 | ### Updated 1131 | 1132 | - html-techniques module 1133 | 1134 | ## [0.2.4] - 04/12/2019 1135 | 1136 | ### Updated 1137 | 1138 | - act-rules module 1139 | 1140 | ## [0.2.3] - 03/12/2019 1141 | 1142 | ### Fixed 1143 | 1144 | - processed html not being added to the final report 1145 | 1146 | ## [0.2.2] - 03/12/2019 1147 | 1148 | ### Fixed 1149 | 1150 | - a bug that counted and empty space ("") as an url when parsing a file with urls 1151 | 1152 | ## [0.2.1] - 02/12/2019 1153 | 1154 | ### Fixed 1155 | 1156 | - maxParallelEvations parameter 1157 | 1158 | ## [0.2.0] - 02/12/2019 1159 | 1160 | ### Updated 1161 | 1162 | - evaluation modules 1163 | - architecture 1164 | - types 1165 | 1166 | ## [0.1.10] - 20/11/2019 1167 | 1168 | ### Updated 1169 | 1170 | - best-practices package 1171 | 1172 | ## [0.1.9] - 20/11/2019 1173 | 1174 | ### Updated 1175 | 1176 | - html-techniques package 1177 | 1178 | ## [0.1.8] - 20/11/2019 1179 | 1180 | ### Updated 1181 | 1182 | - best-practices package 1183 | - html-techniques package 1184 | 1185 | ## [0.1.7] - 19/11/2019 1186 | 1187 | ### Updated 1188 | 1189 | - get-dom-puppeteer package 1190 | 1191 | ## [0.1.6] - 29/10/2019 1192 | 1193 | ### Updated 1194 | 1195 | - act-rules module 1196 | 1197 | ## [0.1.5] - 29/10/2019 1198 | 1199 | ### Updated 1200 | 1201 | - act-rules module 1202 | 1203 | ## [0.1.4] - 29/10/2019 1204 | 1205 | ### Updated 1206 | 1207 | - act-rules module 1208 | 1209 | ## [0.1.3] - 29/10/2019 1210 | 1211 | ### Updated 1212 | 1213 | - act-rules module with more implemented rules 1214 | 1215 | ## [0.1.2] - 14/10/2019 1216 | 1217 | ### Fixed 1218 | 1219 | - dependencies bugs 1220 | 1221 | ## [0.1.1] - 14/10/2019 1222 | 1223 | ### Fixed 1224 | 1225 | - a bug where two evaluations followed were giving incorrect results 1226 | 1227 | ## [0.1.0] - 14/10/2019 1228 | 1229 | ### Added 1230 | 1231 | - options to run specific modules 1232 | - option to continue running evaluations even if any url fails to evaluate 1233 | 1234 | ## [0.0.6] - 07/10/2019 1235 | 1236 | ### Changed 1237 | 1238 | - core architecture 1239 | 1240 | ### Updated 1241 | 1242 | - act-rules module 1243 | - html-techniques module 1244 | 1245 | ## [0.0.5] - 17/09/2019 1246 | 1247 | ### Added 1248 | 1249 | - module "html-techniques" 1250 | - module "css-techniques" 1251 | - module "best-practices" 1252 | 1253 | ### Updated 1254 | 1255 | - package @qualweb/get-dom-puppeteer to version 0.0.4 1256 | - package @qualweb/types to version 0.0.24 1257 | - package @qualweb/earl-reporter to version 0.0.4 1258 | 1259 | ## [0.0.4] - 12/09/2019 1260 | 1261 | ### Added 1262 | 1263 | - Dom interface to the evaluation report 1264 | 1265 | ## [0.0.3] - 12/08/2019 1266 | 1267 | ### Added 1268 | 1269 | - "mocha" framework 1270 | 1271 | ### Changed 1272 | 1273 | - access to dom object from the @qualweb/get-dom-puppeteer module 1274 | 1275 | ### Updated 1276 | 1277 | - package @qualweb/types to version 0.0.32 1278 | - package @qualweb/get-dom-puppeteer to version 0.0.2 1279 | - package @qualweb/earl-reporter to version 0.0.3 1280 | - package @qualweb/act-rules to version 0.0.3 1281 | - package @qualweb/wappalyzer to version 0.0.2 1282 | - package @types/node to version 12.7.1 1283 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | ISC License 2 | 3 | Copyright (c) 2022, FCUL 4 | 5 | Permission to use, copy, modify, and/or distribute this software for any 6 | purpose with or without fee is hereby granted, provided that the above 7 | copyright notice and this permission notice appear in all copies. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | This repository has been archived. QualWeb is now being maintained in a monorepo at https://github.com/qualweb/qualweb 2 | 3 | # QualWeb core(updated version in our new monorepo https://github.com/qualweb/qualweb) 4 | 5 | The core allows you to perform automatic accessibility evaluations on web pages. It contains 3 evaluation modules: 6 | 7 | - [@qualweb/act-rules](https://github.com/qualweb/act-rules) 8 | - [@qualweb/wcag-techniques](https://github.com/qualweb/wcag-techniques) 9 | - [@qualweb/best-practices](https://github.com/qualweb/best-practices) 10 | 11 | You can also perform evaluations at [http://qualweb.di.fc.ul.pt/evaluator/](http://qualweb.di.fc.ul.pt/evaluator/), or by installing the [chrome extension](https://chrome.google.com/webstore/detail/qualweb-extension/ljgilomdnehokancdcbkmbndkkiggioc). 12 | 13 | ## How to install 14 | 15 | ```shell 16 | $ npm i @qualweb/core --save 17 | ``` 18 | 19 | ## How to run 20 | 21 | ```javascript 22 | 'use strict'; 23 | 24 | const { QualWeb, generateEARLReport } = require('@qualweb/core'); 25 | 26 | (async () => { 27 | const plugins = { 28 | // Check https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-adblocker 29 | adBlock: true, // Default value = false 30 | // Check https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth 31 | stealth: true // Default value = false 32 | }; 33 | const qualweb = new QualWeb(plugins); 34 | 35 | const clusterOptions = { 36 | maxConcurrency: 5, // Performs several urls evaluations at the same time - the higher the number given, more resources will be used. Default value = 1 37 | timeout: 60 * 1000, // Timeout for loading page. Default value = 30 seconds 38 | monitor: true // Displays urls information on the terminal. Default value = false 39 | }; 40 | 41 | const launchOptions = { 42 | ... // check https://github.com/puppeteer/puppeteer/blob/v10.1.0/docs/api.md#puppeteerlaunchoptions 43 | // In most cases there's no need to give additional options. Just leave the field undefined 44 | }; 45 | 46 | // Starts the QualWeb core engine 47 | await qualweb.start(clusterOptions, launchOptions); 48 | 49 | // QualWeb evaluation report 50 | const qualwebOptions = { 51 | url: 'https://act-rules.github.io/pages/about/', 52 | ... 53 | }; 54 | 55 | // Evaluates the given options - will only return after all urls have finished evaluating or resulted in an error 56 | const reports = await qualweb.evaluate(qualwebOptions); 57 | 58 | console.log(reports); 59 | // { 60 | // "url": "report", 61 | // "url2": "report2" 62 | // } 63 | 64 | // Stops the QualWeb core engine 65 | await qualweb.stop(); 66 | 67 | const earlOptions = { 68 | // Check the options in the section below 69 | }; 70 | 71 | // if you want an EARL report 72 | const earlReports = generateEARLReport(reports, earlOptions); 73 | 74 | console.log(earlReports); 75 | // { 76 | // "url": "earlReport", 77 | // "url2": "earlReport2" 78 | // } 79 | })(); 80 | ``` 81 | 82 | ## Options 83 | 84 | The available options fot the **evaluate()** function are: 85 | 86 | ```jsonc 87 | { 88 | "url": "https://act-rules.github.io/pages/about/", // url to evaluate 89 | "urls": ["https://act-rules.github.io/pages/about/", "https://act-rules.github.io/rules/"], // Array of urls 90 | "file": "/path/to/file/with/urls", // urls must be separated by a newline (\n) 91 | "crawl": "https://act-rules.github.io", // Domain to crawl and obtain the urls 92 | "html": "", // Full webpage html, or just small snippets 93 | "log": { 94 | "file": true, // Logs errors to a file. Default value = false 95 | "console": false // Logs errors to the console. Default value = false 96 | }, 97 | "viewport": { 98 | "mobile": false, // default value = false 99 | "landscape": true, // default value = viewPort.width > viewPort.height 100 | "userAgent": "custom user agent", // default value for desktop = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:22.0) Gecko/20100101 Firefox/22.0', default value for mobile = 'Mozilla/5.0 (Linux; U; Android 2.2; en-us; DROID2 GLOBAL Build/S273) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1' 101 | "resolution": { 102 | "width": 1920, // default value for desktop = 1366, default value for mobile = 1080 103 | "height": 1080 // default value for desktop = 768, default value for mobile = 1920 104 | } 105 | }, 106 | "waitUntil": ["load", "networkidle0"], // Events to wait before starting evaluation, default value = "load". For more check https://github.com/puppeteer/puppeteer/blob/v10.1.0/docs/api.md#pagegotourl-options 107 | "validator": "http://127.0.0.1/validate", // HTML validator service endpoint. The url will be attached after of the given endpoint 108 | "crawlOptions": { 109 | "maxDepth": 2, // max depth to search, 0 to search only the given domain. Default value = -1 (search everything) 110 | "maxUrls": 100, // max urls to find. Default value = -1 (search everything) 111 | "timeout": 60, // how many seconds the domain should be crawled before it ends. Default value = -1 (never stops) 112 | "maxParallelCrawls": 10, // max urls to crawl at the same time. Default value = 5 113 | "logging": true // logs domain, current depth, urls found and time passed to the terminal 114 | }, 115 | "translate": "en", // OR { "translate": "en", "fallback": "en" } OR { own translation object } check https://github.com/qualweb/locale#readme. Default = "en" 116 | "execute": { 117 | // choose which modules to execute 118 | // if this option is not specified, the default values below will be applied, otherwise unspecified values will default to false 119 | "wappalyzer": false, // wappalyzer module (https://github.com/qualweb/wappalyzer) 120 | "act": true, // act-rules module (https://github.com/qualweb/act-rules) 121 | "wcag": true, // wcag-techniques module (https://github.com/qualweb/wcag-techniques) 122 | "bp": false, // best-practices module (https://github.com/qualweb/best-practices) 123 | "counter": false // counter module (https://github.com/qualweb/counter) 124 | }, 125 | "act-rules": { 126 | // More information about this options at https://github.com/qualweb/act-rules 127 | "rules": ["QW-ACT-R1", "b5c3f8"], // Array of rules to execute, can be passed the QualWeb Rule ID or the ACT Rule ID 128 | "exclude": ["QW-ACT-R1", "b5c3f8"], // Array of rules to exclude, can be passed the QualWeb Rule ID or the ACT Rule ID 129 | "levels": ["A", "AA", "AAA"], // Conformance levels to execute, 130 | "principles": ["Perceivable", "Operable", "Understandable", "Robust"] // Principles to execute 131 | }, 132 | "wcag-techniques": { 133 | // More information about this options at https://github.com/qualweb/wcag-techniques 134 | "techniques": ["QW-WCAG-T1", "H39"], // Array of techniques to execute, can be passed the QualWeb Technique ID or the WCAG 2.1 Technique Code 135 | "exclude": ["QW-WCAG-T1", "H39"], // Array of techniques to exclude, can be passed the QualWeb Technique ID or the WCAG 2.1 Technique Code 136 | "levels": ["A", "AA", "AAA"], // Conformance levels to execute, 137 | "principles": ["Perceivable", "Operable", "Understandable", "Robust"] // Principles to execute 138 | }, 139 | "best-practices": { 140 | // More information about this options at https://github.com/qualweb/best-practices 141 | "bestPractices": ["QW-BP1", "QW-BP2"], // Array of best practices to execute 142 | "exclude": ["QW-BP1", "QW-BP2"] // Array of best practices to exclude 143 | } 144 | } 145 | ``` 146 | 147 | The available options fot the **generateEARLReport()** function are: 148 | 149 | ```jsonc 150 | { 151 | "aggregated": true, // default value = false 152 | "aggregatedName": "websites.json", // The name to save the aggregated earl reports. default value = first url of the list 153 | "modules": { 154 | // Choose which modules to convert the report to earl, by default all modules are converted if they were executed 155 | "act": true, // default value = true 156 | "wcag": false, // default value = true 157 | "best-practices": false // default value = true 158 | } // If the "modules" value is given, any missing module value missing it's automatically set to false 159 | } 160 | ``` 161 | 162 | ## Report details 163 | 164 | In this section it's explained the evaluation report in detail. For a detailed version of the EARL report check [@qualweb/earl-reporter](https://github.com/qualweb/earl-reporter#report-details). 165 | 166 | ```jsonc 167 | { 168 | "type": "evaluation", 169 | "system": { 170 | "name": "QualWeb", 171 | "description": "QualWeb is an automatic accessibility evaluator for webpages.", 172 | "version": "QualWeb version", 173 | "homepage": "http://www.qualweb.di.fc.ul.pt/", 174 | "date": "date of the evaluation", 175 | "hash": "unique hash", 176 | "url": { 177 | "inputUrl": "inserted url", 178 | "protocol": "protocol of the url", 179 | "domainName": "domain name of the url", 180 | "domain": "domain of the url", 181 | "uri": "uri of the url", 182 | "completeUrl": "complete url after all redirects" 183 | }, 184 | "page": { 185 | "viewport": { 186 | "mobile": "was evaluated on a mobile context or not", 187 | "landscape": "was evaluated on a landscape context or not", 188 | "userAgent": "user agent used", 189 | "resolution": { 190 | "width": "window's width used", 191 | "height": "window's height used", 192 | } 193 | }, 194 | "dom": { 195 | "html": "html code as a string", 196 | "title": "Title of the webpage", 197 | "elementCount": "Element count of the webpage" 198 | } 199 | } 200 | }, 201 | "metadata": { 202 | "passed": "number of passed rules/techniques/best practices", 203 | "warning": "number of warning rules/techniques/best practices", 204 | "failed": "number of failed rules/techniques/best practices", 205 | "inapplicable": "number of inapplicable rules/techniques/best practices", 206 | }, 207 | "modules": { 208 | "act-rules": { 209 | "type": "act-rules", 210 | "metadata": { 211 | "passed": "number of passed rules", 212 | "warning": "number of warning rules", 213 | "failed": "number of failed rules", 214 | "inapplicable": "number of inapplicable rules", 215 | }, 216 | "assertions": { 217 | "QW_ACT_R1": { 218 | "name": "Name of the rule", 219 | "code": "QualWeb rule id", 220 | "mapping": "ACT rule id mapping", 221 | "description": "Description of the rule", 222 | "metadata": { 223 | "target": "Any target, can be one element, multiple elements, attributes, a relation between elements", 224 | "success-criteria?": [ 225 | { 226 | "name": "Name of the success criteria", 227 | "level": "Level of conformance of the success criteria", 228 | "principle": "Principle of the success criteria", 229 | "url": "Url of the success criteria" 230 | } 231 | ], 232 | "related?": [], // related WCAG 2.1 techniques 233 | "url?": "Url of the rule", 234 | "passed": "Number of passed results", 235 | "warning": "Number of warning results", 236 | "failed": "Number ff failed results", 237 | "type?": [], // usually "ACTRule" or "TestCase" 238 | "a11yReq?": [], // WCAG 2.1 relation - something like "WCAG21:language" 239 | "outcome": "Outcome of the rule", 240 | "description": "Description of the outcome"; 241 | }, 242 | "results": [ 243 | { 244 | "verdict": "Outcome of the test", 245 | "description": "Description of the test", 246 | "resultCode": "Test identifier", 247 | "pointer?": "Element pointer in CSS notation", 248 | "htmlCode?": "Element html code", 249 | "attributes?": "Attributes of the element", 250 | "accessibleName?": "Accessible name of the test target" 251 | }, 252 | { ... } 253 | ] 254 | }, 255 | "...": { ... } 256 | } 257 | }, 258 | "wcag-techniques": { 259 | "type": "wcag-techniques", 260 | "metadata": { 261 | "passed": "number of passed techniques", 262 | "warning": "number of warning techniques", 263 | "failed": "number of failed techniques", 264 | "inapplicable": "number of inapplicable techniques", 265 | }, 266 | "assertions": { 267 | "QW_WCAG_T1": { 268 | "name": "Name of the technique", 269 | "code": "QualWeb technique id", 270 | "mapping": "WCAG techniques code mapping", 271 | "description": "Description of the technique", 272 | "metadata": { 273 | "target": "Any target, can be one element, multiple elements, attributes, a relation between elements", 274 | "success-criteria?": [ 275 | { 276 | "name": "Name of the success criteria", 277 | "level": "Level of conformance of the success criteria", 278 | "principle": "Principle of the success criteria", 279 | "url": "Url of the success criteria" 280 | } 281 | ], 282 | "related?": [], // related WCAG 2.1 techniques 283 | "url?": "Url of the technique", 284 | "passed": "Number of passed results", 285 | "warning": "Number of warning results", 286 | "failed": "Number ff failed results", 287 | "type?": [], // usually "ACTRule" or "TestCase" 288 | "a11yReq?": [], // WCAG 2.1 relation - something like "WCAG21:language" 289 | "outcome": "Outcome of the technique", 290 | "description": "Description of the outcome"; 291 | }, 292 | "results": [ 293 | { 294 | "verdict": "Outcome of the test", 295 | "description": "Description of the test", 296 | "resultCode": "Test identifier", 297 | "pointer?": "Element pointer in CSS notation", 298 | "htmlCode?": "Element html code", 299 | "attributes?": "Attributes of the element" // if available 300 | }, 301 | { ... } 302 | ] 303 | }, 304 | "...": { ... } 305 | } 306 | }, 307 | "best-practices": { 308 | "type": "best-practices", 309 | "metadata": { 310 | "passed": "number of passed best practices", 311 | "warning": "number of warning best practices", 312 | "failed": "number of failed best practices", 313 | "inapplicable": "number of inapplicable best practices", 314 | }, 315 | "assertions": { 316 | "QW_BP1": { 317 | "name": "Name of the technique", 318 | "code": "QualWeb best practices id", 319 | "description": "Description of the best practices", 320 | "metadata": { 321 | "target": "Any target, can be one element, multiple elements, attributes, a relation between elements", 322 | "success-criteria?": [ 323 | { 324 | "name": "Name of the success criteria", 325 | "level": "Level of conformance of the success criteria", 326 | "principle": "Principle of the success criteria", 327 | "url": "Url of the success criteria" 328 | } 329 | ], 330 | "related?": [], // related WCAG 2.1 techniques 331 | "passed": "Number of passed results", 332 | "warning": "Number of warning results", 333 | "failed": "Number ff failed results", 334 | "type?": [], // usually "ACTRule" or "TestCase" 335 | "a11yReq?": [], // WCAG 2.1 relation - something like "WCAG21:language" 336 | "outcome": "Outcome of the best practices", 337 | "description": "Description of the outcome"; 338 | }, 339 | "results": [ 340 | { 341 | "verdict": "Outcome of the test", 342 | "description": "Description of the test", 343 | "resultCode": "Test identifier", 344 | "pointer?": "Element pointer in CSS notation", 345 | "htmlCode?": "Element html code", 346 | "attributes?": "Attributes of the element" // if available 347 | }, 348 | { ... } 349 | ] 350 | }, 351 | "...": { ... } 352 | } 353 | }, 354 | "counter": { 355 | "type": "counter", 356 | "data": { 357 | "roles": { 358 | "button": 2, 359 | "link": 4, 360 | ... 361 | }, 362 | "tags": { 363 | "div": 10, 364 | "table": 3, 365 | ... 366 | } 367 | } 368 | } 369 | } 370 | } 371 | ``` 372 | 373 | ## Implemented ACT Rules 374 | 375 | | QualWeb Rule ID | ACT Rule ID | ACT Rule Name | 376 | | --------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------- | 377 | | QW-ACT-R1 | [2779a5](https://act-rules.github.io/rules/2779a5) | HTML Page has a title | 378 | | QW-ACT-R2 | [b5c3f8](https://act-rules.github.io/rules/b5c3f8) | HTML has lang attribute | 379 | | QW-ACT-R3 | [5b7ae0](https://act-rules.github.io/rules/5b7ae0) | HTML lang and xml:lang match | 380 | | QW-ACT-R4 | [bc659a](https://act-rules.github.io/rules/bc659a) | Meta-refresh no delay | 381 | | QW-ACT-R5 | [bf051a](https://act-rules.github.io/rules/bf051a) | Validity of HTML Lang attribute | 382 | | QW-ACT-R6 | [59796f](https://act-rules.github.io/rules/59796f) | Image button has accessible name | 383 | | QW-ACT-R7 | [b33eff](https://act-rules.github.io/rules/b33eff) | Orientation of the page is not restricted using CSS transform property | 384 | | QW-ACT-R9 | [b20e66](https://act-rules.github.io/rules/b20e66) | Links with identical accessible names have equivalent purpose | 385 | | QW-ACT-R10 | [4b1c6c](https://act-rules.github.io/rules/4b1c6c) | `iframe` elements with identical accessible names have equivalent purpose | 386 | | QW-ACT-R11 | [97a4e1](https://act-rules.github.io/rules/97a4e1) | Button has accessible name | 387 | | QW-ACT-R12 | [c487ae](https://act-rules.github.io/rules/c487ae) | Link has accessible name | 388 | | QW-ACT-R13 | [6cfa84](https://act-rules.github.io/rules/6cfa84) | Element with `aria-hidden` has no focusable content | 389 | | QW-ACT-R14 | [b4f0c3](https://act-rules.github.io/rules/b4f0c3) | meta viewport does not prevent zoom | 390 | | QW-ACT-R15 | [80f0bf](https://act-rules.github.io/rules/80f0bf) | audio or video has no audio that plays automatically | 391 | | QW-ACT-R16 | [e086e5](https://act-rules.github.io/rules/e086e5) | Form control has accessible name | 392 | | QW-ACT-R17 | [23a2a8](https://act-rules.github.io/rules/23a2a8) | Image has accessible name | 393 | | QW-ACT-R18 | [3ea0c8](https://act-rules.github.io/rules/3ea0c8) | `id` attribute value is unique | 394 | | QW-ACT-R19 | [cae760](https://act-rules.github.io/rules/cae760) | iframe element has accessible name | 395 | | QW-ACT-R20 | [674b10](https://act-rules.github.io/rules/674b10) | role attribute has valid value | 396 | | QW-ACT-R21 | [7d6734](https://act-rules.github.io/rules/7d6734) | svg element with explicit role has accessible name | 397 | | QW-ACT-R22 | [de46e4](https://act-rules.github.io/rules/de46e4) | Element within body has valid lang attribute | 398 | | QW-ACT-R23 | [c5a4ea](https://act-rules.github.io/rules/c5a4ea) | video element visual content has accessible alternative | 399 | | QW-ACT-R24 | [73f2c2](https://act-rules.github.io/rules/73f2c2) | autocomplete attribute has valid value | 400 | | QW-ACT-R25 | [5c01ea](https://act-rules.github.io/rules/5c01ea) | ARIA state or property is permitted | 401 | | QW-ACT-R26 | [eac66b](https://act-rules.github.io/rules/eac66b) | video element auditory content has accessible alternative | 402 | | QW-ACT-R27 | [5f99a7](https://act-rules.github.io/rules/5f99a7) | This rule checks that each aria- attribute specified is defined in ARIA 1.1. | 403 | | QW-ACT-R28 | [4e8ab6](https://act-rules.github.io/rules/4e8ab6) | Element with role attribute has required states and properties | 404 | | QW-ACT-R29 | [e7aa44](https://act-rules.github.io/rules/e7aa44) | Audio element content has text alternative | 405 | | QW-ACT-R30 | [2ee8b8](https://act-rules.github.io/rules/2ee8b8) | Visible label is part of accessible name | 406 | | QW-ACT-R31 | [c3232f](https://act-rules.github.io/rules/c3232f) | Video element visual-only content has accessible alternative | 407 | | QW-ACT-R32 | [1ec09b](https://act-rules.github.io/rules/1ec09b) | video element visual content has strict accessible alternative | 408 | | QW-ACT-R33 | [ff89c9](https://act-rules.github.io/rules/ff89c9) | ARIA required context role | 409 | | QW-ACT-R34 | [6a7281](https://act-rules.github.io/rules/6a7281) | ARIA state or property has valid value | 410 | | QW-ACT-R35 | [ffd0e9](https://act-rules.github.io/rules/ffd0e9) | Heading has accessible name | 411 | | QW-ACT-R36 | [a25f45](https://act-rules.github.io/rules/a25f45) | Headers attribute specified on a cell refers to cells in the same table element | 412 | | QW-ACT-R37 | [afw4f7](https://act-rules.github.io/rules/afw4f7) | Text has minimum contrast | 413 | | QW-ACT-R38 | [bc4a75](https://act-rules.github.io/rules/bc4a75) | ARIA required owned elements | 414 | | QW-ACT-R39 | [d0f69e](https://act-rules.github.io/rules/d0f69e) | All table header cells have assigned data cells | 415 | | QW-ACT-R40 | [59br37](https://act-rules.github.io/rules/59br37) | Zoomed text node is not clipped with CSS overflow | 416 | | QW-ACT-R41 | [36b590](https://act-rules.github.io/rules/36b590) | Error message describes invalid form field value | 417 | | QW-ACT-R42 | [8fc3b6](https://act-rules.github.io/rules/8fc3b6) | Object element has non-empty accessible name | 418 | | QW-ACT-R43 | [0ssw9k](https://act-rules.github.io/rules/0ssw9k) | Scrollable element is keyboard accessible | 419 | | QW-ACT-R44 | [fd3a94](https://act-rules.github.io/rules/fd3a94) | Links with identical accessible names and context serve equivalent purpose | 420 | | QW-ACT-R48 | [46ca7f](https://act-rules.github.io/rules/46ca7f) | Element marked as decorative is not exposed | 421 | | QW-ACT-R49 | [aaa1bf](https://act-rules.github.io/rules/aaa1bf) | Audio or video that plays automatically has no audio that lasts more than 3 seconds | 422 | | QW-ACT-R50 | [4c31df](https://act-rules.github.io/rules/4c31df) | Audio or video that plays automatically has a control mechanism | 423 | | QW-ACT-R51 | [fd26cf](https://act-rules.github.io/rules/fd26cf) | video element visual-only content is media alternative for text | 424 | | QW-ACT-R52 | [ac7dc6](https://act-rules.github.io/rules/ac7dc6) | video element visual-only content has description track | 425 | | QW-ACT-R53 | [ee13b5](https://act-rules.github.io/rules/ee13b5) | video element visual-only content has transcript | 426 | | QW-ACT-R54 | [d7ba54](https://act-rules.github.io/rules/d7ba54) | video element visual-only content has audio track alternative | 427 | | QW-ACT-R55 | [1ea59c](https://act-rules.github.io/rules/1ea59c) | video element visual content has audio description | 428 | | QW-ACT-R56 | [ab4d13](https://act-rules.github.io/rules/ab4d13) | video element content is media alternative for text | 429 | | QW-ACT-R57 | [f196ce](https://act-rules.github.io/rules/f196ce) | video element visual content has description track | 430 | | QW-ACT-R58 | [2eb176](https://act-rules.github.io/rules/2eb176) | audio element content has transcript | 431 | | QW-ACT-R59 | [afb423](https://act-rules.github.io/rules/afb423) | audio element content is media alternative for text | 432 | | QW-ACT-R60 | [f51b46](https://act-rules.github.io/rules/f51b46) | video element auditory content has captions | 433 | | QW-ACT-R61 | [1a02b0](https://act-rules.github.io/rules/1a02b0) | video element visual content has transcript | 434 | | QW-ACT-R62 | [oj04fd](https://act-rules.github.io/rules/oj04fd) | Element in sequential focus order has visible focus | 435 | | QW-ACT-R63 | [b40fd1](https://act-rules.github.io/rules/b40fd1) | Document has a landmark with non-repeated content | 436 | | QW-ACT-R64 | [047fe0](https://act-rules.github.io/rules/047fe0) | Document has heading for non-repeated content | 437 | | QW-ACT-R65 | [307n5z](https://act-rules.github.io/rules/307n5z) | Element with presentational children has no focusable content | 438 | | QW-ACT-R66 | [m6b1q3](https://act-rules.github.io/rules/m6b1q3) | Menuitem has non-empty accessible name | 439 | | QW-ACT-R67 | [24afc2](https://act-rules.github.io/rules/24afc2) | Letter spacing in style attributes is not !important | 440 | | QW-ACT-R68 | [78fd32](https://act-rules.github.io/rules/78fd32) | Line height in style attributes is not !important | 441 | | QW-ACT-R69 | [9e45ec](https://act-rules.github.io/rules/9e45ec) | Word spacing in style attributes is not !important | 442 | | QW-ACT-R70 | [akn7bn](https://act-rules.github.io/rules/akn7bn) | frame with negative tabindex has no interactive elements | 443 | | QW-ACT-R71 | [bisz58](https://act-rules.github.io/rules/bisz58) | `meta` element has no refresh delay (no exception) | 444 | | QW-ACT-R72 | [8a213c](https://act-rules.github.io/rules/8a213c) | First focusable element is link to non-repeated content | 445 | | QW-ACT-R73 | [3e12e1](https://act-rules.github.io/rules/3e12e1) | Block of repeated content is collapsible | 446 | | QW-ACT-R74 | [ye5d6e](https://act-rules.github.io/rules/ye5d6e) | Document has an instrument to move focus to non-repeated content | 447 | | QW-ACT-R75 | [cf77f2](https://act-rules.github.io/rules/cf77f2) | Bypass Blocks of Repeated Content | 448 | | QW-ACT-R76 | [09o5cg](https://act-rules.github.io/rules/09o5cg) | Text has enhanced contrast | 449 | 450 | ## Implemented WCAG 2.1 Techniques 451 | 452 | | QualWeb Technique ID | WCAG Technique ID | WCAG Technique Name | 453 | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | 454 | | QW-WCAG-T1 | [H24](https://www.w3.org/WAI/WCAG21/Techniques/html/H24) | Providing text alternatives for the area elements of image maps | 455 | | QW-WCAG-T2 | [H39](https://www.w3.org/WAI/WCAG21/Techniques/html/H39) | Using caption elements to associate data table captions with data tables | 456 | | QW-WCAG-T3 | [H71](https://www.w3.org/WAI/WCAG21/Techniques/html/H71) | Providing a description for groups of form controls using fieldset and legend elements | 457 | | QW-WCAG-T4 | [H73](https://www.w3.org/WAI/WCAG21/Techniques/html/H73) | Using the summary attribute of the table element to give an overview of data tables | 458 | | QW-WCAG-T5 | [H36](https://www.w3.org/WAI/WCAG21/Techniques/html/H36) | Using alt attributes on images used as submit buttons | 459 | | QW-WCAG-T6 | [SCR20](https://www.w3.org/WAI/WCAG21/Techniques/client-side-script/SCR20) | Using both keyboard and other device-specific functions | 460 | | QW-WCAG-T7 | [H28](https://www.w3.org/WAI/WCAG21/Techniques/html/H28) | Providing definitions for abbreviations by using the abbr element | 461 | | QW-WCAG-T8 | [F30](https://www.w3.org/WAI/WCAG21/Techniques/failures/F30) | Failure of Success Criterion 1.1.1 and 1.2.1 due to using text alternatives that are not alternatives | 462 | | QW-WCAG-T9 | [G141](https://www.w3.org/WAI/WCAG21/Techniques/general/G141) | Organizing a page using headings | 463 | | QW-WCAG-T10 | [H2](https://www.w3.org/WAI/WCAG21/Techniques/html/H2) | Combining adjacent image and text links for the same resource | 464 | | QW-WCAG-T11 | [H35](https://www.w3.org/WAI/WCAG21/Techniques/html/H35) | Providing text alternatives on applet elements | 465 | | QW-WCAG-T12 | [F46](https://www.w3.org/WAI/WCAG21/Techniques/failures/F46) | Failure of Success Criterion 1.3.1 due to using th elements, caption elements, or non-empty summary attributes in layout tables | 466 | | QW-WCAG-T13 | [F47](https://www.w3.org/WAI/WCAG21/Techniques/failures/F47) | Failure of Success Criterion 2.2.2 due to using the blink element | 467 | | QW-WCAG-T14 | [H43](https://www.w3.org/WAI/WCAG21/Techniques/html/H43) | Using id and headers attributes to associate data cells with header cells in data tables | 468 | | QW-WCAG-T15 | [H59](https://www.w3.org/WAI/WCAG21/Techniques/html/H59) | Using the link element and navigation tools | 469 | | QW-WCAG-T16 | [H88](https://www.w3.org/WAI/WCAG21/Techniques/html/H88) | Using HTML according to spec | 470 | | QW-WCAG-T17 | [G162](https://www.w3.org/WAI/WCAG21/Techniques/general/G162) | Positioning labels to maximize predictability of relationships | 471 | | QW-WCAG-T18 | [H51](https://www.w3.org/WAI/WCAG21/Techniques/html/H51) | Using table markup to present tabular information | 472 | | QW-WCAG-T19 | [H32](https://www.w3.org/WAI/WCAG21/Techniques/html/H32) | Providing submit buttons | 473 | | QW-WCAG-T20 | [H33](https://www.w3.org/WAI/WCAG21/Techniques/html/H33) | Supplementing link text with the title attribute | 474 | | QW-WCAG-T21 | [F89](https://www.w3.org/WAI/WCAG21/Techniques/failures/F89) | Failure of Success Criteria 2.4.4, 2.4.9 and 4.1.2 due to not providing an accessible name for an image which is the only content in a link | 475 | | QW-WCAG-T22 | [F52](https://www.w3.org/WAI/WCAG21/Techniques/failures/F52) | Failure of Success Criterion 3.2.1 and 3.2.5 due to opening a new window as soon as a new page is loaded | 476 | | QW-WCAG-T23 | [G1](https://www.w3.org/WAI/WCAG21/Techniques/general/G1) | Adding a link at the top of each page that goes directly to the main content area | 477 | | QW-WCAG-T24 | [F55](https://www.w3.org/WAI/WCAG21/Techniques/failures/F55) | Failure of Success Criteria 2.1.1, 2.4.7, and 3.2.1 due to using script to remove focus when focus is received | 478 | | QW-WCAG-T25 | [H63](https://www.w3.org/WAI/WCAG21/Techniques/html/H63) | Using the scope attribute to associate header cells and data cells in data tables | 479 | | QW-WCAG-T26 | [F59](https://www.w3.org/WAI/WCAG21/Techniques/failures/F59) | Failure of Success Criterion 4.1.2 due to using script to make div or span a user interface control in HTML without providing a role for the control | 480 | | QW-WCAG-T27 | [F88](https://www.w3.org/WAI/WCAG21/Techniques/failures/F88) | Failure of Success Criterion 1.4.8 due to using text that is justified (aligned to both the left and the right margins) | 481 | | QW-WCAG-T28 | [C12](https://www.w3.org/WAI/WCAG21/Techniques/css/C12) [C13](https://www.w3.org/WAI/WCAG21/Techniques/css/C13) [C14](https://www.w3.org/WAI/WCAG21/Techniques/css/C14) | Using `percent, em, names` for font sizes | 482 | | QW-WCAG-T29 | [C19](https://www.w3.org/WAI/WCAG21/Techniques/css/C19) | Specifying alignment either to the left or right in CSS | 483 | | QW-WCAG-T30 | [F4](https://www.w3.org/WAI/WCAG21/Techniques/failures/F4) | Failure of Success Criterion 2.2.2 due to using text-decoration:blink without a mechanism to stop it in less than five seconds | 484 | | QW-WCAG-T31 | [F24](https://www.w3.org/WAI/WCAG21/Techniques/failures/F24) | Failure of Success Criterion 1.4.3, 1.4.6 and 1.4.8 due to specifying foreground colors without specifying background colors or vice versa | 485 | | QW-WCAG-T32 | [H48](https://www.w3.org/WAI/WCAG21/Techniques/html/H48) | Using ol, ul and dl for lists or groups of links | 486 | 487 | # Evaluation problems 488 | 489 | Sometimes, some webpages fail to evaluate, or the evaluation may take a really long time. Before creating an issue check the **error.log** file and verify that: 490 | 491 | - The URL is correct, and it uses http or https, or www, or both; 492 | - The webpage exists; 493 | - If using https, that the certificate is valid; 494 | - If you really want to evaluate the page with an invalid certificate, add "--ignore-certificate-errors" to the `args` in qualweb puppeteer launch options. 495 | - The webpage is not password protected; 496 | - The webpage is an [HTML Document](https://dom.spec.whatwg.org/#concept-document). 497 | 498 | # License 499 | 500 | ISC 501 | 502 | # Versions 503 | 504 | - 0.7.32 - Updated ACT-Rules c487ae(R12), 6cfa84 (R13), 73f2c2 (R24), 46ca7f (R48) and 78fd32 (R68) 505 | - 0.7.31 - Removed dependencies on Wappalyzer module (continued) 506 | - 0.7.30 - Removed dependencies on Wappalyzer module 507 | - 0.7.29 - Fixed ACT-Rules bf051a (R5) and bc4a75 (R38) 508 | -------------------------------------------------------------------------------- /docs/assets/images/icons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/qualweb/core/c5c4bba9dac152382a02f11277018345144361d2/docs/assets/images/icons.png -------------------------------------------------------------------------------- /docs/assets/images/icons@2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/qualweb/core/c5c4bba9dac152382a02f11277018345144361d2/docs/assets/images/icons@2x.png -------------------------------------------------------------------------------- /docs/assets/images/widgets.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/qualweb/core/c5c4bba9dac152382a02f11277018345144361d2/docs/assets/images/widgets.png -------------------------------------------------------------------------------- /docs/assets/images/widgets@2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/qualweb/core/c5c4bba9dac152382a02f11277018345144361d2/docs/assets/images/widgets@2x.png -------------------------------------------------------------------------------- /docs/assets/js/search.js: -------------------------------------------------------------------------------- 1 | window.searchData = {"kinds":{"64":"Function","128":"Class","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"QualWeb","url":"classes/qualweb.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/qualweb.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"QualWeb"},{"id":2,"kind":1024,"name":"cluster","url":"classes/qualweb.html#cluster","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"QualWeb"},{"id":3,"kind":2048,"name":"start","url":"classes/qualweb.html#start","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QualWeb"},{"id":4,"kind":2048,"name":"stop","url":"classes/qualweb.html#stop","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QualWeb"},{"id":5,"kind":2048,"name":"evaluate","url":"classes/qualweb.html#evaluate","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QualWeb"},{"id":6,"kind":2048,"name":"crawlDomain","url":"classes/qualweb.html#crawldomain","classes":"tsd-kind-method tsd-parent-kind-class","parent":"QualWeb"},{"id":7,"kind":2048,"name":"checkUrls","url":"classes/qualweb.html#checkurls","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"QualWeb"},{"id":8,"kind":64,"name":"getFileUrls","url":"modules.html#getfileurls","classes":"tsd-kind-function"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,1.625]],["parent/0",[]],["name/1",[1,18.971]],["parent/1",[0,0.146]],["name/2",[2,18.971]],["parent/2",[0,0.146]],["name/3",[3,18.971]],["parent/3",[0,0.146]],["name/4",[4,18.971]],["parent/4",[0,0.146]],["name/5",[5,18.971]],["parent/5",[0,0.146]],["name/6",[6,18.971]],["parent/6",[0,0.146]],["name/7",[7,18.971]],["parent/7",[0,0.146]],["name/8",[8,18.971]],["parent/8",[]]],"invertedIndex":[["checkurls",{"_index":7,"name":{"7":{}},"parent":{}}],["cluster",{"_index":2,"name":{"2":{}},"parent":{}}],["constructor",{"_index":1,"name":{"1":{}},"parent":{}}],["crawldomain",{"_index":6,"name":{"6":{}},"parent":{}}],["evaluate",{"_index":5,"name":{"5":{}},"parent":{}}],["getfileurls",{"_index":8,"name":{"8":{}},"parent":{}}],["qualweb",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["start",{"_index":3,"name":{"3":{}},"parent":{}}],["stop",{"_index":4,"name":{"4":{}},"parent":{}}]],"pipeline":[]}} -------------------------------------------------------------------------------- /docs/classes/qualweb.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | QualWeb | @qualweb/core 7 | 8 | 9 | 10 | 11 | 12 | 13 |

14 | 51 |

52 |

53 | 61 |

Class QualWeb

62 |

63 |

64 |

65 |

66 |

67 |

68 |

69 |

70 |

71 |

QualWeb engine - Performs web accessibility evaluations using several modules:

72 |

act-rules module (https://github.com/qualweb/act-rules)
wcag-techniques module (https://github.com/qualweb/wcag-techniques)
best-practices module (https://github.com/qualweb/best-practices)

77 |

78 |

79 |

80 |

81 |

Hierarchy

82 |

84 | QualWeb 85 |

87 |

88 |

89 |

Index

90 |

91 |

92 |

93 |

Constructors

94 |

constructor

97 |

98 |

99 |

Properties

100 |

cluster

103 |

104 |

105 |

Methods

106 |

checkUrls
crawlDomain
evaluate
start
stop

113 |

114 |

115 |

116 |

117 |

118 |

Constructors

119 |

120 | 121 |

constructor

122 |

new QualWeb(plugins?: PuppeteerPlugins): QualWeb

125 |

127 |
128 |
- Defined in src/index.ts:25
131 |
132 |
133 |
134 |
Initializes puppeteer with given plugins.
135 |
136 |
137 |
Parameters
138 |
- 140 |
  Optional plugins: PuppeteerPlugins
  141 |
  142 |
  Plugins for puppeteer - supported: AdBlocker and Stealth.
  143 |
  144 |
146 |
Returns QualWeb
147 |

149 |

150 |

151 |

152 |

Properties

153 |

154 | 155 |

Private Optional cluster

156 |

cluster: default<any, any>

157 | 162 |

163 |

164 |

Chromium browser cluster.

165 |

166 |

167 |

168 |

169 |

170 |

Methods

171 |

172 | 173 |

Private checkUrls

174 |

checkUrls(options: QualwebOptions): Promise<string[]>

177 |

179 |
180 |
- Defined in src/index.ts:167
183 |
184 |
185 |
186 |
Checks possible input options and compiles the urls. 187 | Possible input options are:
188 |
- url - single url;
- urls - multiple urls;
- filepath - path to file with urls;
- crawler - domain to crawl and gather urls.
194 |
195 |
196 |
Parameters
197 |
- 199 |
  options: QualwebOptions
  200 |
  201 |
  QualWeb options.
  202 |
  203 |
205 |
Returns Promise<string[]>
206 |
List of urls.
207 |

209 |

210 |

211 | 212 |

crawlDomain

213 |

crawlDomain(domain: string, options?: CrawlOptions): Promise<string[]>

216 |

218 |
219 |
- Defined in src/index.ts:148
222 |
223 |
224 |
225 |
Crawls a domain to find all webpages urls.
226 |
227 |
228 |
Parameters
229 |
- 231 |
  domain: string
  232 |
  233 |
  Web domain to crawl.
  234 |
  235 |
- 237 |
  Optional options: CrawlOptions
  238 |
  239 |
  Options for crawling process.
  240 |
  241 |
243 |
Returns Promise<string[]>
244 |
List of decoded urls.
245 |

247 |

248 |

249 | 250 |

evaluate

251 |

evaluate(options: QualwebOptions): Promise<Evaluations>

254 |

256 |
257 |
- Defined in src/index.ts:74
260 |
261 |
262 |
263 |
Evaluates given options.
264 |
265 |
266 |
Parameters
267 |
- 269 |
  options: QualwebOptions
  270 |
  271 |
  Options of execution (check https://github.com/qualweb/core#options).
  272 |
  273 |
275 |
Returns Promise<Evaluations>
276 |
List of evaluations.
277 |

279 |

280 |

281 | 282 |

start

283 |

start(clusterOptions?: ClusterOptions, puppeteerOptions?: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions): Promise<void>

286 |

288 |
289 |
- Defined in src/index.ts:47
292 |
293 |
294 |
295 |
Starts chromium browser cluster.
296 |
297 |
298 |
Parameters
299 |
- 301 |
  Optional clusterOptions: ClusterOptions
  302 |
  303 |
  Options for cluster initialization.
  304 |
  305 |
- 307 |
  Optional puppeteerOptions: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions
  308 |
  309 |
  check https://github.com/puppeteer/puppeteer/blob/v9.1.1/docs/api.md#puppeteerlaunchoptions.
  310 |
  311 |
313 |
Returns Promise<void>
314 |

316 |

317 |

318 | 319 |

stop

320 |

stop(): Promise<void>

323 |

325 |
326 |
- Defined in src/index.ts:64
329 |
330 |
331 |
332 |
Closes chromium browser.
333 |
334 |
335 |
Returns Promise<void>
336 |

338 |

339 |

340 |

341 |

342 | 349 |

350 |

351 | 352 |

354 | QualWeb 355 |
- 357 | constructor 358 |
- 360 | cluster 361 |
- 363 | checkUrls 364 |
- 366 | crawlDomain 367 |
- 369 | evaluate 370 |
- 372 | start 373 |
- 375 | stop 376 |
378 |

380 |

382 | generateEARLReport 383 |
385 | getFileUrls 386 |

388 |

389 |

390 |

391 |

392 | 407 |

408 |

Generated using TypeDoc

409 |

410 |

411 | 412 | 413 | -------------------------------------------------------------------------------- /docs/modules.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | @qualweb/core 7 | 8 | 9 | 10 | 11 | 12 | 13 |

14 | 51 |

52 |

53 |

@qualweb/core

54 |

55 |

56 |

57 |

58 |

59 |

60 |

61 |

Index

62 |

63 |

64 |

65 |

Classes

66 |

QualWeb

69 |

70 |

71 |

Functions

72 |

generateEARLReport
getFileUrls

76 |

77 |

78 |

79 |

80 |

81 |

Functions

82 |

83 | 84 |

generateEARLReport

85 |

generateEARLReport(reports: Evaluations, options?: EarlOptions): EarlEvaluations

88 |

90 |
91 |
- Defined in node_modules/@qualweb/types/earl-reporter.d.ts:75
94 |
95 |
Parameters
96 |
- 98 |
  reports: Evaluations
  99 |
- 101 |
  Optional options: EarlOptions
  102 |
104 |
Returns EarlEvaluations
105 |

107 |

108 |

109 | 110 |

getFileUrls

111 |

getFileUrls(file: string): Promise<string[]>

114 |

116 |
117 |
- Defined in src/index.ts:192
120 |
121 |
122 |
123 |
Reads a file to obtain the urls to evaluate.
124 |
125 |
126 |
Parameters
127 |
- 129 |
  file: string
  130 |
  131 |
  Path to file of urls.
  132 |
  133 |
135 |
Returns Promise<string[]>
136 |
List of decoded urls.
137 |

139 |

140 |

141 |

142 | 164 |

165 |

166 | 181 |

182 |

Generated using TypeDoc

183 |

184 |

185 | 186 | 187 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@qualweb/core", 3 | "version": "0.7.46", 4 | "description": "QualWeb evaluator core engine", 5 | "main": "dist/index.js", 6 | "files": [ 7 | "dist/*" 8 | ], 9 | "scripts": { 10 | "tsc": "tsc", 11 | "test": "mocha", 12 | "test:core": "mocha test/core.spec.mjs", 13 | "test:html": "mocha test/html.spec.mjs", 14 | "test:crawler": "mocha test/crawler.spec.mjs", 15 | "test:file": "mocha test/file.spec.mjs", 16 | "test:urls": "mocha test/urls.spec.mjs", 17 | "test:parallel": "mocha test/parallel.spec.mjs", 18 | "test:plugin": "mocha test/plugin.spec.mjs", 19 | "test:validator": "mocha test/validator.spec.mjs", 20 | "test:wp": "mocha test/wappalyzer.spec.mjs", 21 | "test:locale": "mocha test/locale.spec.mjs", 22 | "test:log": "mocha test/log.spec.mjs", 23 | "prebuild": "rimraf dist", 24 | "lint": "eslint src --ext .ts", 25 | "lint:fix": "eslint src --ext .ts --fix", 26 | "format": "prettier --config .prettierrc 'src/**/*.ts' --write", 27 | "build": "tsc --build", 28 | "docs": "typedoc --out docs src/index.ts", 29 | "prepare": "npm run build", 30 | "release": "npm run build && npx changeset publish", 31 | "release-snapshot": "npm run build && npx changeset version --snapshot next && npx changeset publish --tag next" 32 | }, 33 | "keywords": [ 34 | "qualweb", 35 | "evaluator", 36 | "web", 37 | "accessibility", 38 | "a11y" 39 | ], 40 | "homepage": "https://github.com/qualweb/core#readme", 41 | "repository": { 42 | "type": "git", 43 | "url": "https://github.com/qualweb/core.git" 44 | }, 45 | "bugs": { 46 | "url": "https://github.com/qualweb/core/issues", 47 | "email": "qualweb@fc.ul.pt" 48 | }, 49 | "author": { 50 | "name": "João Vicente", 51 | "email": "joao.vicente@campus.ul.pt" 52 | }, 53 | "contributors": [ 54 | { 55 | "name": "Carlos Duarte" 56 | }, 57 | { 58 | "name": "Bruno Andrade" 59 | }, 60 | { 61 | "name": "António Estriga" 62 | }, 63 | { 64 | "name": "André Santos", 65 | "url": "https://arbsantos.github.io" 66 | } 67 | ], 68 | "engines": { 69 | "node": ">=12.0.0" 70 | }, 71 | "license": "ISC", 72 | "dependencies": { 73 | "@qualweb/crawler": "0.3.15", 74 | "@qualweb/dom": "0.2.6", 75 | "@qualweb/earl-reporter": "0.4.3", 76 | "@qualweb/evaluation": "0.3.30", 77 | "@qualweb/locale": "0.1.12", 78 | "colors": "1.4.0", 79 | "puppeteer": "21.3.6", 80 | "puppeteer-cluster": "^0.23.0", 81 | "puppeteer-extra": "^3.3.6", 82 | "puppeteer-extra-plugin-adblocker": "^2.13.6", 83 | "puppeteer-extra-plugin-stealth": "^2.11.2" 84 | }, 85 | "devDependencies": { 86 | "@changesets/cli": "^2.26.2", 87 | "@qualweb/types": "0.7.22", 88 | "@tsconfig/recommended": "^1.0.1", 89 | "@types/node": "^17.0.19", 90 | "@typescript-eslint/eslint-plugin": "^5.12.0", 91 | "@typescript-eslint/parser": "^5.12.0", 92 | "chai": "^4.3.4", 93 | "eslint": "^8.9.0", 94 | "eslint-config-prettier": "^8.4.0", 95 | "eslint-plugin-prettier": "^4.0.0", 96 | "eslint-plugin-sonarjs": "^0.12.0", 97 | "mocha": "^9.2.1", 98 | "node-fetch": "^3.1.0", 99 | "prettier": "^2.5.1", 100 | "rimraf": "^3.0.2", 101 | "typedoc": "^0.22.12", 102 | "typescript": "^4.5.4" 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import { LaunchOptions, BrowserLaunchArgumentOptions, BrowserConnectOptions, Viewport } from 'puppeteer'; 2 | import puppeteer from 'puppeteer-extra'; 3 | import { Cluster } from 'puppeteer-cluster'; 4 | import StealthPlugin from 'puppeteer-extra-plugin-stealth'; 5 | import AdBlocker from 'puppeteer-extra-plugin-adblocker'; 6 | import { QualwebOptions, Evaluations, PuppeteerPlugins, ClusterOptions, LoadEvent, QualwebPlugin } from '@qualweb/core'; 7 | import { generateEARLReport } from '@qualweb/earl-reporter'; 8 | import { Dom } from '@qualweb/dom'; 9 | import { Evaluation } from '@qualweb/evaluation'; 10 | import { Crawler, CrawlOptions } from '@qualweb/crawler'; 11 | import locales, { Lang, Locale, TranslationObject } from '@qualweb/locale'; 12 | import { readFile, writeFile, unlink } from 'fs'; 13 | import path from 'path'; 14 | import 'colors'; 15 | 16 | /** 17 | * QualWeb engine - Performs web accessibility evaluations using several modules: 18 | * - act-rules module (https://github.com/qualweb/act-rules) 19 | * - wcag-techniques module (https://github.com/qualweb/wcag-techniques) 20 | * - best-practices module (https://github.com/qualweb/best-practices) 21 | */ 22 | class QualWeb { 23 | /** 24 | * Chromium browser cluster. 25 | */ 26 | private cluster?: Cluster; 27 | 28 | /** 29 | * Array of plugins added with QualWeb.use(). 30 | */ 31 | private qualwebPlugins: QualwebPlugin[] = []; 32 | 33 | /** 34 | * Initializes puppeteer with given plugins. 35 | * 36 | * @param {PuppeteerPlugins} plugins - Plugins for puppeteer - supported: AdBlocker and Stealth. 37 | */ 38 | constructor(plugins?: PuppeteerPlugins) { 39 | if (plugins?.stealth) { 40 | puppeteer.use(StealthPlugin()); 41 | } 42 | if (plugins?.adBlock) { 43 | puppeteer.use(AdBlocker({ blockTrackers: true })); 44 | } 45 | } 46 | 47 | /** 48 | * Starts chromium browser cluster. 49 | * 50 | * @param {ClusterOptions} clusterOptions - Options for cluster initialization. 51 | * @param {LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions} puppeteerOptions - check https://github.com/puppeteer/puppeteer/blob/v9.1.1/docs/api.md#puppeteerlaunchoptions. 52 | */ 53 | public async start( 54 | clusterOptions?: ClusterOptions, 55 | puppeteerOptions?: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions 56 | ): Promise { 57 | this.cluster = await Cluster.launch({ 58 | concurrency: Cluster.CONCURRENCY_CONTEXT, 59 | maxConcurrency: clusterOptions?.maxConcurrency ?? 1, 60 | puppeteerOptions: puppeteerOptions, 61 | puppeteer: puppeteer, 62 | timeout: clusterOptions?.timeout ?? 60 * 1000, 63 | monitor: clusterOptions?.monitor ?? false 64 | }); 65 | } 66 | 67 | /** 68 | * Adds a plugin to be run when executing a QualWeb evaluation. Plugins are 69 | * called in the same order they were added to the instance. 70 | * @param plugin The plugin to add. 71 | * @returns The QualWeb instance itself. Good for chaining. 72 | */ 73 | public use(plugin: QualwebPlugin): this { 74 | this.qualwebPlugins.push(plugin); 75 | 76 | return this; 77 | } 78 | 79 | /** 80 | * Closes chromium browser. 81 | */ 82 | public async stop(): Promise { 83 | await this.cluster?.close(); 84 | } 85 | 86 | /** 87 | * Evaluates given options. 88 | * 89 | * @param {QualwebOptions} options - Options of execution (check https://github.com/qualweb/core#options). 90 | * @returns List of evaluations. 91 | */ 92 | public async evaluate(options: QualwebOptions): Promise { 93 | const modulesToExecute = { 94 | act: true, 95 | wcag: true, 96 | bp: true, 97 | wappalyzer: false, 98 | counter: false 99 | }; 100 | 101 | const urls = await this.checkUrls(options); 102 | 103 | if ((options.html === undefined || options.html.trim() === '') && urls.length === 0) { 104 | throw new Error('Invalid input method'); 105 | } 106 | 107 | this.handleLocales(options); 108 | 109 | if (options.execute) { 110 | modulesToExecute.act = !!options.execute.act; 111 | modulesToExecute.wcag = !!options.execute.wcag; 112 | modulesToExecute.bp = !!options.execute.bp; 113 | modulesToExecute.wappalyzer = !!options.execute.wappalyzer; 114 | modulesToExecute.counter = !!options.execute.counter; 115 | } 116 | 117 | const evaluations: Evaluations = {}; 118 | 119 | let foundError = false; 120 | 121 | const timestamp = new Date().getTime(); 122 | 123 | handleError( 124 | options, 125 | 'Evaluation errors', 126 | new Date(timestamp).toISOString().replace(/T/, ' ').replace(/\..+/, '') + '\n-----------', 127 | timestamp 128 | ); 129 | 130 | this.cluster?.on('taskerror', (err, data) => { 131 | foundError = true; 132 | handleError(options, data.url, err.message + '\n-----------', timestamp); 133 | }); 134 | 135 | await this.cluster?.task(async ({ page, data: { url, html } }) => { 136 | const dom = new Dom(page, options.validator); 137 | 138 | // Execute beforePageLoad on all plugins in order. If any exceptions 139 | // occur during the execution of a plugin, it should bubble up past the 140 | // call to Qualweb.evaluate() so the user can handle it on their own. 141 | for (const plugin of this.qualwebPlugins) { 142 | if (typeof plugin.beforePageLoad === 'function') { 143 | await plugin.beforePageLoad(page, url || 'customHtml'); 144 | } 145 | } 146 | 147 | const { sourceHtml, validation } = await dom.process(options, url ?? '', html ?? ''); 148 | const evaluation = new Evaluation(url, page, modulesToExecute); 149 | 150 | // Execute afterPageLoad on all plugins in order. Same assumptions for 151 | // exceptions apply as they did for beforePageLoad. 152 | for (const plugin of this.qualwebPlugins) { 153 | if (typeof plugin.afterPageLoad === 'function') { 154 | await plugin.afterPageLoad(page, url || 'customHtml'); 155 | } 156 | } 157 | 158 | const evaluationReport = await evaluation.evaluatePage(sourceHtml, options, validation); 159 | evaluations[url || 'customHtml'] = evaluationReport.getFinalReport(); 160 | }); 161 | 162 | for (const url of urls) { 163 | this.cluster?.queue({ url }); 164 | } 165 | 166 | if (options.html) { 167 | this.cluster?.queue({ html: options.html }); 168 | } 169 | 170 | await this.cluster?.idle(); 171 | 172 | if (options.log?.file) { 173 | if (foundError) { 174 | console.warn('One or more urls failed to evaluate. Check the error.log for more information.'.yellow); 175 | } else { 176 | deleteErrorLogFile(timestamp); 177 | } 178 | } 179 | 180 | return evaluations; 181 | } 182 | 183 | /** 184 | * Crawls a webpage to find all urls. 185 | * 186 | * @param {string} startingUrl - Webpage to crawl. 187 | * @param {CrawlOptions} options - Options for crawling process. 188 | * @Param {Viewport} viewport - Set the viewport of the webpages. 189 | * @param {LoadEvent | Array} waitUntil - Wait for dom events before starting the crawling process. 190 | * @returns List of decoded urls. 191 | */ 192 | public async crawl( 193 | domain: string, 194 | options?: CrawlOptions, 195 | viewport?: Viewport, 196 | waitUntil?: LoadEvent | Array 197 | ): Promise> { 198 | const browser = await puppeteer.launch(); 199 | const incognito = await browser.createIncognitoBrowserContext(); 200 | const crawler = new Crawler(incognito, domain, viewport, waitUntil); 201 | await crawler.crawl(options); 202 | return crawler.getResults(); 203 | } 204 | 205 | /** 206 | * Checks possible input options and compiles the urls. 207 | * Possible input options are: 208 | * - url - single url; 209 | * - urls - multiple urls; 210 | * - filepath - path to file with urls; 211 | * - crawler - domain to crawl and gather urls. 212 | * 213 | * @param {QualwebOptions} options - QualWeb options. 214 | * @returns List of urls. 215 | */ 216 | private async checkUrls(options: QualwebOptions): Promise> { 217 | const urls = new Array(); 218 | if (options.url) { 219 | urls.push(decodeURIComponent(options.url).trim()); 220 | } 221 | if (options.urls) { 222 | urls.push(...options.urls.map((url: string) => decodeURIComponent(url).trim())); 223 | } 224 | if (options.file) { 225 | urls.push(...(await getFileUrls(options.file))); 226 | } 227 | if (options.crawl) { 228 | const viewport = { 229 | width: 0, 230 | height: 0, 231 | isMobile: false, 232 | isLandscape: true 233 | }; 234 | if (options.viewport) { 235 | viewport.width = options?.viewport?.resolution?.width ?? 0; 236 | viewport.height = options?.viewport?.resolution?.height ?? 0; 237 | viewport.isMobile = options?.viewport?.mobile ?? false; 238 | viewport.isLandscape = options?.viewport?.landscape ?? true; 239 | } 240 | urls.push( 241 | ...(await this.crawl( 242 | options.crawl, 243 | options.crawlOptions, 244 | viewport.width + viewport.height !== 0 ? viewport : undefined, 245 | options.waitUntil 246 | )) 247 | ); 248 | } 249 | 250 | return urls; 251 | } 252 | 253 | private handleLocales(options: QualwebOptions): void { 254 | if (options.translate) { 255 | if (typeof options.translate === 'string') { 256 | if (Object.keys(locales).includes(options.translate)) { 257 | options.translate = { 258 | translate: locales[options.translate], 259 | fallback: locales.en 260 | }; 261 | } else { 262 | throw new Error(`Locale "${options.translate}" not supported.`); 263 | } 264 | } else if (Object.keys(options.translate).includes('translate')) { 265 | this.verifyTranslationObject(options); 266 | } else { 267 | options.translate = { 268 | translate: options.translate, 269 | fallback: locales.en 270 | }; 271 | } 272 | } else { 273 | options.translate = { 274 | translate: locales.en, 275 | fallback: locales.en 276 | }; 277 | } 278 | } 279 | 280 | private verifyTranslationObject(options: QualwebOptions): void { 281 | if (typeof (options.translate).translate === 'string') { 282 | if (Object.keys(locales).includes((options.translate).translate)) { 283 | options.translate = { 284 | translate: locales[(options.translate).translate], 285 | fallback: locales.en 286 | }; 287 | } else { 288 | throw new Error(`Locale "${(options.translate).translate}" not supported.`); 289 | } 290 | } 291 | if (typeof (options.translate).fallback === 'string') { 292 | if (Object.keys(locales).includes((options.translate).fallback)) { 293 | (options.translate).fallback = 294 | locales[(options.translate).fallback]; 295 | } else { 296 | throw new Error(`Locale "${(options.translate).fallback}" not supported.`); 297 | } 298 | } 299 | } 300 | } 301 | 302 | /** 303 | * Reads a file to obtain the urls to evaluate. 304 | * 305 | * @param {string} file - Path to file of urls. 306 | * @returns List of decoded urls. 307 | */ 308 | async function getFileUrls(file: string): Promise> { 309 | const content = await readFileData(file); 310 | return content 311 | .split('\n') 312 | .map((url: string) => { 313 | try { 314 | return decodeURIComponent(url).trim(); 315 | } catch (_err) { 316 | return ''; 317 | } 318 | }) 319 | .filter((url: string) => url.trim() !== ''); 320 | } 321 | 322 | /** 323 | * Reads a file. 324 | * 325 | * @param {string} file - Path to file. 326 | * @returns File data converted to UTF-8. 327 | */ 328 | function readFileData(file: string): Promise { 329 | return new Promise((resolve, reject) => { 330 | readFile(file, (err, data) => { 331 | if (err) { 332 | reject(err); 333 | } else { 334 | resolve(data.toString('utf-8')); 335 | } 336 | }); 337 | }); 338 | } 339 | 340 | /** 341 | * Logs evaluation errors to a error log file. 342 | * 343 | * @param {options} QualwebOptions - options to check logging method 344 | * @param {string} url - Url that failed to evaluate. 345 | * @param {string} message - Error message of the evaluation. 346 | * @param {number} timestamp - Date of the evaluation. 347 | */ 348 | function handleError(options: QualwebOptions, url: string, message: string, timestamp: number): void { 349 | if (options.log && options.log.file) { 350 | writeFile( 351 | path.resolve(process.cwd(), `qualweb-errors-${timestamp}.log`), 352 | url + ' : ' + message + '\n', 353 | { flag: 'a', encoding: 'utf-8' }, 354 | (err) => { 355 | if (err) { 356 | console.error(err); 357 | } 358 | } 359 | ); 360 | } 361 | if (options.log && options.log.console) { 362 | console.error(url + ' : ' + message + '\n'); 363 | } 364 | } 365 | 366 | /** 367 | * Deletes the error log file created at the beginning of the evaluation if there aren't any errors to report. 368 | * 369 | * @param {number} timestamp - Date of the evaluation. 370 | */ 371 | function deleteErrorLogFile(timestamp: number): void { 372 | unlink(path.resolve(process.cwd(), `qualweb-errors-${timestamp}.log`), (err) => { 373 | if (err) { 374 | throw err; 375 | } 376 | }); 377 | } 378 | 379 | export { QualWeb, generateEARLReport, getFileUrls }; 380 | -------------------------------------------------------------------------------- /test/core.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb, generateEARLReport } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | 4 | describe('Core', function () { 5 | it('Should evaluate one url', async function () { 6 | this.timeout(0); 7 | 8 | const qualweb = new QualWeb({ adBlock: true, stealth: true }); 9 | 10 | await qualweb.start(undefined, { headless: false, args: ['--ignore-certificate-errors', '--no-sandbox'] }); 11 | 12 | const evaluations = await qualweb.evaluate({ 13 | url: 'https://rocketvalidator.com/', 14 | log: { console: true }, 15 | // viewport: { mobile: true, landscape: false }, 16 | execute: { act: true, wcag: false,bp:false } }); 17 | 18 | console.log(evaluations['https://rocketvalidator.com/'].modules['act-rules'].assertions["QW-ACT-R25"]); 19 | /* 20 | const evaluations1 = await qualweb.evaluate({ 21 | url: 'https://varsovia.embaixadaportugal.mne.gov.pt/pt/sugestoes-elogios-ou-reclamacoes', 22 | log: { console: true }, 23 | // viewport: { mobile: true, landscape: false }, 24 | execute: { act: false, wcag: true, bp: false }, 25 | 'act-rules': { levels: ['A', 'AA'] } 26 | }); 27 | 28 | console.log(evaluations1['https://varsovia.embaixadaportugal.mne.gov.pt/pt/sugestoes-elogios-ou-reclamacoes'].modules['wcag-techniques'].assertions["QW-WCAG-T17"]); 29 | 30 | 31 | const evaluations2 = await qualweb.evaluate({ 32 | url: 'https://varsovia.embaixadaportugal.mne.gov.pt/pt/sugestoes-elogios-ou-reclamacoes', 33 | log: { console: true }, 34 | // viewport: { mobile: true, landscape: false }, 35 | execute: { act: false, wcag: true, bp: false }, 36 | 'act-rules': { levels: ['A', 'AA'] } 37 | }); 38 | 39 | console.log(evaluations2['https://varsovia.embaixadaportugal.mne.gov.pt/pt/sugestoes-elogios-ou-reclamacoes'].modules['wcag-techniques'].assertions["QW-WCAG-T17"]);*/ 40 | 41 | const earlReports = generateEARLReport(evaluations); 42 | 43 | await qualweb.stop(); 44 | 45 | expect(earlReports['https://ciencias.ulisboa.pt/']['@graph'].length).to.be.equal(1); 46 | }); 47 | }); -------------------------------------------------------------------------------- /test/counter.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | 4 | describe('Core module: counter', function () { 5 | it('Should find page technologies', async function () { 6 | this.timeout(0); 7 | 8 | const qualweb = new QualWeb(); 9 | 10 | await qualweb.start(); 11 | const reports = await qualweb.evaluate({ url: 'https://ciencias.ulisboa.pt', execute: { counter: true } }); 12 | await qualweb.stop(); 13 | 14 | expect(Object.keys(reports).length).to.be.greaterThan(0); 15 | }); 16 | }); 17 | -------------------------------------------------------------------------------- /test/crawler.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | 4 | describe('Core input method: crawler', function () { 5 | it('Should evaluate all urls', async function () { 6 | this.timeout(0); 7 | 8 | const qualweb = new QualWeb({ adBlock: true, stealth: true }); 9 | 10 | const urls = await qualweb.crawl('https://ciencias.ulisboa.pt', { 11 | maxUrls: 1000, 12 | logging: true 13 | }); 14 | 15 | const options = { 16 | urls, 17 | 'wcag-techniques': { 18 | exclude: ['QW-WCAG-T16'] 19 | } 20 | }; 21 | 22 | await qualweb.start( 23 | { maxConcurrency: 5, monitor: true }, 24 | { args: ['--no-sandbox', '--ignore-certificate-errors'] } 25 | ); 26 | const reports = await qualweb.evaluate(options); 27 | await qualweb.stop(); 28 | 29 | expect(Object.keys(reports).length).to.be.greaterThan(1); 30 | }); 31 | }); 32 | -------------------------------------------------------------------------------- /test/file.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | import path from 'path'; 4 | 5 | describe('Core input method: file', function () { 6 | it('Should evaluate all urls', async function () { 7 | this.timeout(0); 8 | 9 | const qualweb = new QualWeb({ adBlock: false, stealth: false }); 10 | 11 | const options = { 12 | file: '/home/node/workspace/qualweb/core/test/urls.txt', 13 | 'wcag-techniques': { 14 | exclude: ['QW-WCAG-T16'] 15 | } 16 | }; 17 | 18 | await qualweb.start( 19 | { maxConcurrency: 8, monitor: true }, 20 | { args: ['--no-sandbox', '--ignore-certificate-errors'] } 21 | ); 22 | const reports = await qualweb.evaluate(options); 23 | await qualweb.stop(); 24 | 25 | expect(Object.keys(reports).length).to.be.equal(26); 26 | }); 27 | }); 28 | -------------------------------------------------------------------------------- /test/html.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | import { readFileSync } from 'fs'; 4 | 5 | describe('Core input method: html', function () { 6 | it('Should evaluate normally', async function () { 7 | this.timeout(0); 8 | 9 | const options = { 10 | html: readFileSync('./test/test.html').toString() 11 | }; 12 | 13 | const qualweb = new QualWeb(); 14 | 15 | await qualweb.start(); 16 | const reports = await qualweb.evaluate(options); 17 | await qualweb.stop(); 18 | 19 | expect(reports['customHtml']).to.not.be.equal(undefined); 20 | }); 21 | }); 22 | -------------------------------------------------------------------------------- /test/locale.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | 4 | describe('Core', function () { 5 | it('Should evaluate one url', async function () { 6 | this.timeout(0); 7 | 8 | const qualweb = new QualWeb(); 9 | 10 | await qualweb.start({ headless: true, args: ['--ignore-certificate-errors'] }); 11 | 12 | const options = { 13 | url: 'http://ciencias.ulisboa.pt', 14 | translate: 'en', 15 | execute: { 16 | act: true 17 | }, 18 | 'act-rules': { 19 | rules: ['QW-ACT-R1'] 20 | } 21 | }; 22 | 23 | const evaluations = await qualweb.evaluate(options); 24 | console.log(JSON.stringify(evaluations, null, 2)); 25 | 26 | await qualweb.stop(); 27 | 28 | expect(true); 29 | }); 30 | }); 31 | -------------------------------------------------------------------------------- /test/log.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | 4 | describe('Log', function () { 5 | it('Should log to file', async function () { 6 | this.timeout(0); 7 | 8 | const qualweb = new QualWeb({ adBlock: true, stealth: true }); 9 | 10 | await qualweb.start({ headless: true, args: ['--ignore-certificate-errors'] }); 11 | 12 | const evaluations = await qualweb.evaluate({ 13 | url: 'http://localhost:4200/', 14 | execute: { act: true, wcag: true, bp: true }, 15 | waitUntil: ['load', 'networkidle0'], 16 | log: { 17 | file: true 18 | } 19 | }); 20 | 21 | await qualweb.stop(); 22 | 23 | expect(evaluations['http://localhost:4200/']).to.not.be.undefined; 24 | }); 25 | it('Should log to console', async function () { 26 | this.timeout(0); 27 | 28 | const qualweb = new QualWeb({ adBlock: true, stealth: true }); 29 | 30 | await qualweb.start({ headless: true, args: ['--ignore-certificate-errors'], monitor: true }); 31 | 32 | const evaluations = await qualweb.evaluate({ 33 | url: 'http://localhost:4200/', 34 | execute: { act: true, wcag: true, bp: true }, 35 | waitUntil: ['load', 'networkidle0'], 36 | log: { 37 | console: true 38 | } 39 | }); 40 | 41 | await qualweb.stop(); 42 | 43 | expect(evaluations['http://localhost:4200/']).to.not.be.undefined; 44 | }); 45 | it('Should log to console 2', async function () { 46 | this.timeout(0); 47 | 48 | const qualweb = new QualWeb({ adBlock: true, stealth: true }); 49 | 50 | await qualweb.start({ headless: true, args: ['--ignore-certificate-errors'], monitor: true }); 51 | 52 | const evaluations = await qualweb.evaluate({ 53 | urls: [ 54 | 'http://localhost:4200/', 55 | 'http://localhost:4200/1', 56 | 'http://localhost:4200/2', 57 | 'http://localhost:4200/3', 58 | 'http://localhost:4200/4', 59 | 'http://localhost:4200/5' 60 | ], 61 | execute: { act: true, wcag: true, bp: true }, 62 | waitUntil: ['load', 'networkidle0'], 63 | log: { 64 | console: true 65 | } 66 | }); 67 | 68 | await qualweb.stop(); 69 | 70 | expect(evaluations['http://localhost:4200/']).to.not.be.undefined; 71 | }); 72 | }); 73 | -------------------------------------------------------------------------------- /test/parallel.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb, generateEARLReport } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | import fetch from 'node-fetch'; 4 | 5 | describe('Should do parallel evaluations', function () { 6 | it('Should have correct results', async function () { 7 | this.timeout(0); 8 | 9 | const response = await fetch('https://act-rules.github.io/testcases.json'); 10 | const testCases = await response.json(); 11 | const rule = '2779a5'; 12 | const tcs = testCases.testcases.filter((tc) => tc.ruleId === rule); 13 | const urls = tcs.map((tc) => tc.url); 14 | 15 | const qualweb = new QualWeb(); 16 | 17 | await qualweb.start(); 18 | 19 | const options = { 20 | urls, 21 | execute: { 22 | act: true 23 | }, 24 | 'act-rules': { 25 | rules: [rule] 26 | }, 27 | maxParallelEvaluations: urls.length 28 | }; 29 | 30 | const evaluations = await qualweb.evaluate(options); 31 | const earlReport = Object.values(generateEARLReport(evaluations, { aggregated: true, modules: { act: true } })); 32 | 33 | await qualweb.stop(); 34 | 35 | let valid = true; 36 | for (let i = 0; i < tcs.length; i++) { 37 | try { 38 | const result = earlReport[0]['@graph'].filter((r) => r.source === tcs[i].url)[0]; 39 | if ( 40 | result.assertions[0].result.outcome !== 'earl:' + tcs[i].expected && 41 | result.assertions[0].result.outcome !== 'earl:cantTell' 42 | ) { 43 | valid = false; 44 | } 45 | } catch (err) { 46 | valid = false; 47 | console.error(err); 48 | } 49 | } 50 | 51 | if (valid) { 52 | console.warn('Test validation passed'); 53 | } else { 54 | console.warn('Test validation failed'); 55 | } 56 | expect(valid).to.be.true; 57 | }); 58 | }); 59 | -------------------------------------------------------------------------------- /test/plugin.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | import { readFileSync } from 'fs'; 4 | 5 | describe('Plugins', function () { 6 | // Re-usable "execute nothing" options for calls to evaluate() 7 | const executeOptions = { 8 | wappalyzer: false, 9 | act: false, 10 | wcag: false, 11 | bp: false, 12 | counter: false, 13 | } 14 | 15 | // Load up the html file prior to running the tests. Saves on I/O time. 16 | let html; 17 | before(() => { 18 | html = readFileSync('./test/test.html').toString(); 19 | }); 20 | 21 | // Initialize a new QualWeb instance for every test. Important, since there's 22 | // no mechanism to remove a plugin once added (by design). 23 | 24 | let qualweb; 25 | 26 | beforeEach(async () => { 27 | qualweb = new QualWeb({ }); 28 | await qualweb.start(undefined, { headless: true }); 29 | }); 30 | 31 | afterEach(async () => { 32 | await qualweb.stop(); 33 | qualweb = null; 34 | }); 35 | 36 | it('Should run beforePageLoad for a plugin', async function () { 37 | // Running a default evaluate is *very* slow. 38 | this.timeout(3000); 39 | 40 | const plugin = { 41 | pluginWasCalled: false, 42 | 43 | async beforePageLoad(page) { 44 | this.pluginWasCalled = true; 45 | } 46 | } 47 | 48 | qualweb.use(plugin); 49 | 50 | await qualweb.evaluate({ 51 | html, 52 | execute: executeOptions, 53 | }); 54 | 55 | expect(plugin.pluginWasCalled).to.be.true; 56 | }); 57 | 58 | it('Should run afterPageLoad for a plugin', async function () { 59 | this.timeout(3000); 60 | 61 | const plugin = { 62 | pluginWasCalled: false, 63 | 64 | async afterPageLoad(page) { 65 | this.pluginWasCalled = true; 66 | } 67 | } 68 | 69 | qualweb.use(plugin); 70 | 71 | await qualweb.evaluate({ 72 | html, 73 | execute: executeOptions, 74 | }); 75 | 76 | qualweb.stop(); 77 | 78 | expect(plugin.pluginWasCalled).to.be.true; 79 | }); 80 | 81 | it('Should run beforePageLoad once for each plugin that was added', async function () { 82 | // Running a default evaluate is *very* slow. 83 | this.timeout(3000); 84 | 85 | let pluginCallCount = 0; 86 | 87 | const plugin = { 88 | async beforePageLoad(page) { 89 | pluginCallCount++; 90 | } 91 | } 92 | 93 | // Three uses. The fact that it's the same plugin doesn't matter 94 | qualweb.use(plugin); 95 | qualweb.use(plugin); 96 | qualweb.use(plugin); 97 | 98 | await qualweb.evaluate({ 99 | html, 100 | execute: executeOptions, 101 | }); 102 | 103 | expect(pluginCallCount).to.equal(3); 104 | }); 105 | 106 | it('Should run afterPageLoad once for each plugin that was added', async function () { 107 | // Running a default evaluate is *very* slow. 108 | this.timeout(3000); 109 | 110 | let pluginCallCount = 0; 111 | 112 | const plugin = { 113 | async afterPageLoad(page) { 114 | pluginCallCount++; 115 | } 116 | } 117 | 118 | // Three uses. The fact that it's the same plugin doesn't matter 119 | qualweb.use(plugin); 120 | qualweb.use(plugin); 121 | qualweb.use(plugin); 122 | 123 | await qualweb.evaluate({ 124 | html, 125 | execute: executeOptions, 126 | }); 127 | 128 | expect(pluginCallCount).to.equal(3); 129 | }); 130 | 131 | it('Should run both beforePageLoad and afterPageLoad in the same plugin', async function () { 132 | this.timeout(3000); 133 | 134 | let beforeWasCalled = false; 135 | let afterWasCalled = false; 136 | 137 | qualweb.use({ 138 | beforePageLoad() { 139 | beforeWasCalled = true; 140 | }, 141 | afterPageLoad() { 142 | afterWasCalled = true; 143 | } 144 | }) 145 | 146 | await qualweb.evaluate({ 147 | html, 148 | execute: executeOptions, 149 | }); 150 | 151 | expect(beforeWasCalled).to.be.true; 152 | expect(afterWasCalled).to.be.true; 153 | }); 154 | 155 | it('Should pass target URL to a plugin (single URL)', async function () { 156 | // Even minimal evaluations (with no modules) take a few seconds. 157 | this.timeout(3000); 158 | 159 | const targetUrl = 'https://www.github.com'; 160 | let reportedUrl; 161 | 162 | const plugin = { 163 | async beforePageLoad(_, url) { 164 | reportedUrl = url; 165 | } 166 | } 167 | 168 | qualweb.use(plugin); 169 | 170 | await qualweb.evaluate({ 171 | url: targetUrl, 172 | execute: executeOptions, 173 | }); 174 | 175 | expect(reportedUrl).to.be.a('string').and.equal(targetUrl); 176 | }); 177 | 178 | it('Should pass target URLs to a plugin', async function () { 179 | // Even minimal evaluations (with no modules) take a few seconds. 180 | this.timeout(7000); 181 | 182 | const targetUrls = [ 183 | 'https://ciencias.ulisboa.pt', 184 | 'https://www.github.com', 185 | ]; 186 | 187 | let reportedUrls = []; 188 | 189 | const plugin = { 190 | async beforePageLoad(_, url) { 191 | reportedUrls.push(url); 192 | } 193 | } 194 | 195 | qualweb.use(plugin); 196 | 197 | await qualweb.evaluate({ 198 | urls: targetUrls, 199 | execute: executeOptions, 200 | }); 201 | 202 | expect(reportedUrls).to.have.members(targetUrls); 203 | }); 204 | 205 | it('Should pass "customHtml" as URL to the plugin (when raw HTML is passed)', async function () { 206 | // Even minimal evaluations (with no modules) take a few seconds. 207 | this.timeout(3000); 208 | 209 | let reportedUrl; 210 | 211 | const plugin = { 212 | async beforePageLoad(_, url) { 213 | reportedUrl = url; 214 | } 215 | } 216 | 217 | qualweb.use(plugin); 218 | 219 | await qualweb.evaluate({ 220 | html, 221 | execute: executeOptions, 222 | }); 223 | 224 | expect(reportedUrl).to.be.a('string').and.equal('customHtml'); 225 | }); 226 | 227 | it('A cookie that was injected prior to page load should be visble after page load', async function () { 228 | this.timeout(3000); 229 | 230 | let cookies; 231 | 232 | const testCookie = { 233 | name: 'OurTestCookie', 234 | value: 'true', 235 | url: 'http://localhost.null', // So we can retrieve it later. 236 | domain: 'localhost.null', 237 | }; 238 | 239 | qualweb.use({ 240 | beforePageLoad: async (page) => { 241 | // Inject a simple cookie. 242 | await page.setCookie(testCookie); 243 | }, 244 | afterPageLoad: async (page) => { 245 | // Retrieve the cookies for our test URL. 246 | cookies = await page.cookies(testCookie.url); 247 | }, 248 | }); 249 | 250 | await qualweb.evaluate({ 251 | html, 252 | execute: executeOptions, 253 | }); 254 | 255 | expect(cookies).to.be.an('array').and.have.length.at.least(1); 256 | expect(cookies[0].domain).to.equal(testCookie.domain); 257 | expect(cookies[0].name).to.equal(testCookie.name); 258 | expect(cookies[0].value).to.equal(testCookie.value); 259 | }); 260 | }); 261 | -------------------------------------------------------------------------------- /test/test.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Faculdade de Ciências da Universidade de Lisboa 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 25 | 35 | 43 | 45 | 54 | 56 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | Passar para o conteúdo principal 75 | 76 | 77 | 78 | 79 |

80 |

81 | 119 |

120 | 121 |

122 | 123 | 124 |

125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 |

135 | 136 |

137 |

138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 |

147 | 148 |

149 |

150 | 151 | 152 | 296 | 297 |

298 | 299 |

300 | 301 |

302 | 303 | 330 | 331 | 332 | 333 |

334 | 335 |

336 | 337 |

338 |

339 | 340 |

341 |

342 | 343 | 344 |

345 | 346 |

Em Destaque

347 | 348 | 349 | 350 | 351 | 352 | 353 | 354 | 355 |

361 |

362 |

Saúde - COVID-19

363 |

Coronavírus (COVID-19) - ler Despacho D/21/2020, de 1 de maio. 364 | 365 | Atendimento - Horários e... Ler mais

366 |

367 |

COVID-19: financiamento

368 |

Oportunidades de financiamento para projetos de I&D no âmbito da pandemia COVID-19:... Ler mais

369 |

370 |

CQE Ciências ULisboa lidera consórcio REUSE

371 |

O consórcio REUSE coordenado pelo CQE Ciências ULisboa surge na sequência do apoio... Ler mais

372 |

373 |

Ciências ULisboa vai realizar testes à COVID-19 - Comunicado de 20 de abril

374 |

Como é conhecimento de todos, Ciências associou-se desde a primeira hora aos esforços... Ler mais

375 |

Pormenor da Exposição "Formas & Fórmulas", patente ao público em Ciências entre outubro de 2016 e março de 2017

376 |

Apresentação dos Mestrados e do Doutoramento do Departamento de Matemática

377 |

Sessão de apresentação com a presença dos coordenadores dos cursos. 378 | Transmissão em direto... Ler mais

379 | 380 | 381 | 382 | 383 | 384 | 385 | 386 |

387 | 388 |

389 |

390 |

391 |

392 | 393 | 394 |

395 | 396 | 397 | 398 | 399 | 400 |

401 |

Notícias

402 | Ver Todos

403 | 404 | 405 | 406 | 407 |

408 |

As dicotomias por estes dias!

409 |
"Embora a realidade externa seja muito semelhante para todos, a forma como... Ler mais
411 |

Einstein, Eddington e o Eclipse: Impressões de Viagem

412 |
“O cruzamento da história das ciências com a banda desenhada foi uma... Ler mais
414 |

Radar Tec Labs #4

415 |
Quarta rubrica Radar Tec Labs, dedicada às atividades do Centro de... Ler mais
417 |

CQE Ciências ULisboa lidera consórcio REUSE

418 |
O consórcio REUSE coordenado pelo CQE Ciências ULisboa surge na sequência... Ler mais
420 |

Teletrabalho

421 |
"É verdade, as coisas precisam ser feitas, mas, se não fizermos uma boa... Ler mais

423 | 424 | 425 | 426 | 427 | 428 | 429 | 430 |

431 | 432 |

433 |

434 |

435 |

436 | 437 | 438 |

439 | 440 | 441 | 442 | 443 | 444 |

445 |

Eventos

446 | Ver Todos

447 | 448 | 449 | 450 | 451 |

452 |
Maio 453 | 06
454 |
O mundo a partir de casa
456 |
Maio 457 | 07
458 |
Prova de Mestrado "Extraction and quantification of perivascular spaces based on vesselness filtering: A potential biomarker for Fabry disease"
460 |
Maio 461 | 07
462 |
Prova de Mestrado "Utilização de Fluorescência de Raios-X (XRF) para a caracterização expedita de solos contaminados por metais pesados"
464 |
Maio 465 | 07
466 |
Apresentação dos Mestrados e do Doutoramento do Departamento de Matemática
468 |
Maio 469 | 07
470 |
Finders, Keepers: Statistical fluctuations, causality, and whatnot in particle physics

472 | 473 | 474 | 475 | 476 | 477 | 478 | 479 |

480 | 481 |

482 |

483 |

484 | 485 | 487 | 488 | 489 |

490 | 491 | 625 |

626 | 627 | 628 | 629 | 630 | 631 | 632 | 633 | -------------------------------------------------------------------------------- /test/urls.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | import { readFileSync } from 'fs'; 4 | 5 | describe('Core input method: file', function () { 6 | it('Should evaluate normally', async function () { 7 | this.timeout(0); 8 | 9 | const options = { 10 | urls: readFileSync().toString().split('\n'), 11 | maxParallelEvaluations: 9 12 | }; 13 | 14 | const qualweb = new QualWeb(); 15 | 16 | await qualweb.start(); 17 | const reports = await qualweb.evaluate(options); 18 | await qualweb.stop(); 19 | 20 | expect(Object.keys(reports).length).to.be.equal(9); 21 | }); 22 | }); 23 | -------------------------------------------------------------------------------- /test/urls.txt: -------------------------------------------------------------------------------- 1 | https://ciencias.ulisboa.pt/ 2 | https://ciencias.ulisboa.pt/pt/oferta-formativa 3 | https://www.acessibilidade.gov.pt/ 4 | https://ciencias.ulisboa.pt/pt/candidaturas 5 | https://ciencias.ulisboa.pt/pt/estudante-internacional/ 6 | https://ciencias.ulisboa.pt/pt/p%C3%BAblico-escolar-geral/ 7 | https://ciencias.ulisboa.pt/pt/ciencias-nos-media 8 | https://ciencias.ulisboa.pt/pt/concursos/ 9 | https://ciencias.ulisboa.pt/doc 10 | https://dpul.princeton.edu/ 11 | https://ciencias.ulisboa.pt/pt/provas-academicas 12 | https://ciencias.ulisboa.pt/pt/horarios-de-atendimento 13 | http://accessible-serv.lasige.di.fc.ul.pt/~jvicente/test/ 14 | https://accessmonitor.acessibilidade.gov.pt/ 15 | https://www.portaldiplomatico.mne.gov.pt/ 16 | https://www.youtube.com/ 17 | https://www.facebook.com/ 18 | https://twitter.com/ 19 | http://www.acsa.org.pt/ 20 | https://www.google.pt/ 21 | https://duckduckgo.com/ 22 | https://metager.de/ 23 | https://www.linkedin.com/ 24 | https://github.com/ 25 | https://www.pinterest.com/ 26 | https://www.ola.pt/home.html -------------------------------------------------------------------------------- /test/validator.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | 4 | describe('Core html validator endpoint', function () { 5 | it('Should run html validator if no custom endpoint is given', async function () { 6 | this.timeout(0); 7 | 8 | const options = { 9 | url: 'https://ciencias.ulisboa.pt', 10 | execute: { 11 | html: true 12 | }, 13 | 'html-techniques': { 14 | techniques: ['QW-HTML-T20'] 15 | } 16 | }; 17 | 18 | const qualweb = new QualWeb(); 19 | 20 | await qualweb.start(); 21 | const reports = await qualweb.evaluate(options); 22 | await qualweb.stop(); 23 | 24 | expect( 25 | reports['https://ciencias.ulisboa.pt'].modules['html-techniques'].assertions['QW-HTML-T20'].results.length 26 | ).to.be.greaterThan(0); 27 | }); 28 | 29 | it('Should run html validator if custom endpoint is given', async function () { 30 | this.timeout(0); 31 | 32 | const options = { 33 | url: 'https://ciencias.ulisboa.pt', 34 | validator: 'http://194.117.20.242/validate/', 35 | execute: { 36 | html: true 37 | }, 38 | 'html-techniques': { 39 | techniques: ['QW-HTML-T20'] 40 | } 41 | }; 42 | 43 | const qualweb = new QualWeb(); 44 | 45 | await qualweb.start(); 46 | const reports = await qualweb.evaluate(options); 47 | await qualweb.stop(); 48 | 49 | expect( 50 | reports['https://ciencias.ulisboa.pt'].modules['html-techniques'].assertions['QW-HTML-T20'].results.length 51 | ).to.be.greaterThan(0); 52 | }); 53 | }); 54 | -------------------------------------------------------------------------------- /test/wappalyzer.spec.mjs: -------------------------------------------------------------------------------- 1 | import { QualWeb } from '../dist/index.js'; 2 | import { expect } from 'chai'; 3 | 4 | describe('Core module: wappalyzer', function () { 5 | it('Should find page technologies', async function () { 6 | this.timeout(0); 7 | 8 | const qualweb = new QualWeb(); 9 | 10 | await qualweb.start(); 11 | const reports = await qualweb.evaluate({ url: 'https://ciencias.ulisboa.pt', execute: { wappalyzer: true } }); 12 | await qualweb.stop(); 13 | 14 | expect(Object.keys(reports).length).to.be.greaterThan(0); 15 | }); 16 | }); 17 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "@tsconfig/recommended/tsconfig.json", 3 | "compilerOptions": { 4 | /* Basic Options */ 5 | "target": "ES2019", 6 | "lib": ["ES2019"], 7 | "declaration": true /* Generates corresponding '.d.ts' file. */, 8 | "declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */, 9 | "sourceMap": true /* Generates corresponding '.map' file. */, 10 | "outDir": "./dist" /* Redirect output structure to the directory. */, 11 | "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */, 12 | "removeComments": true /* Do not emit comments to output. */, 13 | 14 | /* Strict Type-Checking Options */ 15 | "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */, 16 | "strictNullChecks": true /* Enable strict null checks. */, 17 | "strictFunctionTypes": true /* Enable strict checking of function types. */, 18 | "strictBindCallApply": true /* Enable strict 'bind', 'call', and 'apply' methods on functions. */, 19 | "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */, 20 | "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */, 21 | "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */, 22 | 23 | /* Additional Checks */ 24 | "noUnusedLocals": true /* Report errors on unused locals. */, 25 | "noUnusedParameters": true /* Report errors on unused parameters. */, 26 | "noImplicitReturns": true /* Report error when not all code paths in function return a value. */, 27 | "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */, 28 | 29 | /* Module Resolution Options */ 30 | "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */, 31 | "typeRoots": ["@qualweb/types"] /* List of folders to include type definitions from. */, 32 | "types": ["@qualweb/types", "node"] /* Type declaration files to be included in compilation. */ 33 | } 34 | } 35 | --------------------------------------------------------------------------------

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional plugins: PuppeteerPlugins

Returns QualWeb

Properties

Private Optional cluster

Methods

Private checkUrls

Parameters

options: QualwebOptions

Returns Promise<string[]>

crawlDomain

Parameters

domain: string

Optional options: CrawlOptions

Returns Promise<string[]>

evaluate

Parameters

options: QualwebOptions

Returns Promise<Evaluations>

start

Parameters

Optional clusterOptions: ClusterOptions

Optional puppeteerOptions: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions

Returns Promise<void>

stop

Returns Promise<void>

Index

Classes

Functions

Functions

generateEARLReport

Parameters

reports: Evaluations

Optional options: EarlOptions

Returns EarlEvaluations

getFileUrls

Parameters

file: string

Returns Promise<string[]>

Ciências ULisboa

Em Destaque

Notícias

Eventos

Ciências ULisboa requer o uso de cookies