Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andywer/puppet-run
🤖 Run anything JavaScript in a headless Chrome from your command line
https://github.com/andywer/puppet-run
chrome cli headless puppeteer scripting testing
Last synced: about 2 months ago
JSON representation
🤖 Run anything JavaScript in a headless Chrome from your command line
- Host: GitHub
- URL: https://github.com/andywer/puppet-run
- Owner: andywer
- License: mit
- Created: 2018-11-28T19:20:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-29T18:37:42.000Z (over 3 years ago)
- Last Synced: 2024-10-17T12:39:21.047Z (2 months ago)
- Topics: chrome, cli, headless, puppeteer, scripting, testing
- Language: TypeScript
- Homepage:
- Size: 951 KB
- Stars: 55
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - puppet-run
README
🤖 puppet-run
Run any JavaScript / TypeScript code in a headless browser using [Puppeteer](https://github.com/GoogleChrome/puppeteer) and pipe its output to your terminal 🔥
Transparently bundles input files, so you can use `require()` and ES module imports. You can even simulate connectivity issues and serve static files. Great for testing client-side code in an actual browser!
How does it relate to [Karma](https://karma-runner.github.io)? It's everything that Karma is not: It's small, it's fast and trivial to set up.
🚀 Runs any script in a headless Chrome browser
📦 Zero-config transparent bundling
💡 Supports TypeScript, ES modules & JSX out of the box
🖥 Pipes console output and errors to host shell
⚙️ Uses custom Babel, TypeScript, ... config if present
## Installation
```sh
npm install puppet-run
```
## Usage
### Basics
Running `puppet-run` from the command line is simple. We can use npm's [npx tool](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner) for convenience.
```sh
npx puppet-run []
# without npx
node ./node_modules/.bin/puppet-run []
```
Pass any JavaScript or TypeScript file to `puppet-run` as an entrypoint. It will be transpiled by Babel and bundled using `browserify`. It normally works out-of-the-box with zero configuration.
```sh
npx puppet-run [...puppet-run options] ./path/to/script.js [...script options]
```
### Run mocha tests
```sh
npm install puppet-run-plugin-mocha
npx puppet-run --plugin=mocha [...mocha options] ./path/to/*.test.js
```
### Print help texts
```sh
npx puppet-run --help
```
To print a plugin's help text:
```sh
npx puppet-run --plugin=mocha --help
```
## Example
```js
// sample.js
// Everything logged here will be piped to your host terminal
console.log(`I am being run in a browser: ${navigator.userAgent}`)
// Explicitly terminate the script when you are done
puppet.exit()
```
Don't forget to call `puppet.exit()` when the script is done, so `puppet-run` knows that the script has finished. You can also exit with a non-zero exit code using `puppet.exit(statusCode: number)`.
Check out the "Scripting API" section below if you want to learn more about the globally available `puppet` object.
Let's run the sample script!
```sh
npx puppet-run ./sample.js
```
You should now see the output of the script on your terminal:
```
I am being run in a browser: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.132 Safari/537.36
```
Have fun!
## Plugins
Plugins make it easy to integrate your script with testing frameworks.
Check out the 👉 [plugins repository](https://github.com/andywer/puppet-run-plugins) to see what's on offer.
## Scripting API
The script runner will inject a `puppet` object into the browser window's global scope. It contains a couple of useful functions.
#### `puppet.argv: string[]`
Contains all the command line arguments and options passed to `puppet-run` after the script file path.
#### `puppet.exit(exitCode?: number = 0)`
Causes the script to end. The `puppet-run` process will exit with the exit code you pass here.
The exit code defaults to zero.
#### `puppet.setOfflineMode(takeOffline: boolean = true)`
Puts the browser in offline mode and closes all active connections if called with `true` or no arguments. Call it with `false` to bring the browser back online.
## More features
### Environment variables
You can access all environment variables of the host shell in your scripts as `process.env.*`.
### Source Maps
If an error is thrown, you will see the error and stack trace in your host shell. The stack trace will reference your source file lines, not the line in the bundle file that is actually served to the browser under the hood.
## Samples
Have a look at the samples in the [`sample`](./sample) directory:
- [Simple Testing](./sample/basic)
- [Simple Mocha Test](./sample/mocha)
- [React / Enzyme Test](./sample/mocha-enzyme)
- [Tape Test](./sample/tape)
## Test framework support
If you want to run tests in the browser using puppet-run, check out this list first:
#### ✅ Mocha
Works like a charm, see [`sample/mocha`](./sample/mocha) or [`sample/mocha-enzyme`](./sample/mocha-enzyme). They use the [Mocha Plugin](https://github.com/andywer/puppet-run-plugins/tree/master/packages/puppet-run-plugin-mocha).
#### ✅ Tape
Works like a charm, see [`sample/tape`](./sample/tape).
#### ❌ AVA
Currently not possible, since it's testing library and test runner code are too tightly coupled.
#### ❔ Jest
Didn't try yet.
## License
MIT