https://github.com/fffunction/backstop-crawl

🕷 Crawls a site to generate a backstopjs config file with scenarios pre-populated
https://github.com/fffunction/backstop-crawl

javascript pr-welcome regression-testing

Last synced: 9 months ago
JSON representation

🕷 Crawls a site to generate a backstopjs config file with scenarios pre-populated

• Host: GitHub
• URL: https://github.com/fffunction/backstop-crawl
• Owner: fffunction
• Created: 2016-09-07T08:58:44.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2020-08-28T21:16:19.000Z (almost 6 years ago)
• Last Synced: 2024-11-07T10:18:47.233Z (over 1 year ago)
• Topics: javascript, pr-welcome, regression-testing
• Language: JavaScript
• Homepage:
• Size: 199 KB
• Stars: 38
• Watchers: 5
• Forks: 18
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.md
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

          
# $ backstop-crawl

[![Stories in Ready](https://badge.waffle.io/fffunction/backstop-crawl.svg?label=ready&title=Ready)](http://waffle.io/fffunction/backstop-crawl) [![Build Status](https://travis-ci.org/fffunction/backstop-crawl.svg?branch=master)](https://travis-ci.org/fffunction/backstop-crawl) [![Coverage Status](https://coveralls.io/repos/github/fffunction/backstop-crawl/badge.svg?branch=master)](https://coveralls.io/github/fffunction/backstop-crawl?branch=master)

> `backstop-crawl` is a tool for automatically generating the `backstop.json` required for [`backstop`](https://github.com/garris/BackstopJS) by crawling a website.

![](http://i.imgur.com/yv57RDo.gif)

## Install

```

$ npm install --global backstop-crawl

```

## Usage

```

❯ backstop-crawl

  Crawl a site to generate a backstopjs config

  Usage

    $ backstop-crawl 

  Options

    --outfile, -o        Save the backstop config to this file

    --debug              Logs out errors produced while crawling

    --ignore-robots      Ignore the sites robots.txt

    --ignore-ssl-errors  Treat any certificate as valid (e.g. self-signed

                          or expired)

    --allow-subdomains   Allow crawling links found to subdomains of the

                          current domain

    --limit-similar[=3]  Limits the number of similar URLs to a set number

                         Defaults to 3

                          e.g /blog/1, /blog/2, /blog/3

    --reference-url  Allows a reference URL to be used in testing

  Examples

    $ backstop-crawl http://localhost

    $ backstop-crawl http://localhost --reference-url='https://mycoolsite.com'

```

## `backstop.template.json`

You can customize the contents of the generated `backstop.json` file by creating a `backstop.template.json` file. In addition to standard items in [`backstop.json`](https://github.com/garris/BackstopJS#working-with-your-config-file) the `backstop.template.json` needs a `defaultScenario` key. This will be used when generating the `scenarios` for crawled URLs.

For example:

```json

{

  "scenarios": [],

  "defaultScenario": {

  	"label": "Default",

  	"url": "",

  	"referenceUrl": "",

  	"hideSelectors": [],

  	"selectors": [

  	"document"

  	],

  	"readyEvent": null,

  	"delay": 1500,

  	"misMatchThreshold": 0.1

  }

}

```

## License

MIT © fffunction [fffunction.co](https://fffunction.co)