feat: add support for config files

hugomrdias · Dec 9, 2020 · d657f37 · d657f37
1 parent 06bd0d4
commit d657f37
Show file tree

Hide file tree

Showing 11 changed files with 132 additions and 145 deletions.
diff --git a/cli.js b/cli.js
@@ -5,8 +5,10 @@
 
 const sade = require('sade');
 const kleur = require('kleur');
+const lilconfig = require('lilconfig');
+const merge = require('merge-options').bind({ ignoreUndefined: true });
 const pkg = require('./package.json');
-const { findTests, defaultTestPatterns, runnerOptions } = require('./src/utils');
+const { runnerOptions } = require('./src/utils');
 const UvuRunner = require('./src/runner-uvu');
 const MochaRunner = require('./src/runner-mocha');
 const TapeRunner = require('./src/runner-tape');
@@ -68,29 +70,19 @@ sade2
     .version(pkg.version)
     .describe('Run mocha, zora, uvu, tape and benchmark.js scripts inside real browsers with `playwright`.')
     .option('-r, --runner', 'Test runner. Options: mocha, tape, benchmark and zora.', 'mocha')
-    .option('-b, --browser', 'Browser to run tests. Options: chromium, firefox, webkit.', 'chromium')
-    .option('-m, -mode', 'Run mode. Options: main, worker.', 'main')
+    .option('-b, --browser', 'Browser to run tests. Options: chromium, firefox, webkit.  (default chromium)')
+    .option('-m, --mode', 'Run mode. Options: main, worker.  (default main)')
     .option('-d, --debug', 'Debug mode, keeps browser window open.')
     .option('-w, --watch', 'Watch files for changes and re-run tests.')
     .option('-i, --incognito', 'Use incognito window to run tests.')
-    .option('-e, --extension', ' Use extension background_page to run tests.')
+    .option('-e, --extension', 'Use extension background_page to run tests.')
     .option('--cov', 'Enable code coverage in istanbul format. Outputs \'.nyc_output/out.json\'.')
     .option('--before', 'Full path to a script to be loaded on a separate tab before the main script.')
