Prep export of launcher as a standalone module

CONTRIBUTING.md

@@ -97,7 +97,7 @@ echo "Upload the package zip to CWS dev dashboard"
 
 echo "Verify the npm package won't include unncessary files"
 yarn global add irish-pub pkgfiles
-irish-pub; pkgfiles;  
+irish-pub; pkgfiles;
 
 echo "ship it"
 npm publish
@@ -110,6 +110,17 @@ echo "Generate the release notes, and update the release page"
 echo "Inform various peoples"
 ```
 
+### Releasing chrome launcher.
+
+```sh
+cd chrome-launcher
+echo "build the launcher source code"
+yarn build
+echo "run npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]"
+echo "commit the change as a version bump"
+npm publish
+```
+
 ### Canary release
 
 ```sh

chrome-launcher/.npmignore

@@ -0,0 +1,11 @@
+# folders
+.vscode/
+test/
+
+# dev files
+.appveyor.yml
+.editorconfig
+.eslintignore
+.eslintrc.js
+.travis.yml
+gulpfile.js

chrome-launcher/README.md

@@ -0,0 +1,80 @@
+# Chrome Launcher
+
+Launch chrome with ease from node.
+
+### Installing
+
+```
+yarn add chrome-launcher
+```
+
+or
+
+```
+npm install chrome-launcher
+```
+
+
+## API
+
+#### Launch options
+
+```js
+chromeLauncher.launch({
+  // optional staring url string
+  startingUrl: string;
+  // optional array of (string) flags to pass to chrome, for example ['--headless', '--disable-gpu']
+  // See all flags here: http://peter.sh/experiments/chromium-command-line-switches/
+  chromeFlags: Array<string>;
+  // optional explicit remote debugging port number to use, otherwise an open port is autoselected for you.
+  port: number;
+  // optional, handle cleaning up chrome when node process gets killed via SIGINT
+  handleSIGINT: boolean;
+  // optional, explicit path to chrome to launch
+  chromePath: string;
+  // optional, user dir path to reuse
+  userDataDir: string;
+});
+```
+
+#### Launched chrome interface
+
+```js
+{
+  // process id of chrome.
+  pid: number;
+  // the remote debuging port exposed by the launched chrome.
+  port: number;
+  // a function to kill and cleanup chrome.
+  kill: () => Promise<{}>;
+}
+```
+
+
+## Examples
+
+#### Launching chrome:
+
+```js
+const chromeLauncher = require('chrome-launcher');
+
+chromeLauncher.launch({
+  startingUrl: 'https://google.com'
+}).then(info => {
+  console.log(`Chrome debugging port running on ${info.port}`);
+});
+```
+
+
+#### Launching headless chrome:
+
+```js
+const chromeLauncher = require('chrome-launcher');
+
+chromeLauncher.launch({
+  startingUrl: 'https://google.com',
+  chromeFlags: ['--headless', '--disable-gpu']
+}).then(info => {
+  console.log(`Chrome debugging port running on ${info.port}`);
+});
+```

chrome-launcher/chrome-launcher.ts

@@ -13,7 +13,7 @@ import {DEFAULT_FLAGS} from './flags';
 import {makeTmpDir, defaults, delay} from './utils';
 import * as net from 'net';
 const rimraf = require('rimraf');
-const log = require('../lighthouse-core/lib/log');
+const log = require('lighthouse/lighthouse-core/lib/log');
 const spawn = childProcess.spawn;
 const execSync = childProcess.execSync;
 const isWindows = process.platform === 'win32';

chrome-launcher/package.json

@@ -1,6 +1,5 @@
 {
   "name": "chrome-launcher",
-  "private": true,
   "main": "chrome-launcher.js",
   "scripts": {
     "build": "tsc",
@@ -19,6 +18,12 @@
   "dependencies": {
     "@types/core-js": "^0.9.41",
     "@types/mkdirp": "^0.3.29",
-    "@types/node": "6.0.66"
-  }
+    "@types/node": "6.0.66",
+    "lighthouse": "2.1"
+  },
+  "version": "0.1.0",
+  "description": "Launch latest Chrome with the devtools-protocol port open",
+  "repository": "https://github.com/GoogleChrome/lighthouse/tree/master/chrome-launcher",
+  "author": "The Chromium Authors",
+  "license": "Apache-2.0"
 }