folder refactor: ts in /src, js in /dist (#69)

GoogleChrome · Dec 20, 2017 · d3ee63b · d3ee63b
1 parent 7a25f96
commit d3ee63b
Show file tree

Hide file tree

Showing 19 changed files with 21 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 node_modules
+dist
diff --git a/.npmignore b/.npmignore
@@ -10,8 +10,8 @@ test/
 .travis.yml
 gulpfile.js
 
-# exclude source TypeScript files
-*.ts
+# ignore TypeScript source files
+src/
 
-# allow TypeScript Declaration Files
-!*.d.ts
+# allow JS & TypeScript declaration files
+!dist/
diff --git a/chrome-launcher/index.js b/chrome-launcher/index.js
@@ -0,0 +1,4 @@
+// This provides legacy support for a previously documented require pattern
+//    const chromeLauncher = require('chrome-launcher/chrome-launcher');
+
+module.exports = require('../');
diff --git a/compiled-check.js b/compiled-check.js
@@ -7,8 +7,7 @@ module.exports = function(filename) {
   if (!fs.existsSync(path.join(__dirname, filename))) {
     console.log(
         'Oops! Looks like the chrome-launcher files needs to be compiled. Please run:');
-    console.log('   yarn install-launcher; yarn build-launcher;');
-    console.log('More at: https://github.com/GoogleChrome/lighthouse#develop');
+    console.log('   yarn; yarn build;');
     process.exit(1);
   }
 }
diff --git a/manual-chrome-launcher.js b/manual-chrome-launcher.js
@@ -13,8 +13,8 @@
  *     chrome-debug --enable-extensions
  */
 
-require('./compiled-check.js')('chrome-launcher.js');
-const {launch} = require('./chrome-launcher');
+require('./compiled-check.js')('./dist/chrome-launcher.js');
+const {launch} = require('./dist/chrome-launcher');
 
 const args = process.argv.slice(2);
 let chromeFlags;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "chrome-launcher",
-  "main": "index.js",
+  "main": "./dist/index.js",
   "scripts": {
     "build": "tsc",
     "dev": "tsc -w",

diff --git a/scripts/format.sh b/scripts/format.sh
@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
 
-FILES="`find . -type f \! -path '*node_modules*' \! -name '*.d.ts' -name '*.ts'`"
+FILES="`find src -type f -name '*.ts'`"
 
 ./node_modules/.bin/clang-format -i -style=file $FILES
diff --git a/chrome-finder.ts → src/chrome-finder.ts b/chrome-finder.ts → src/chrome-finder.ts
diff --git a/chrome-launcher.ts → src/chrome-launcher.ts b/chrome-launcher.ts → src/chrome-launcher.ts
diff --git a/flags.ts → src/flags.ts b/flags.ts → src/flags.ts
diff --git a/index.ts → src/index.ts b/index.ts → src/index.ts
diff --git a/random-port.ts → src/random-port.ts b/random-port.ts → src/random-port.ts
diff --git a/utils.ts → src/utils.ts b/utils.ts → src/utils.ts
diff --git a/test/check-formatting.sh b/test/check-formatting.sh
@@ -12,4 +12,4 @@ check_formatting ()
   fi
 }
 
-check_formatting "`find . -type f \! -path '*node_modules*' \! -name '*.d.ts' -name '*.ts'`"
+check_formatting "`find src -type f -name '*.ts'`"
diff --git a/test/chrome-launcher-test.ts b/test/chrome-launcher-test.ts
@@ -5,7 +5,7 @@
  */
 'use strict';
 
-import {Launcher} from '../chrome-launcher';
+import {Launcher} from '../src/';
 import {spy, stub} from 'sinon';
 import * as assert from 'assert';
 

diff --git a/test/launch-signature-test.ts b/test/launch-signature-test.ts
@@ -6,7 +6,7 @@
 
 'use strict';
 
-import {launch} from '../chrome-launcher';
+import {launch} from '../src/';
 import * as assert from 'assert';
 
 const log = require('lighthouse-logger');

diff --git a/test/random-port-test.ts b/test/random-port-test.ts
@@ -16,7 +16,7 @@
 'use strict';
 
 import * as assert from 'assert';
-import {getRandomPort} from '../random-port';
+import {getRandomPort} from '../src/random-port';
 
 describe('Random port generation', () => {
   it('generates a valid random port number', () => {

diff --git a/test/utils-test.ts b/test/utils-test.ts
@@ -16,7 +16,7 @@
 'use strict';
 
 import * as assert from 'assert';
-import {toWinDirFormat} from '../utils';
+import {toWinDirFormat} from '../src/utils';
 
 describe('WSL path format to Windows', () => {
   it('transforms basic path', () => {

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
         "module": "commonjs",
+        "outDir": "dist",
         "target": "es2016",
         "declaration": true,
         "noImplicitAny": true,
@@ -15,6 +16,6 @@
         "node_modules"
     ],
     "include": [
-        "*.ts"
+        "src"
     ]
 }