cypress-html-validate
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.2 • Public • Published

    Cypress HTML-Validate plugin

    Validates HTML using html-validate. It automatically fetches the active source markup from the browser and validates, failing the test if any validation errors is encountered.

    Installation

    npm install --save-dev html-validate cypress-html-validate
    

    Make sure you install both html-validate and the plugin cypress-html-validate. With NPM 7 or later it will be satisfied by the peer dependency but for a more consistent and deterministic experience it is suggested to include both as dependencies for your project.

    Usage

    In cypress/plugins/index.js:

    const htmlvalidate = require("cypress-html-validate/dist/plugin");
    
    module.exports = (on) => {
      htmlvalidate.install(on);
    };

    In cypress/support/index.js:

    import "cypress-html-validate/dist/commands";

    In specs:

    it("should be valid", () => {
      cy.visit("/my-page.html");
      cy.htmlvalidate();
    });

    To automatically run after each test you can use afterEach either in the spec file or in cypress/support/index.js:

    afterEach(() => {
      cy.htmlvalidate();
    });

    Configuration

    html-validate and the plugin can configured globally in cypress/plugins/index.js:

    /* html-validate configuration */
    const config = {
      rules: {
        foo: "error",
      },
    };
    /* plugin options */
    const options = {
      exclude: [],
      include: [],
      formatter(messages) {
        console.log(messages);
      },
    };
    htmlvalidate.install(on, config, options);

    See html-validate documentation for full description of configuration.

    If you want to override per call you can pass configuration and/or options directly to the function:

    cy.htmlvalidate([config], [options]);

    Options

    exclude: string[]

    A list of selectors to ignore errors from. Any errors from the elements or any descendant will be ignored.

    include: []

    A list of selectors to include errors from. If this is set to non-empty array only errors from elements or any descendants will be included.

    formatter

    • type: (messages: ElementMessage[]): void

    Custom formatter/reporter for detected errors. Default uses console.table(..) to log to console. Set to null to disable.

    Install

    npm i cypress-html-validate

    DownloadsWeekly Downloads

    2,517

    Version

    2.1.2

    License

    MIT

    Unpacked Size

    23.1 kB

    Total Files

    27

    Last publish

    Collaborators

    • ext