browser-run
The easiest way of running code in a browser environment.
Bundles electronjs by default!
Usage
$ echo "console.log('Hey from ' + location); window.close()" | browser-run
Hey from http://localhost:53227/
$
Or use browser-run programmatically:
var run = require('browser-run');
var browser = run();
browser.pipe(process.stdout);
browser.end('console.log(location); window.close()');
Example with browserify
$ browserify main.js | browser-run
or
var browserify = require('browserify');
var browser = require('browser-run');
browserify('main.js').bundle().pipe(browser()).pipe(process.stdout);
CLI
$ browser-run --help
Run JavaScript in a browser.
Write code to stdin and receive console output on stdout.
Usage: browser-run [OPTIONS]
Options:
--version Show version number [boolean]
-b, --browser Browser to use. Always available: electron. Available if
installed: chrome, firefox, ie, safari [default: "electron"]
--sandbox Enable electron sandbox [boolean] [default: true]
--basedir Set this if you need to require node modules in node mode
-h, --help Print help [boolean]
-p, --port Starts listening on that port and waits for you to open a
browser
-s, --static Serve static assets from this directory
-m, --mock Path to code to handle requests for mocking a dynamic back-end
-i, --input Input type. Defaults to 'javascript', can be set to 'html'.
-n, --node Enable nodejs apis in electron
Custom html file
By using --input html or { input: 'html' } you can provide a custom html file for browser-run to use. Keep in mind though that it always needs to have <script src="/reporter.js"></script> above other script tags so browser-run is able to properly forward your console.logs etc to the terminal.
Dynamic back-end mock
By using --mock mock.js or { mock: 'mock.js'} you can provide a custom server-side implementation and handle all requests that are sent to paths beginning with /mock
mock.js needs to export a function that accepts req and res arguments for handling requests.
Example:
module.exports = function(req,res){
if (req.url === '/mock/echo') {
req.pipe(res)
}
}
API
run([opts])
Returns a duplex stream and starts a webserver.
opts can be:
port: If speficied, no browser will be started, so you can point one yourself tohttp://localhost/<port>browser: Browser to use. Defaults toelectron. Available if installed:chromefirefoxiesafari
static: Serve static files from this directorymock: Path to code to handle requests for mocking a dynamic back-endinput: Input type. Defaults tojavascript, can be set tohtml.node: Enable nodejs integration in electronsandbox: Enable electron sandbox. Default:true.basedir: Set this if you need to require node modules innodemode
If only an empty string is written to it, an error will be thrown as there is nothing to execute.
If you call window.close() inside the script, the browser will exit.
run#stop()
Stop the underlying webserver.
Headless testing
In environments without a screen, you can use Xvfb to simulate one.
GitHub Actions
This is a full example to run npm test. Refer to the last 2 lines in the YAML config:
on:
- pull_request
- push
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- run: npm install
- run: sudo apt-get install xvfb
- run: xvfb-run --auto-servernum npm test
Travis
Add this to your travis.yml:
addons:
apt:
packages:
- xvfb
install:
- export DISPLAY=':99.0'
- Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
- npm install
Any gnu/linux box
$ sudo apt-get install xvfb # or equivalent
$ export DISPLAY=':99.0'
$ Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
$ browser-run ...
Docker
There is also an example Docker image. Source
Installation
With npm do
$ npm install browser-run # for library
$ npm install -g browser-run # for cli
Sponsors
This module is proudly supported by my Sponsors!
Do you want to support modules like this to improve their quality, stability and weigh in on new features? Then please consider donating to my Patreon. Not sure how much of my modules you're using? Try feross/thanks!
License
(MIT)
Taken from https://github.com/mobxjs/mobx/pull/590
3 Jul 5, 2022
1.6k Jan 6, 2023
327 Dec 30, 2022
262 Nov 21, 2022
8 Mar 24, 2022
27.8k Dec 31, 2022
22k Jan 8, 2023
3.5k Dec 26, 2022
968 Nov 1, 2022
12.5k Jan 4, 2023
3.5k Dec 30, 2022
49 Nov 28, 2022
2.2k Dec 30, 2022
7.1k Dec 28, 2022
26 Dec 14, 2022
76 Dec 22, 2022
13 Dec 12, 2022
71 Nov 3, 2022
5 Jul 29, 2022