karma-host-environment2.0.1 • Public • Published
Karma Host Environment
Host Environment is a library that makes it easy to detect whether your code is running in Node.js or a web browser, Windows or Mac, Internet Explorer or Chrome, etc.
Karma Host Environment is a companion to Host Environment, specifically for the Karma test runner. It allows you to detect not only the browser that your tests are running in, but also information about the host server, such as the operating system, Node.js version, and even environment variables.
;if hostenvCI// Setup CI test fixturesif hostbrowser// Test browser behaviorif hostbrowserIE// Test Internet Explorer-specific behaviorif hostnode// Test Node.js behaviorif hostnodeversion < 8// Different logic for older versions of Nodeif hostoswindows// Test Windows-specific behavior
Karma configuration builder with sensible defaults to minimize boilerplate
Easily detect what host environment your code is running in
npm install --save-dev host-environment karma-host-environment
Configure Karma to use the
host-environment framework plug-in:
Import host-environment as you normally would:
You can use all of the
host properties as usual:
host.env property would be an empty object when running in a web browser, since web browsers don't have access to environment variables. But Karma Host Environment exposes the host server's environment variables, so you can use
host.env just as you would if you were running in Node.js:
if hostenvCI// Setup CI test fixturesif hostenvQUICK_TEST// Skip long-running tests
In addition to all the usual
host properties, Karma Host Environment adds an additional
host.karma property. This object exposes all the
host properties of the Karma server itself, such as the operating system, Node.js version, environmenv variables, etc.
if hostkarma// We're running in Karmaif hostkarmanodeversion > 10// The server is running in Node v10+if hostkarmaoswindows// The server is a Windows OS
To build the project locally on your computer:
Clone this repo
git clone https://github.com/JS-DevTools/karma-host-environment.git
Link the module to itself (so Karma can find the plugin)
npm link karma-host-environment
Run the tests
karma-host-environment is 100% free and open-source, under the MIT license. Use it however you want.
Big Thanks To
Thanks to these awesome companies for their support of Open Source developers ❤