Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andreaspizsa/setup-browser-env
✅ Simplified browser testing in node.
https://github.com/andreaspizsa/setup-browser-env
ava ava-tests browser-testing browser-tests mocha mocha-tests mochajs node-js nodejs
Last synced: about 1 month ago
JSON representation
✅ Simplified browser testing in node.
- Host: GitHub
- URL: https://github.com/andreaspizsa/setup-browser-env
- Owner: AndreasPizsa
- License: mit
- Created: 2018-11-17T10:39:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-03T09:19:58.000Z (over 4 years ago)
- Last Synced: 2024-12-17T10:58:55.804Z (about 1 month ago)
- Topics: ava, ava-tests, browser-testing, browser-tests, mocha, mocha-tests, mochajs, node-js, nodejs
- Language: JavaScript
- Homepage:
- Size: 2.61 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# `setup-browser-env`
[](https://github.com/postinstaller/postinstaller) [](https://travis-ci.org/AndreasPizsa/setup-browser-env) [](https://coveralls.io/github/AndreasPizsa/setup-browser-env)  [](https://www.npmjs.com/package/setup-browser-env) [](https://www.npmjs.com/package/setup-browser-env)
> Simplifies simulating a global browser environment using [browser-env][].
# Motivation
`setup-browser-env` simplifies simulating a global browser environment using [browser-env][] with zero configuration, keeping your project structure lean, clean & organized.
# Features
+ ✅ **Compatible.** Works with [ava][], [mocha][] and everything else.
+ ✅ **Zero Configuration** for ava. `npm add`, done.
+ ✅ **Configurable.** via `package.json` or `browser-env.{js, json, yaml}`
+ ✅ **Reliable.** 100% Code Coverage.
+ ✅ **Free.** MIT License.
# Usage
## Install
```sh
npm add -D setup-browser-env
```
### ava
##### Automatic configuration
If you’re using `ava` as a `devDependency`, installing `setup-browser-env` will configure ava automatically (using [postinstaller](http://github.com/postinstaller/postinstaller)).
##### Manual configuration
```json
// package.json
{
"ava": {
"require": [
"setup-browser-env"
]
}
}
```
### mocha
##### Manual configuration
```js
# mocha.opts
--require setup-browser-env
```
## Advanced Configuration
`setup-browser-env` runs out of the box without further configuration. You can still set options if needed in your `package.json` or a `browser-env.{js,json,yaml}` config file.
To learn about all configuration options, please see [browser-env][] and [jsdom][].
#### package.json
```
{
"browser-env": {
"globals": ["window", "document"],
"jsdom": {
"userAgent": "My User Agent"
}
}
}
```
#### Shortcuts
Pass only the of name global properties without setting jsdom options:
```
{
"browser-env": "window document"
}
```
```
{
"browser-env": ["window", "document"]
}
```
Pass only jsdom options without setting the of name global properties:
```
{
"browser-env": {
"userAgent": "My User Agent"
}
}
```
[ava]: https://github.com/avajs/ava
[mocha]: https://mochajs.org
[jsdom]: https://www.npmjs.com/package/jsdom
[browser-env]: https://www.npmjs.com/package/browser-env
[Andreas Pizsa]: https://twitter.com/AndreasPizsa
[license]: LICENSE.md
---
Copyright © 2018 [Andreas Pizsa][]. Licensed under the MIT [license][].