create-wdio 8.3.4 → 8.4.1

package/build/constants.js

@@ -55,6 +55,18 @@ export const INSTALL_COMMAND = {
     yarn: 'add',
     bun: 'install'
 };
+export const EXECUTER = {
+    npm: 'npx',
+    pnpm: 'pnpm',
+    yarn: 'yarn',
+    bun: 'bunx'
+};
+export const EXECUTE_COMMAND = {
+    npm: '',
+    pnpm: 'exec',
+    yarn: 'exec',
+    bun: ''
+};
 export const DEV_FLAG = {
     npm: '--save-dev',
     pnpm: '--save-dev',

package/build/index.js

@@ -1,12 +1,13 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
+import { pathToFileURL } from 'node:url';
 import chalk from 'chalk';
 import semver from 'semver';
-import { detect } from 'detect-package-manager';
-import { readPackageUp } from 'read-pkg-up';
 import { Command } from 'commander';
+import { resolve } from 'import-meta-resolve';
 import { runProgram, getPackageVersion } from './utils.js';
-import { ASCII_ROBOT, PROGRAM_TITLE, UNSUPPORTED_NODE_VERSION, DEFAULT_NPM_TAG, INSTALL_COMMAND, DEV_FLAG, PMs } from './constants.js';
+import { ASCII_ROBOT, PROGRAM_TITLE, UNSUPPORTED_NODE_VERSION, DEFAULT_NPM_TAG, INSTALL_COMMAND, DEV_FLAG, PMs, EXECUTER, EXECUTE_COMMAND } from './constants.js';
+import { execSync } from 'node:child_process';
 const WDIO_COMMAND = 'wdio';
 let projectDir;
 export async function run(operation = createWebdriverIO) {
@@ -42,46 +43,57 @@ export async function createWebdriverIO(opts) {
     const npmTag = opts.npmTag.startsWith('@') ? opts.npmTag : `@${opts.npmTag}`;
     const root = path.resolve(process.cwd(), projectDir || '');
     /**
-     * check if a package.json exists and if not create one
+     * find package manager that was used to create project
      */
-    const project = await readPackageUp({ cwd: root });
-    if (!project) {
+    const pm = PMs.find((pm) => (
+    // for pnpm check "~/Library/pnpm/store/v3/..."
+    // for NPM check "~/.npm/npx/..."
+    // for Yarn check "~/.yarn/bin/create-wdio"
+    // for Bun check "~/.bun/bin/create-wdio"
+    process.argv[1].includes(`${path.sep}${pm}${path.sep}`) ||
+        process.argv[1].includes(`${path.sep}.${pm}${path.sep}`))) || 'npm';
+    const hasPackageJson = await fs.access(path.resolve(root, 'package.json')).then(() => true).catch(() => false);
+    if (!hasPackageJson) {
         await fs.mkdir(root, { recursive: true });
         await fs.writeFile(path.resolve(root, 'package.json'), JSON.stringify({
-            name: 'my-new-project',
+            name: root.replace(/\/$/, '').split('/').pop(),
             type: 'module'
         }, null, 2));
-        /**
-         * find package manager that was used to create project
-         */
-        const pm = PMs.find((pm) => (
-        // for pnpm check for "~/Library/pnpm/store/v3/..."
-        process.argv[1].includes(`${path.sep}${pm}${path.sep}`) ||
-            // for NPM and Yarn check for "~/.npm/npx/..." or "~/.yarn/bin/create-wdio"
-            process.argv[1].includes(`${path.sep}.${pm}${path.sep}`))) || 'npm';
-        /**
-         * create a package-lock.json, yarn.lock or pnpm-lock.yaml so
-         * that `detect-package-manager` doesn't mark it as a default
-         * Yarn project
-         * @see https://github.com/egoist/detect-package-manager/issues/11
-         */
-        await runProgram(pm, ['install'], { cwd: root, stdio: 'ignore' });
     }
-    console.log(`\nInstalling ${chalk.bold('@wdio/cli')} to initialize project...`);
-    const pm = await detect({ cwd: root });
-    const args = [INSTALL_COMMAND[pm]];
-    if (pm === 'yarn') {
-        args.push('--exact', '--cwd', root);
+    const cliInstalled = await isCLIInstalled(root);
+    if (!cliInstalled) {
+        console.log(`\nInstalling ${chalk.bold('@wdio/cli')} to initialize project...`);
+        const args = [INSTALL_COMMAND[pm]];
+        if (pm === 'yarn') {
+            args.push('--exact', '--cwd', root);
+        }
+        if (opts.dev) {
+            args.push(DEV_FLAG[pm]);
+        }
+        args.push(`@wdio/cli${npmTag}`);
+        await runProgram(pm, args, { cwd: root, stdio: 'ignore' });
+        console.log(chalk.green.bold('✔ Success!'));
     }
-    if (opts.dev) {
-        args.push(DEV_FLAG[pm]);
-    }
-    args.push(`@wdio/cli${npmTag}`);
-    await runProgram(pm, args, { cwd: root, stdio: 'ignore' });
-    console.log(chalk.green.bold('✔ Success!'));
-    return runProgram('npx', [
+    return runProgram(EXECUTER[pm], [
+        EXECUTE_COMMAND[pm],
         WDIO_COMMAND,
         'config',
         ...(opts.yes ? ['--yes'] : [])
-    ], { cwd: root });
+    ].filter(i => !!i), { cwd: root });
+}
+async function isCLIInstalled(path) {
+    try {
+        // can be replaced with import.meta.resolve('@wdio/cli', new URL(`file:///${root}`).href) in the future
+        // check if the cli is installed in the project
+        resolve('@wdio/cli', pathToFileURL(path).href);
+        return true;
+    }
+    catch (error) {
+        // check of the cli is installed globally
+        const output = execSync('npm ls -g', { encoding: 'utf-8' });
+        if (output.includes('@wdio/cli')) {
+            return true;
+        }
+        return false;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-wdio",
-  "version": "8.3.4",
+  "version": "8.4.1",
   "description": "Install and setup a WebdriverIO project with all its dependencies in a single run",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
@@ -46,9 +46,9 @@
     "@vitest/coverage-v8": "^0.34.1",
     "eslint": "^8.45.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-unicorn": "^48.0.0",
+    "eslint-plugin-unicorn": "^49.0.0",
     "npm-run-all": "^4.1.5",
-    "release-it": "^16.1.2",
+    "release-it": "^17.0.0",
     "typescript": "^5.1.6",
     "vitest": "^0.34.1"
   },
@@ -56,8 +56,7 @@
     "chalk": "^5.3.0",
     "commander": "^11.0.0",
     "cross-spawn": "^7.0.3",
-    "detect-package-manager": "^3.0.1",
-    "read-pkg-up": "^10.0.0",
+    "import-meta-resolve": "^4.0.0",
     "semver": "^7.5.4"
   }
 }