State

Configuration

✎ Edit package

This package is a work-in-progress. Some aspects may be awaiting improvement.

Below is the default configuration for the State package:

state: {
    src: "dist/site",
    dest: "dist/state",
    report: "reports/state",
},
serve: {
    port: 9001,
},
options: {
    ignore_inline_svg: true,
    ignore_mailto: true,
    ignore_cc_editor_links: true,
    scan_js: true
}

Custom Configuration

You can override these defaults by passing in options in your Gulpfile:

/* gulpfile.js */
suite.state(gulp, {
    "state": {
        "src": "/custom/path/to/source/"
    }
});

Available configuration options are as follows:

Key	Use
state.src	The location of the compiled site to scan.
state.dest	The location to output the visualiser static site.
state.report	The location to output JSON reports.
state.port	The port on which to serve the visualiser site.
options.ignore_data_urls	Unless set to true, the scanner will pick up data urls as referenced assets, and include them in the reports.
options.ignore_mailto	Unless set to true, the scanner will pick up mailto: links in the HTML, and include them in the reports.
options.ignore_cc_editor_links	Unless set to true, the scanner will pick up CloudCannon editor links and include them in the reports.
options.scan_js	If set to true, the scanner will also scan all your JavaScript files and <script> tags for references. This causes it to run slower, but may build a more accurate/detailed dependency graph.