create-wdio 8.0.0 → 8.2.0

package/.eslintrc.cjs

@@ -33,5 +33,13 @@ module.exports = {
         'import/export': 2,
 
         'unicorn/prefer-node-protocol': ['error']
-    }
+    },
+    overrides: [
+        {
+            files: ['*.ts'],
+            rules: {
+                'no-undef': 'off'
+            }
+        }
+    ]
 }

package/README.md

@@ -23,7 +23,7 @@ To install a WebdriverIO project, you may choose one of the following methods:
 #### npx
 
 ```sh
-npx create-wdio ./e2e
+npx create-wdio@latest ./e2e
 ```
 
 _[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is a package runner tool that comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f)_
@@ -31,7 +31,7 @@ _[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f
 #### npm
 
 ```sh
-npm init wdio ./e2e
+npm init wdio@latest ./e2e
 ```
 
 _[`npm init <initializer>`](https://docs.npmjs.com/cli/v7/commands/npm-init) is available in npm 6+_
@@ -39,14 +39,14 @@ _[`npm init <initializer>`](https://docs.npmjs.com/cli/v7/commands/npm-init) is
 #### yarn
 
 ```sh
-yarn create wdio ./e2e
+yarn create wdio@latest ./e2e
 ```
 
 _[`yarn create <starter-kit-package>`](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_
 
 
 It will create a directory called `e2e` inside the current folder.
-Then it will run the configuration wizard that will help you setup your framework.
+Then it will run the configuration wizard that will help you set-up your framework.
 
 
 ## Supported Options

package/build/constants.js

@@ -46,10 +46,6 @@ export const PROGRAM_TITLE = `
               ${colorIt('Next-gen browser and mobile automation')}
                     ${colorIt('test framework for Node.js')}
 `;
-export const UNSUPPORTED_NODE_VERSION = (`You are using Node ${process.version} so the project will be bootstrapped with an old unsupported version of tools.\n\n` +
-    'Please update to Node 12 or higher for a better, fully supported experience.\n');
-export const COMMUNITY_DISCLAIMER = ('Join our Gitter community and instantly find answers to your issues or queries. Or just join and say hi 👋!\n' +
-    '  🔗 https://gitter.im/webdriverio/webdriverio\n' +
-    '\n' +
-    'Visit the project on GitHub to report bugs 🐛 or raise feature requests 💡:\n' +
-    '  🔗 https://github.com/webdriverio/webdriverio\n');
+export const UNSUPPORTED_NODE_VERSION = ('⚠️  Unsupported Node.js Version Error ⚠️\n' +
+    `You are using Node.js ${process.version} which is to old to be used with WebdriverIO.\n` +
+    'Please update to Node.js v16 to continue.\n');

package/build/index.js

@@ -2,9 +2,11 @@ import fs from 'node:fs/promises';
 import path from 'node:path';
 import chalk from 'chalk';
 import semver from 'semver';
+import hasYarn from 'has-yarn';
+import { readPackageUp } from 'read-pkg-up';
 import { Command } from 'commander';
-import { exists, runProgram, shouldUseYarn, getPackageVersion } from './utils.js';
-import { ASCII_ROBOT, PROGRAM_TITLE, UNSUPPORTED_NODE_VERSION, DEFAULT_NPM_TAG, COMMUNITY_DISCLAIMER } from './constants.js';
+import { runProgram, getPackageVersion } from './utils.js';
+import { ASCII_ROBOT, PROGRAM_TITLE, UNSUPPORTED_NODE_VERSION, DEFAULT_NPM_TAG } from './constants.js';
 const WDIO_COMMAND = 'wdio';
 let projectDir;
 export async function run(operation = createWebdriverIO) {
@@ -15,6 +17,14 @@ export async function run(operation = createWebdriverIO) {
     if (!(process.argv.includes('--version') || process.argv.includes('-v'))) {
         console.log(ASCII_ROBOT, PROGRAM_TITLE);
     }
+    /**
+     * ensure right Node.js version is used
+     */
+    const unsupportedNodeVersion = !semver.satisfies(process.version, '>=16');
+    if (unsupportedNodeVersion) {
+        console.log(chalk.yellow(UNSUPPORTED_NODE_VERSION));
+        return;
+    }
     const program = new Command(WDIO_COMMAND)
         .version(version, '-v, --version')
         .arguments('[project-path]')
@@ -30,35 +40,27 @@ export async function run(operation = createWebdriverIO) {
         .parse(process.argv);
     return operation(program.opts());
 }
-async function createWebdriverIO(opts) {
-    const cwd = process.cwd();
-    const useYarn = opts.useYarn && await shouldUseYarn();
+export async function createWebdriverIO(opts) {
     const npmTag = opts.npmTag.startsWith('@') ? opts.npmTag : `@${opts.npmTag}`;
-    const unsupportedNodeVersion = !semver.satisfies(process.version, '>=12');
-    if (unsupportedNodeVersion) {
-        console.log(chalk.yellow(UNSUPPORTED_NODE_VERSION));
-    }
     const root = path.resolve(process.cwd(), projectDir || '');
-    if (!await exists(root)) {
+    const rootDirExists = await fs.access(root).then(() => true, () => false);
+    if (!rootDirExists) {
         await fs.mkdir(root, { recursive: true });
     }
-    const pkgJsonPath = path.join(root, 'package.json');
-    console.log(`\nCreating WebdriverIO project in ${chalk.bold(root)}\n`);
-    if (!await exists(pkgJsonPath)) {
-        console.log(`Creating a ${chalk.bold('package.json')} for the directory.`);
-        const pkgJson = {
-            name: 'webdriverio-tests',
-            version: '0.1.0',
-            description: '',
-            private: true,
-            keywords: [],
-            author: '',
-            license: 'ISC'
-        };
-        await fs.writeFile(pkgJsonPath, JSON.stringify(pkgJson, null, 4));
-        console.log(chalk.green.bold('✔ Success!'));
+    /**
+     * check if a package.json exists and if not create one
+     */
+    const project = await readPackageUp({ cwd: root });
+    if (!project) {
+        await fs.writeFile(path.resolve(root, 'package.json'), JSON.stringify({
+            name: 'my-new-project',
+            type: 'module'
+        }, null, 2));
     }
-    console.log(`\nInstalling ${chalk.bold('@wdio/cli')} to initialize project.`);
+    console.log(`\nInstalling ${chalk.bold('@wdio/cli')} to initialize project...`);
+    const useYarn = typeof opts.useYarn === 'boolean'
+        ? opts.useYarn
+        : await hasYarn(root);
     const logLevel = opts.verbose ? 'trace' : 'error';
     const command = useYarn ? 'yarnpkg' : 'npm';
     const args = useYarn
@@ -66,24 +68,10 @@ async function createWebdriverIO(opts) {
         : ['install', opts.dev ? '--save-dev' : '--save', '--loglevel', logLevel, `@wdio/cli${npmTag}`];
     await runProgram(command, args, { cwd: root, stdio: 'ignore' });
     console.log(chalk.green.bold('✔ Success!'));
-    console.log('\nRunning WDIO CLI Wizard...');
-    await runProgram('npx', [
+    return runProgram('npx', [
         WDIO_COMMAND,
         'config',
         ...(useYarn ? ['--yarn'] : []),
         ...(opts.yes ? ['--yes'] : [])
     ], { cwd: root });
-    if (await exists(pkgJsonPath)) {
-        console.log(`Adding ${chalk.bold(`"${WDIO_COMMAND}"`)} script to package.json.`);
-        const isUsingTypescript = await exists('test/wdio.conf.ts');
-        const script = `wdio run ${isUsingTypescript ? 'test/wdio.conf.ts' : 'wdio.conf.js'}`;
-        await runProgram('npm', ['set-script', WDIO_COMMAND, script], { cwd: root });
-        console.log(chalk.green.bold('✔ Success!'));
-    }
-    console.log(`\n🤖 Successfully setup project at ${root} 🎉\n`);
-    console.log(COMMUNITY_DISCLAIMER);
-    if (root != cwd) {
-        console.log(`${chalk.bold.yellow('⚠')} First, change the directory via: ${chalk.cyan('$ cd')} ${chalk.green(root)}`);
-    }
-    console.log(`To start the test, run: ${chalk.cyan('$ npm run')} ${chalk.green(WDIO_COMMAND)}`);
 }

package/build/utils.js

@@ -6,26 +6,22 @@ import chalk from 'chalk';
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 export const colorItBold = chalk.bold.rgb(234, 89, 6);
 export const colorIt = chalk.rgb(234, 89, 6);
-export function exists(path) {
-    return fs.access(path).then(() => true, () => false);
-}
+process.on('SIGINT', () => printAndExit(undefined, 'SIGINT'));
 export function runProgram(command, args, options) {
     const child = spawn(command, args, { stdio: 'inherit', ...options });
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve, rejects) => {
         let error;
         child.on('error', (e) => (error = e));
-        child.on('close', code => {
+        child.on('close', (code, signal) => {
             if (code !== 0) {
-                return reject(new Error((error && error.message) ||
-                    `Error calling: ${command} ${args.join(' ')}`));
+                const errorMessage = (error && error.message) || `Error calling: ${command} ${args.join(' ')}`;
+                printAndExit(errorMessage, signal);
+                return rejects(errorMessage);
             }
             resolve();
         });
     });
 }
-export function shouldUseYarn() {
-    return runProgram('yarnpkg', ['--version'], { stdio: 'ignore' }).then(() => true, () => false);
-}
 export async function getPackageVersion() {
     try {
         const pkgJsonPath = path.join(__dirname, '..', 'package.json');
@@ -37,3 +33,12 @@ export async function getPackageVersion() {
     }
     return 'unknown';
 }
+function printAndExit(error, signal) {
+    if (signal === 'SIGINT') {
+        console.log('\n\nGoodbye 👋');
+    }
+    else {
+        console.log(`\n\n⚠️  Ups, something went wrong${error ? `: ${error}` : ''}!`);
+    }
+    process.exit(1);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-wdio",
-  "version": "8.0.0",
+  "version": "8.2.0",
   "description": "Install and setup a WebdriverIO project with all its dependencies in a single run",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
@@ -39,24 +39,26 @@
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.2",
-    "@types/node": "^18.7.23",
-    "@types/semver": "^7.3.12",
-    "@typescript-eslint/eslint-plugin": "^5.38.1",
-    "@typescript-eslint/parser": "^5.38.1",
-    "@vitest/coverage-c8": "^0.23.4",
+    "@types/node": "^18.11.13",
+    "@types/semver": "^7.3.13",
+    "@typescript-eslint/eslint-plugin": "^5.46.0",
+    "@typescript-eslint/parser": "^5.46.0",
+    "@vitest/coverage-c8": "^0.25.7",
     "c8": "^7.12.0",
-    "eslint": "^8.24.0",
+    "eslint": "^8.29.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-unicorn": "^43.0.2",
+    "eslint-plugin-unicorn": "^45.0.1",
     "npm-run-all": "^4.1.5",
-    "release-it": "^15.4.2",
-    "typescript": "^4.8.4",
-    "vitest": "^0.23.4"
+    "release-it": "^15.5.1",
+    "typescript": "^4.9.4",
+    "vitest": "^0.25.7"
   },
   "dependencies": {
-    "chalk": "^5.0.1",
-    "commander": "^9.4.0",
+    "chalk": "^5.2.0",
+    "commander": "^9.4.1",
     "cross-spawn": "^7.0.3",
-    "semver": "^7.3.7"
+    "has-yarn": "^3.0.0",
+    "read-pkg-up": "^9.1.0",
+    "semver": "^7.3.8"
   }
 }

package/vitest.config.ts

@@ -14,10 +14,10 @@ export default defineConfig({
         coverage: {
             enabled: true,
             exclude: ['**/build/**', '__mocks__', '**/*.test.ts'],
-            lines: 95,
-            functions: 75,
-            branches: 95,
-            statements: 95
+            lines: 98,
+            functions: 80,
+            branches: 77,
+            statements: 98
         }
     }
 })