https://github.com/scurker/quilted
A css/js coverage tool for websites
https://github.com/scurker/quilted
chrome-headless cli code-coverage puppeteer
Last synced: 11 months ago
JSON representation
A css/js coverage tool for websites
- Host: GitHub
- URL: https://github.com/scurker/quilted
- Owner: scurker
- Created: 2018-02-07T00:52:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-25T06:10:56.000Z (over 6 years ago)
- Last Synced: 2025-05-22T17:49:17.870Z (about 1 year ago)
- Topics: chrome-headless, cli, code-coverage, puppeteer
- Language: JavaScript
- Homepage:
- Size: 1.66 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# quilted
[](https://travis-ci.org/scurker/quilted)
[](https://coveralls.io/github/scurker/quilted?branch=master)
[](https://www.npmjs.com/package/quilted)
> A css/js coverage tool for websites built using [Puppeteer](https://github.com/GoogleChrome/puppeteer).
## Installation
With [npm](https://www.npmjs.com/):
```sh
npm install --save quilted
```
With [yarn](https://yarnpkg.com):
```sh
yarn add quilted
```
## Usage
### CLI
```sh
quilted [options]
```
### Module
```js
import quilted from 'quilted';
quilted('https://example.com').then(coverage => {
// ...
});
```
## CLI
```sh
$ quilted --help
Usage: quilted [options]
Basic options:
--no-css disables css code coverage [boolean]
--no-js disables js code coverage [boolean]
--origin, -o only cover same-origin assets [boolean]
Puppeteer options:
--timeout, -t maximum number of milliseconds to wait for the browser
to start [number]
--viewportWidth, --vw sets viewport width for page render [number]
--viewportHeight, --vh sets viewport height for page render [number]
--viewport, -V sets viewport for page render i.e. 800x600 [string]
--userAgent, --ua sets the user agent for the request [string]
--headers, -H sets headers for the page request
example: $0 -H "X-Header: 123" [array]
Options:
--version, -v Show version number [boolean]
--help Show help [boolean]
```
## Module Options
| Option | Description | Default |
|-----------|-------------------|---------|
| `js` | Run js coverage. | `true` |
| `css` | Run css coverage. | `true` |
| `sameOrigin` | Only cover requests from the same origin | `false` |
## Puppeteer Supported Options
| Option | Description | Default |
|-----------|-------------------|---------|
| `args` | [Chrome command line flags](https://peter.sh/experiments/chromium-command-line-switches/) | `null` |
| `timeout` | [Maximum number of milliseconds to wait for the browser to start](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions) | `30000` |
| `cookies` | [Set cookies for the page request.](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetcookiecookies) | `null` |
| `headers` | [Set headers for the page request.](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetextrahttpheadersheaders) | `null` |
| `userAgent` | Sets the user agent for the page request. | Default Chrome Headless User Agent String |
| `viewport` | [Sets the viewport size for the page request.](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetviewportviewport) | `800x600` |
## License
[MIT](/license)