Site-archive NPM

Site Archive

This is a site crawler designed to track visual and content differences between crawls.

Example usage:

import Crawler from "site-archive";
import path from "path";

const entryPointRaw = process.argv[2];
const crawler = new Crawler(entryPointRaw, path.resolve('.', 'captures'), 1, console.log);
await crawler.crawl();

yarn run start https://yoursite.com

Options:

Default options:

let options = {
    ignoreHead: false, // If true skip any urls found in the <head> element.
    screenshotsOnly: false, // If true doesn't save any page HTML.
    screenshotSizes: [], // An array of {width: number, height: number} for screenshots to take.
    htmlOnly:  false, // Only attempt to follow links that might be HTML documents.
    logLevel:  2, // The detail level of messages to display. (1, 2, or 3 with 1 being every single message generated).
    onEvent: (msg) => console.log(msg), // Function that handles messaging from the crawler.
    htmlTypes: ['html', 'htm', 'xhtml', 'asp', 'aspx', 'shtml', 'dhtml', 'php', 'php5', 'jsp'], // Which file extensions (in addition to no-extension) are considered to be possible HTML links.
    ignoreQueryString: false, // If true, doesn't consider query strings to be part of a URL.
    ignoreAnchors: false, // If true, doesn't consider anchors to be part of a URL.
    selectorsToRemove: [], // An array of selectors for elements to be removed from the page before taking screenshots.
    timeout:  30000, // How long to wait for a page to finish load before timing out.
    redirect: 'follow', // How to treat HTTP redirects. (https://chromestatus.com/feature/4614142321229824)
}