fix: move typescript option (#272)

* docs: update node/chrome

* fix(node): correct option for typescript

* fix: move typescript option
Move the typescript option under babel.typescript since it is coupled to babel

Author: stoffeastrom

commands-common/server/src/index.js

@@ -11,7 +11,6 @@ module.exports = function createServer(options) {
   const http = Object.assign({ port: 9000, root: ['./'], rewrite: {} }, options.http);
   const instrument = Object.assign({ exclude: '**' }, options.instrument);
   const transform = Object.assign({ exclude: '**' }, options.transform);
-  const typescript = utils.coerceTypescript(options.tsc || {});
   const babel = utils.coerceBabel({
     enable: true,
     babelPluginIstanbul: 'babel-plugin-istanbul',
@@ -33,7 +32,6 @@ module.exports = function createServer(options) {
     babel: {
       ...babel,
     },
-    typescript,
   };
   const app = new Koa();
   app.use(favicon(path.resolve(__dirname, '../aw.png')));

commands-common/transform/src/index.js

@@ -20,7 +20,7 @@ function getBabelOpts(filename, argv) {
 }
 
 function transformTypescript(filePath, sourceRoot, tsContent, argv) {
-  const { typescript: { compiler } } = argv;
+  const { babel: { typescript } } = argv;
   const { transform: { typescript: { compilerOptions, babelOptions } } } = argv;
   const fileName = argv.coverage ? path.basename(filePath) : filePath;
   compilerOptions.sourceRoot = argv.coverage ? path.resolve(path.dirname(filePath)) : sourceRoot;
@@ -32,7 +32,7 @@ function transformTypescript(filePath, sourceRoot, tsContent, argv) {
     compilerOptions.module = 'esnext';
   }
   const transpileOpts = { fileName, compilerOptions };
-  const res = compiler.transpileModule(tsContent, transpileOpts);
+  const res = typescript.transpileModule(tsContent, transpileOpts);
   tsContent = res.outputText; // eslint-disable-line no-param-reassign
   let tsBabelOpts = {
     sourceMaps: 'both',

commands-common/utils/src/index.js

@@ -71,18 +71,11 @@ const utils = {
     if (typeof opt.babelPluginIstanbul === 'string') {
       opt.babelPluginIstanbul = importCwd(opt.babelPluginIstanbul).default; // eslint-disable-line no-param-reassign, max-len
     }
+    if (typeof opt.typescript === 'string') {
+      opt.typescript = importCwd.silent(opt.typescript); // eslint-disable-line no-param-reassign
+    }
     return opt;
   },
-  coerceTypescript(opt) {
-    return {
-      get compiler() {
-        if (typeof opt === 'string') {
-          return importCwd(opt);
-        }
-        return opt;
-      },
-    };
-  },
 };
 
 module.exports = utils;

commands/cdp/src/index.js

@@ -33,7 +33,6 @@ const cdp = {
         return config;
       })
       .coerce('babel', utils.coerceBabel)
-      .coerce('tsc', utils.coerceTsc)
       .coerce('nyc', (opt) => {
         opt.sourceMap = false; // eslint-disable-line no-param-reassign
         opt.instrumenter = './lib/instrumenters/noop'; // eslint-disable-line no-param-reassign

commands/cdp/src/options.js

@@ -58,7 +58,7 @@ module.exports = {
     },
     type: 'object',
   },
-  tsc: {
+  'babel.typescript': {
     description: 'Path to typescript compiler module',
     default: 'typescript',
     type: 'string',
@@ -121,7 +121,7 @@ module.exports = {
     type: 'array',
   },
   'mocha.bail': {
-    description: 'Bail on fail?',
+    description: 'Bails on failure',
     default: true,
     type: 'boolean',
   },
@@ -136,7 +136,7 @@ module.exports = {
     type: 'number',
   },
   'mocha.useColors': {
-    description: 'Use colors',
+    description: 'Use colors in output',
     default: true,
     type: 'boolean',
   },
@@ -151,12 +151,12 @@ module.exports = {
     type: 'number',
   },
   'chrome.launch': {
-    description: 'Launch Chrome?',
+    description: 'Launch Chrome',
     default: true,
     type: 'boolean',
   },
   'chrome.devtools': {
-    description: 'Open Chrome with dev tools?',
+    description: 'Open Chrome with dev tools',
     default: false,
     type: 'boolean',
   },

commands/node/src/index.js

@@ -407,7 +407,6 @@ const node = {
       .options(options)
       .config('config', configure)
       .coerce('babel', utils.coerceBabel)
-      .coerce('tsc', utils.coerceTsc)
       .coerce('nyc', (opt) => {
         if (opt.babel) {
           // opt.require.push('babel-register');

commands/node/src/options.js

@@ -74,7 +74,7 @@ module.exports = {
     },
     type: 'object',
   },
-  typescript: {
+  'babel.typescript': {
     description: 'Path to typescript compiler module',
     default: 'typescript',
     type: 'string',

docs/cdp.md

@@ -1,6 +1,159 @@
 ---
 id: cdp
-title: Cdp
+title: Chrome
 ---
 
-WIP
+Run your test headless/headful in Chrome with great developer workflow. Just start the runner with
+
+```
+npx aw chrome -c ./path/to/aw.config.js -w --coverage
+```
+
+and start testing. It will only rerun affected tests and generate coverage accordingly.
+Add files, remove files as you go and change your tests to rapidly build up a test coverage.
+
+## Options
+
+### --config, -c [string] [default: null]
+
+Path to config file.
+
+### --url [string] [null]
+
+Url to html file.
+
+### --glob [array] [default: ['test/\*\*/\*.spec.{js,ts}']]
+
+Test glob pattern.
+
+### --watch [boolean] [default: false]
+
+Watch for changes.
+
+### --watchGlob, -wg [array] [default: ['src/\*\*/\*.{js,ts}', 'test/\*\*/\*.spec.{js,ts}']]
+
+Glob pattern for watching files that will trigger a rerun.
+
+### --coverage [boolean] [default: false]
+
+Generate coverage.
+
+### --babel.enable [boolean] [default: true]
+
+Enables babel tranformation.
+
+### --babel.core [string|module] [default: '']
+
+Path to babel core module.
+
+### --babel.babelPluginIstanbul [string|module] [default: '']
+
+Path to babel plugin istanbul module.
+
+### --babel.options [object] [default: {}]
+
+Pass options to babel.
+
+### --babel.typescript [string] [default: 'typescript']
+
+Path to typescript compiler module.
+
+### --transform.typescript.config [string] [default: tsconfig.json]
+
+Path to typescript config file.
+
+### --transform.typescript.babelOptions [object] [default: {}]
+
+Pass options to babel.
+
+### --transform.include [array] [default: []]
+
+Include glob for transformation.
+
+### --transform.exclude [array] [default: []]
+
+Exclude glob for transformation.
+
+### --transform.defaultExclude [array] [default: ['\*\*/coverage/\*\*','\*\*/external/\*\*','\*\*/autogenerated/\*\*','\*\*/\*.(html|css|json|txt|ttf|woff|svg)','\*\*/\*require\*.js','\*\*/\*sinon\*.js','\*\*/\*chai\*.js']]
+
+Default exclude glob for transformation.
+
+### --instrument.include [array] [default: []]
+
+Include glob for instrumentation.
+
+### --instrument.exclude [array] [default: []]
+
+Exclude glob for instrumentation.
+
+### --instrument.defaultExclude [array] [default: ['\*\*/coverage/\*\*','\*\*/external/\*\*','\*\*/autogenerated/\*\*','\*\*/\*.(html|css|json|txt|ttf|woff|svg)','\*\*/\*require\*.js','\*\*/\*sinon\*.js','\*\*/\*chai\*.js','\*\*/\*.spec.{js,ts}']]
+
+### --mocha.reporter [string] [default: undefined]
+
+Which reporter to use.
+
+Check Mochas [**list**](https://mochajs.org/#reporters) for valid options.
+
+
+### --mocha.bail [boolean] [default: true]
+
+Bails on failure
+
+### --mocha.timeout [number] [default: undefined]
+
+Timeout in ms.
+
+### --mocha.ui [string] [default: 'bdd']
+
+The test interface to use.
+
+### --mocha.useColors [boolean] [default: true]
+
+Use colors in output.
+
+### --client.port [number] [default: 9222]
+
+Chrome port.
+
+### --client.launch [boolean] [default: true]
+
+Launch Chrome.
+
+### --client.devtools [boolean] [default: false]
+
+Open Chrome with dev tools.
+
+### --chrome.port [number] [default: 9222]
+
+Chrome port.
+
+### --chrome.flags [array] [default: ['--headless', '--disable-gpu', '--allow-file-access-from-files']]
+
+Chrome flags.
+
+### --nyc.include [array] [default: []]
+
+### --http.port [number] [default: 9676]
+
+Http port.
+
+### --http.root [array] [default: ['./']]
+
+Root folders to serve.
+
+### --http.rewrite [object] [default: {}
+
+Rewrite url(s).
+
+### --nyc.tempDirectory [string] [default: './coverage/.nyc_output']
+
+Directory to output raw coverage information to.
+
+### --nyc.reporter [array] [default: ['lcov', 'text-summary']]
+
+Coverage reporter(s) to use.
+
+
+### --nyc.reportDir [string] [default: 'coverage']
+
+Directory to output coverage reports in.

docs/node.md

@@ -16,7 +16,7 @@ Add files, remove files as you go and change your tests to rapidly build up a te
 
 We are using the awesome 💖 [**jest-snapshot**](https://github.com/facebook/jest/tree/master/packages/jest-snapshot) package.
 
-<summary><details>
+<details><summary>Example</summary>
 <p>
 
 ```javascript
@@ -42,16 +42,16 @@ describe('button', () => {
 ```
 
 </p>
-</details></summary>
+</details>
 
 
 ## Options
 
-### \-\-presetEnv [boolean] [default: true]
+### --presetEnv [boolean] [default: true]
 
 Preset the test environment with Sinon, Chai, Sinon-Chai, Chai as promised and Chai subset.
 
-<summary><details>
+<details><summary>Details</summary>
 <p>
 
 ```javascript
@@ -83,7 +83,7 @@ describe('hello', () => {
 ```
 
 </p>
-</details></summary>
+</details>
 
 ### --config, -c [string] [default: null]
 
@@ -144,13 +144,13 @@ Path to babel plugin istanbul module
 
 Pass options to babel
 
-### --typescript [string] [default: 'typescript']
+### --babel.typescript [string] [default: 'typescript']
 
 Path to typescript compiler module
 
 ### --mocks [array] [default: [['\*.{scss,less,css}']],]
 
-<summary><details>
+<details><summary>Details</summary>
 <p>
 
 ```javascript
@@ -164,11 +164,11 @@ mocks: [
 ```
 
 </p>
-</details></summary>
+</details>
 
 ### --mocha.reporter [string] [default: undefined]
 
-Which reporter to use. 
+Which reporter to use.
 
 Check Mochas [**list**](https://mochajs.org/#reporters) for valid options.
 

website/i18n/en.json

@@ -4,7 +4,7 @@
     "next": "Next",
     "previous": "Previous",
     "tagline": "Testing, made simple",
-    "cdp": "Cdp",
+    "cdp": "Chrome",
     "installation": "Installation",
     "node": "Node",
     "protractor": "Protractor",