Merge branch 'master' into add_datadir

Author: developit

.gitignore

@@ -2,4 +2,6 @@ node_modules
 *.log
 package-lock.json
 dist
-build
+build
+coverage
+.vscode

README.md

@@ -15,7 +15,7 @@ Most importantly, Karmatic provides a (headless) browser test harness in a singl
 ## Installation
 
 ```sh
-npm i -D karmatic
+npm i -D webpack karmatic
 ```
 
 ... then add a `test` script to your `package.json`:
@@ -28,7 +28,7 @@ npm i -D karmatic
 }
 ```
 
-... now you can run your tests using `npm t`.
+... now you can run your tests using `npm t`. Here's a [minimal example repo](https://gist.github.com/developit/acd8a075350eeb6574439e92888c50cf).
 
 
 ### Test File Patterns
@@ -51,6 +51,34 @@ Example:
 karmatic --chromeDataDir .chrome
 ```
 
+## Usage
+
+```text
+Usage
+    $ karmatic <command> [options]
+
+Available Commands
+    run      Run tests once and exit
+    watch    Run tests on any change
+    debug    Open a headful Puppeteer instance for debugging your tests
+
+For more info, run any command with the `--help` flag
+    $ karmatic run --help
+    $ karmatic watch --help
+
+Options
+    -v, --version    Displays current version
+    --files          Minimatch pattern for test files
+    --headless       Run using Chrome Headless  (default true)
+    --coverage       Report code coverage of tests  (default true)
+    -h, --help       Displays this message
+```
+
+To disable any option that defaults to `true`, pass `false` to the option: `--headless false` or `--coverage false`.
+
+NOTE: The `debug` option overrides the default value of the `--headless` and `--coverage` option to be `false`. This option will also open up the local Puppeteer installation of Chrome, not your globally installed one. If you'd like to debug your tests using your your own instance of Chrome (or any other browser), copy the URL from the puppeteer window into your favorite browser.
+
+
 ## FAQ
 
 **Q**: [Is there an FAQ?](https://twitter.com/gauntface/status/956259291928776704)**

package.json

@@ -1,14 +1,15 @@
 {
   "name": "karmatic",
-  "version": "1.0.5",
+  "version": "1.2.0",
   "description": "Zero-config automatic (headless) browser testing. Powered by Karma, Webpack & Jasmine.",
   "main": "dist/index.js",
   "module": "dist/index.m.js",
   "bin": "dist/cli.js",
   "scripts": {
     "prepare": "npm t",
-    "build": "microbundle --target node --external all -f cjs --no-compress src/*.js",
+    "build": "microbundle --target node -f cjs --no-compress src/*.js",
     "test:build": "node ./dist/cli.js run",
+    "test:watch": "node ./dist/cli.js watch --headless false",
     "test": "eslint src test && npm run -s build && npm run -s test:build",
     "release": "npm run -s prepare && npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push && git push --tags && npm publish"
   },
@@ -20,34 +21,45 @@
     "chrome",
     "test runner"
   ],
+  "files": [
+    "dist"
+  ],
   "author": "Jason Miller <[email protected]> (http://jasonformat.com)",
+  "repository": "developit/karmatic",
   "license": "MIT",
   "devDependencies": {
     "eslint": "^4.16.0",
     "eslint-config-developit": "^1.1.1",
-    "microbundle": "^0.4.2",
-    "workerize-loader": "^1.0.1"
+    "microbundle": "^0.11.0",
+    "webpack": "^4.14.0",
+    "workerize-loader": "^1.0.4"
   },
   "dependencies": {
-    "babel-core": "^6.26.0",
-    "babel-loader": "^7.1.2",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-plugin-transform-react-jsx": "^6.24.1",
-    "babel-polyfill": "^6.26.0",
-    "babel-preset-env": "^1.6.1",
-    "babel-preset-stage-0": "^6.24.1",
+    "@babel/core": "^7.4.3",
+    "@babel/plugin-proposal-object-rest-spread": "^7.4.3",
+    "@babel/plugin-transform-react-jsx": "^7.3.0",
+    "@babel/polyfill": "^7.4.3",
+    "@babel/preset-env": "^7.4.3",
+    "@babel/preset-stage-0": "^7.0.0",
+    "babel-loader": "^8.0.5",
+    "babel-plugin-istanbul": "^5.1.0",
     "chalk": "^2.3.0",
     "dlv": "^1.1.1",
-    "jasmine-core": "^2.9.1",
-    "karma": "^2.0.0",
+    "jasmine-core": "^3.3.0",
+    "karma": "^3.1.1",
     "karma-chrome-launcher": "^2.2.0",
-    "karma-jasmine": "^1.1.1",
+    "karma-coverage": "^1.1.2",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-jasmine": "^2.0.1",
+    "karma-sauce-launcher": "^2.0.2",
     "karma-sourcemap-loader": "^0.3.7",
     "karma-spec-reporter": "0.0.32",
     "karma-webpack": "2.0.7",
     "puppeteer": "^1.0.0",
     "sade": "^1.3.1",
-    "script-loader": "^0.7.2",
-    "webpack": "^3.10.0"
+    "script-loader": "^0.7.2"
+  },
+  "peerDependencies": {
+    "webpack": ">=4"
   }
 }

src/cli.js

@@ -6,16 +6,19 @@ import './lib/patch';
 import karmatic from '.';
 import { cleanStack } from './lib/util';
 
+// @ts-ignore
 const { version } = require('../package.json');
 
-let toArray = val => Array.isArray(val) ? val : val == null ? [] : [val];
+let toArray = val => typeof val === 'string' ? val.split(/\s*,\s*/) : val == null ? [] : [].concat(val);
 
 let prog = sade('karmatic');
 
 prog
 	.version(version)
 	.option('--files', 'Minimatch pattern for test files')
 	.option('--headless', 'Run using Chrome Headless', true)
+	.option('--coverage', 'Report code coverage of tests', true)
+	.option('--downlevel', 'Downlevel syntax to ES5')
 	.option('--chromeDataDir', 'Save Chrome preferences');
 
 prog
@@ -28,11 +31,21 @@ prog
 	.describe('Run tests on any change')
 	.action( (str, opts) => run(str, opts, true) );
 
+prog
+	.command('debug [...files]')
+	.describe('Open a headful Puppeteer instance for debugging your tests')
+	.option('--headless', 'Run using Chrome Headless', false) // Override default to false
+	.option('--browsers', 'Run in specific browsers', null)
+	.option('--coverage', 'Report code coverage of tests', false) // Override default to false
+	.action( (str, opts) => run(str, opts, true) );
+
 prog.parse(process.argv);
 
 function run(str, opts, isWatch) {
 	opts.watch = !!isWatch;
 	opts.files = toArray(str || opts.files).concat(opts._);
+	const b = opts.browsers || opts.browser;
+	opts.browsers = b ? toArray(b) : null;
 	karmatic(opts)
 		.then( output => {
 			if (output!=null) process.stdout.write(output + '\n');