-    .option('--assets', 'Assets to be served by the http server.', process.cwd())
-    .option('--cwd', 'Current directory.', process.cwd())
-    .option('--extensions', 'File extensions allowed in the bundle.', 'js,cjs,mjs')
+    .option('--assets', 'Assets to be served by the http server.  (default process.cwd())')
+    .option('--cwd', 'Current directory.  (default process.cwd())')
+    .option('--extensions', 'File extensions allowed in the bundle.  (default js,cjs,mjs)')
     .action((input, opts) => {
-        const extensions = opts.extensions.split(',');
-        const tests = findTests({
-            cwd: opts.cwd,
-            extensions: extensions,
-            filePatterns: input ? input : defaultTestPatterns(extensions)
-        });
-
-        if (tests.length === 0) {
-            console.log('No test files were found.');
-            process.exit(0);
-        }
+        const config = lilconfig.lilconfigSync('playwright-test').search();
 
         let Runner = null;
 
@@ -114,20 +106,23 @@ sade2
                 console.error('Runner not supported: ', opts.runner);
                 process.exit(1);
         }
-        const runner = new Runner({
-            cwd: opts.cwd,
-            assets: opts.assets,
-            browser: opts.browser,
-            debug: opts.debug,
-            mode: opts.mode,
-            incognito: opts.incognito,
-            files: tests,
-            extension: opts.extension,
-            runnerOptions: runnerOptions(opts),
-            before: opts.before,
-            node: opts.node,
-            cov: opts.cov
-        });
+        const runner = new Runner(merge(
+            config ? config.config : {},
+            {
+                cwd: opts.cwd,
+                assets: opts.assets,
+                browser: opts.browser,
+                debug: opts.debug,
+                mode: opts.mode,
+                incognito: opts.incognito,
+                input,
+                extension: opts.extension,
+                runnerOptions: runnerOptions(opts),
+                before: opts.before,
+                node: opts.node,
+                cov: opts.cov
+            }
+        ));
 
         if (opts.watch) {
             runner.watch();

diff --git a/package.json b/package.json
@@ -45,6 +45,7 @@
         "get-port": "^5.1.1",
         "globby": "^11.0.1",
         "kleur": "^4.1.3",
+        "lilconfig": "^2.0.2",
         "lodash": "^4.17.20",
         "merge-options": "^3.0.4",
         "ora": "^5.1.0",

diff --git a/readme.md b/readme.md
@@ -5,14 +5,20 @@
 
 ## Install
 
-```
+```shell
 $ npm install playwright-test
 ```
 
-
 ## Usage
+```shell
+$ playwright-test [files] [options]
+# or 
+$ pw-test [files] [options]
+
+```
+## Options
 
-```console
+```shell
 Description
     Run mocha, zora, uvu, tape and benchmark.js scripts inside real browsers with `playwright`.
 
@@ -26,7 +32,7 @@ Description
     -d, --debug        Debug mode, keeps browser window open.
     -w, --watch        Watch files for changes and re-run tests.
     -i, --incognito    Use incognito window to run tests.
-    -e, --extension     Use extension background_page to run tests.
+    -e, --extension    Use extension background_page to run tests.
     --cov              Enable code coverage in istanbul format. Outputs '.nyc_output/out.json'.
     --before           Full path to a script to be loaded on a separate tab before the main script.
     --assets           Assets to be served by the http server.  (default process.cwd())

diff --git a/src/runner-benchmark.js b/src/runner-benchmark.js
@@ -14,7 +14,7 @@ class BenchmarkRunner extends Runner {
             {
                 entry: [
                     require.resolve('./setup-bench.js'),
-                    ...this.options.files
+                    ...this.tests
                 ],
                 module: { noParse: /src\/benchmark.js/ },
                 resolve: { alias: { benchmark: path.resolve(__dirname, 'setup-bench.js') } }

diff --git a/src/runner-mocha.js b/src/runner-mocha.js
@@ -28,16 +28,21 @@ mocha
 
 class MochaRunner extends Runner {
     constructor(options = {}) {
-        super(merge({
-            runnerOptions: {
-                allowUncaught: false,
-                bail: true,
-                reporter: 'spec',
-                timeout: 5000,
-                color: true,
-                ui: 'bdd'
-            }
-        }, options));
+        super(
+            merge(
+                {
+                    runnerOptions: {
+                        allowUncaught: false,
+                        bail: true,
+                        reporter: 'spec',
+                        timeout: 5000,
+                        color: true,
+                        ui: 'bdd'
+                    }
+                },
+                options
+            )
+        );
     }
 
     async runTests() {
@@ -69,10 +74,7 @@ class MochaRunner extends Runner {
         const config = webpackMerge(
             defaultWebpackConfig(this.dir, this.env, this.options),
             {
-                entry: [
-                    require.resolve('./setup-mocha.js'),
-                    ...this.options.files
-                ],
+                entry: [require.resolve('./setup-mocha.js'), ...this.tests],
                 resolve: { alias: { 'mocha/mocha': resolveCwd('mocha/mocha.js') } }
             }
         );

diff --git a/src/runner-tape.js b/src/runner-tape.js
@@ -12,12 +12,8 @@ class TapeRunner extends Runner {
         const config = merge(
             defaultWebpackConfig(this.dir, this.env, this.options),
             {
-                entry: [
-                    require.resolve('./setup-tape.js'),
-                    ...this.options.files
-                ],
+                entry: [require.resolve('./setup-tape.js'), ...this.tests],
                 resolve: { alias: { tape: resolveCwd('tape') } }
-
             }
         );
 

diff --git a/src/runner-uvu.js b/src/runner-uvu.js
@@ -34,11 +34,7 @@ class UvuRunner extends Runner {
     compiler() {
         const config = merge(
             defaultWebpackConfig(this.dir, this.env, this.options),
-            {
-                entry: [
-                    ...this.options.files
-                ]
-            }
+            { entry: this.tests }
         );
 
         return webpack(config);

diff --git a/src/runner-zora.js b/src/runner-zora.js
@@ -57,9 +57,7 @@ class ZoraRunner extends Runner {
         const config = merge(
             defaultWebpackConfig(this.dir, this.env, this.options),
             {
-                entry: [
-                    ...this.options.files
-                ],
+                entry: this.tests,
                 resolve: { alias: { zora$: path.resolve(__dirname, 'setup-zora.js') } }
             }
         );