create-wdio 8.2.4 → 8.3.0

package/README.md

@@ -44,6 +44,13 @@ yarn create wdio@latest ./e2e
 
 _[`yarn create <starter-kit-package>`](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_
 
+#### pnpm
+
+```sh
+pnpm create wdio ./e2e
+```
+
+_[`pnpm create <starter-kit-package>`](https://pnpm.io/cli/create) is available in pnpm v7+_
 
 It will create a directory called `e2e` inside the current folder.
 Then it will run the configuration wizard that will help you set-up your framework.
@@ -55,9 +62,7 @@ You can pass the following command line flags to modify the bootstrap mechanism:
 
 * `--dev` - Install all packages as `devDependencies` (default: `true`)
 * `--yes` - Will fill in all config defaults without prompting (default: `false`)
-* `--use-yarn` - yes, we support yarn too! (default: `true`)
 * `--npm-tag` - use a specific NPM tag for `@wdio/cli` package (default: `latest`)
-* `--verbose` - print additional logs (default: `false`)
 
 ----
 

package/build/constants.js

@@ -49,3 +49,15 @@ export const PROGRAM_TITLE = `
 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');
+export const INSTALL_COMMAND = {
+    npm: 'install',
+    pnpm: 'add',
+    yarn: 'add',
+    bun: 'install'
+};
+export const DEV_FLAG = {
+    npm: '--save-dev',
+    pnpm: '--save-dev',
+    yarn: '--dev',
+    bun: '--dev'
+};

package/build/index.js

@@ -2,11 +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 { detect } from 'detect-package-manager';
 import { readPackageUp } from 'read-pkg-up';
 import { Command } from 'commander';
 import { runProgram, getPackageVersion } from './utils.js';
-import { ASCII_ROBOT, PROGRAM_TITLE, UNSUPPORTED_NODE_VERSION, DEFAULT_NPM_TAG } from './constants.js';
+import { ASCII_ROBOT, PROGRAM_TITLE, UNSUPPORTED_NODE_VERSION, DEFAULT_NPM_TAG, INSTALL_COMMAND, DEV_FLAG } from './constants.js';
 const WDIO_COMMAND = 'wdio';
 let projectDir;
 export async function run(operation = createWebdriverIO) {
@@ -31,8 +31,6 @@ export async function run(operation = createWebdriverIO) {
         .usage(`${chalk.green('[project-path]')} [options]`)
         .action(name => (projectDir = name))
         .option('-t, --npm-tag <tag>', 'Which NPM version you like to install, e.g. @next', DEFAULT_NPM_TAG)
-        .option('-u, --use-yarn', 'Use Yarn package manager to install packages', false)
-        .option('-v, --verbose', 'print additional logs')
         .option('-y, --yes', 'will fill in all config defaults without prompting', false)
         .option('-d, --dev', 'Install all packages as into devDependencies', true)
         .allowUnknownOption()
@@ -43,35 +41,38 @@ export async function run(operation = createWebdriverIO) {
 export async function createWebdriverIO(opts) {
     const npmTag = opts.npmTag.startsWith('@') ? opts.npmTag : `@${opts.npmTag}`;
     const root = path.resolve(process.cwd(), projectDir || '');
-    const rootDirExists = await fs.access(root).then(() => true, () => false);
-    if (!rootDirExists) {
-        await fs.mkdir(root, { recursive: true });
-    }
     /**
      * check if a package.json exists and if not create one
      */
     const project = await readPackageUp({ cwd: root });
     if (!project) {
+        await fs.mkdir(root, { recursive: true });
         await fs.writeFile(path.resolve(root, 'package.json'), JSON.stringify({
             name: 'my-new-project',
             type: 'module'
         }, null, 2));
+        /**
+         * create a package-lock.json so that `detect-package-manager`
+         * doesn't mark it as a Yarn project
+         * @see https://github.com/egoist/detect-package-manager/issues/11
+         */
+        await runProgram('npm', ['install'], { cwd: root, stdio: 'ignore' });
     }
     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
-        ? ['add', ...(opts.dev ? ['-D'] : []), '--exact', '--cwd', root, `@wdio/cli${npmTag}`]
-        : ['install', opts.dev ? '--save-dev' : '--save', '--loglevel', logLevel, `@wdio/cli${npmTag}`];
-    await runProgram(command, args, { cwd: root, stdio: 'ignore' });
+    const pm = await detect({ cwd: root });
+    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!'));
     return runProgram('npx', [
         WDIO_COMMAND,
         'config',
-        ...(useYarn ? ['--yarn'] : []),
         ...(opts.yes ? ['--yes'] : [])
     ], { cwd: root });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-wdio",
-  "version": "8.2.4",
+  "version": "8.3.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,25 +39,25 @@
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.2",
-    "@types/node": "^20.3.1",
+    "@types/node": "^20.4.2",
     "@types/semver": "^7.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.59.11",
-    "@typescript-eslint/parser": "^5.59.11",
-    "@vitest/coverage-v8": "^0.32.0",
-    "eslint": "^8.42.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "@vitest/coverage-v8": "^0.34.1",
+    "eslint": "^8.45.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-unicorn": "^47.0.0",
+    "eslint-plugin-unicorn": "^48.0.0",
     "npm-run-all": "^4.1.5",
-    "release-it": "^15.11.0",
-    "typescript": "^5.1.3",
-    "vitest": "^0.32.0"
+    "release-it": "^16.1.2",
+    "typescript": "^5.1.6",
+    "vitest": "^0.34.1"
   },
   "dependencies": {
-    "chalk": "^5.2.0",
-    "commander": "^10.0.1",
+    "chalk": "^5.3.0",
+    "commander": "^11.0.0",
     "cross-spawn": "^7.0.3",
-    "has-yarn": "^3.0.0",
-    "read-pkg-up": "^9.1.0",
-    "semver": "^7.5.1"
+    "detect-package-manager": "^3.0.1",
+    "read-pkg-up": "^10.0.0",
+    "semver": "^7.5.4"
   }
 }