@wdio/cli 8.17.0 → 8.18.2

package/build/utils.js

@@ -1,12 +1,10 @@
 import fs from 'node:fs/promises';
-import util from 'node:util';
-import { dirname } from 'node:path';
+import util, { promisify } from 'node:util';
+import path, { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { execSync, spawn } from 'node:child_process';
-import { promisify } from 'node:util';
 import ejs from 'ejs';
 import chalk from 'chalk';
-import path from 'node:path';
 import inquirer from 'inquirer';
 import pickBy from 'lodash.pickby';
 import logger from '@wdio/logger';
@@ -18,7 +16,8 @@ import { resolve } from 'import-meta-resolve';
 import { SevereServiceError } from 'webdriverio';
 import { ConfigParser } from '@wdio/config';
 import { CAPABILITY_KEYS } from '@wdio/protocols';
-import { ANDROID_CONFIG, IOS_CONFIG, QUESTIONNAIRE, pkg, CompilerOptions, TESTING_LIBRARY_PACKAGES, DEPENDENCIES_INSTALLATION_MESSAGE } from './constants.js';
+import { ANDROID_CONFIG, CompilerOptions, DEPENDENCIES_INSTALLATION_MESSAGE, IOS_CONFIG, pkg, QUESTIONNAIRE, TESTING_LIBRARY_PACKAGES, COMMUNITY_PACKAGES_WITH_TS_SUPPORT, usesSerenity, } from './constants.js';
+import { EjsHelpers } from './templates/EjsHelpers.js';
 const log = logger('@wdio/cli:utils');
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const NPM_COMMAND = /^win/.test(process.platform) ? 'npm.cmd' : 'npm';
@@ -181,6 +180,44 @@ export function convertPackageHashToObject(pkg, hash = '$--$') {
     const [p, short, purpose] = pkg.split(hash);
     return { package: p, short, purpose };
 }
+export function getSerenityPackages(answers) {
+    const framework = convertPackageHashToObject(answers.framework);
+    if (framework.package !== '@serenity-js/webdriverio') {
+        return [];
+    }
+    const isUsingTypeScript = answers.isUsingCompiler === CompilerOptions.TS;
+    const packages = {
+        cucumber: [
+            '@cucumber/cucumber',
+            '@serenity-js/cucumber',
+        ],
+        mocha: [
+            '@serenity-js/mocha',
+            'mocha',
+            isUsingTypeScript && '@types/mocha',
+        ],
+        jasmine: [
+            '@serenity-js/jasmine',
+            'jasmine',
+            isUsingTypeScript && '@types/jasmine',
+        ],
+        common: [
+            '@serenity-js/assertions',
+            '@serenity-js/console-reporter',
+            '@serenity-js/core',
+            '@serenity-js/rest',
+            '@serenity-js/serenity-bdd',
+            '@serenity-js/web',
+            isUsingTypeScript && '@types/node',
+            'npm-failsafe',
+            'rimraf',
+        ]
+    };
+    return [
+        ...packages[framework.purpose],
+        ...packages.common,
+    ].filter(Boolean).sort();
+}
 export async function getCapabilities(arg) {
     const optionalCapabilites = {
         platformVersion: arg.platformVersion,
@@ -287,6 +324,9 @@ export async function hasPackage(pkg) {
  * generate test files based on CLI answers
  */
 export async function generateTestFiles(answers) {
+    if (answers.serenityAdapter) {
+        return generateSerenityExamples(answers);
+    }
     if (answers.runner === 'local') {
         return generateLocalRunnerTestFiles(answers);
     }
@@ -345,6 +385,25 @@ async function generateLocalRunnerTestFiles(answers) {
         await fs.writeFile(destPath, renderedTpl);
     }
 }
+async function generateSerenityExamples(answers) {
+    const templateDirectories = {
+        [answers.projectRootDir]: path.join(TEMPLATE_ROOT_DIR, 'serenity-js', 'common', 'config'),
+        [answers.destSpecRootPath]: path.join(TEMPLATE_ROOT_DIR, 'serenity-js', answers.serenityAdapter),
+        [answers.destSerenityLibRootPath]: path.join(TEMPLATE_ROOT_DIR, 'serenity-js', 'common', 'serenity'),
+    };
+    for (const [destinationRootDir, templateRootDir] of Object.entries(templateDirectories)) {
+        const pathsToTemplates = await readDir(templateRootDir);
+        for (const pathToTemplate of pathsToTemplates) {
+            const extension = answers.isUsingTypeScript ? '.ts' : '.js';
+            const destination = path.join(destinationRootDir, path.relative(templateRootDir, pathToTemplate))
+                .replace(/\.ejs$/, '')
+                .replace(/\.ts$/, extension);
+            const contents = await renderFile(pathToTemplate, { answers, _: new EjsHelpers({ useEsm: answers.esmSupport, useTypeScript: answers.isUsingTypeScript }) });
+            await fs.mkdir(path.dirname(destination), { recursive: true });
+            await fs.writeFile(destination, contents);
+        }
+    }
+}
 export async function getAnswers(yes) {
     if (yes) {
         const ignoredQuestions = ['e2eEnvironment'];
@@ -430,6 +489,9 @@ export function getPathForFileGeneration(answers, projectRootDir) {
     const destPageObjectRootPath = answers.usePageObjects
         ? path.resolve(projectRootDir, path.dirname(answers.pages || '').replace(/\*\*$/, ''))
         : '';
+    const destSerenityLibRootPath = usesSerenity(answers)
+        ? path.resolve(projectRootDir, answers.serenityLibPath || 'serenity')
+        : '';
     const relativePath = (answers.generateTestFiles && answers.usePageObjects)
         ? !(convertPackageHashToObject(answers.framework).short === 'cucumber')
             ? path.relative(destSpecRootPath, destPageObjectRootPath)
@@ -439,6 +501,7 @@ export function getPathForFileGeneration(answers, projectRootDir) {
         destSpecRootPath: destSpecRootPath,
         destStepRootPath: destStepRootPath,
         destPageObjectRootPath: destPageObjectRootPath,
+        destSerenityLibRootPath: destSerenityLibRootPath,
         relativePath: relativePath.replaceAll(path.sep, '/')
     };
 }
@@ -628,84 +691,94 @@ export function npmInstall(parsedAnswers, useYarn, npmTag) {
  * add ts-node if TypeScript is desired but not installed
  */
 export async function setupTypeScript(parsedAnswers) {
-    if (!parsedAnswers.isUsingTypeScript) {
+    /**
+     * don't create a `tsconfig.json` if user doesn't want to use TypeScript
+     * or if a `tsconfig.json` already exists
+     */
+    if (!parsedAnswers.isUsingTypeScript || parsedAnswers.hasRootTSConfig) {
         return;
     }
     console.log('Setting up TypeScript...');
     const frameworkPackage = convertPackageHashToObject(parsedAnswers.rawAnswers.framework);
     const servicePackages = parsedAnswers.rawAnswers.services.map((service) => convertPackageHashToObject(service));
     parsedAnswers.packagesToInstall.push('ts-node', 'typescript');
+    const serenityTypes = parsedAnswers.serenityAdapter === 'jasmine' ? ['jasmine'] : [];
     const types = [
         'node',
         '@wdio/globals/types',
         'expect-webdriverio',
-        frameworkPackage.package,
+        ...(parsedAnswers.serenityAdapter ? serenityTypes : [frameworkPackage.package]),
         ...(parsedAnswers.runner === 'browser' ? ['@wdio/browser-runner'] : []),
         ...servicePackages
             .map(service => service.package)
+            .filter(service => (
+        /**
+         * given that we know that all "official" services have
+         * typescript support we only include them
+         */
+        service.startsWith('@wdio') ||
             /**
-             * given that we know that all "offical" services have
-             * typescript support we only include them
+             * also include community maintained packages with known
+             * support for TypeScript
              */
-            .filter(service => service.startsWith('@wdio'))
+            COMMUNITY_PACKAGES_WITH_TS_SUPPORT.includes(service)))
     ];
-    if (!parsedAnswers.hasRootTSConfig) {
-        const preset = getPreset(parsedAnswers);
-        const config = {
-            compilerOptions: {
-                // compiler
-                moduleResolution: 'node',
-                module: !parsedAnswers.esmSupport ? 'commonjs' : 'ESNext',
-                target: 'es2022',
-                types,
-                skipLibCheck: true,
-                // bundler
-                noEmit: true,
-                allowImportingTsExtensions: true,
-                resolveJsonModule: true,
-                isolatedModules: true,
-                // linting
-                strict: true,
-                noUnusedLocals: true,
-                noUnusedParameters: true,
-                noFallthroughCasesInSwitch: true,
-                ...Object.assign(preset === 'lit'
-                    ? {
-                        experimentalDecorators: true,
-                        useDefineForClassFields: false
-                    }
-                    : {}, preset === 'react'
-                    ? {
-                        jsx: 'react-jsx'
-                    }
-                    : {}, preset === 'preact'
-                    ? {
-                        jsx: 'react-jsx',
-                        jsxImportSource: 'preact'
-                    }
-                    : {}, preset === 'solid'
-                    ? {
-                        jsx: 'preserve',
-                        jsxImportSource: 'solid-js'
-                    }
-                    : {}, preset === 'stencil'
-                    ? {
-                        experimentalDecorators: true,
-                        jsx: 'react',
-                        jsxFactory: 'h',
-                        jsxFragmentFactory: 'Fragment'
-                    }
-                    : {})
-            },
-            include: preset === 'svelte'
-                ? ['src/**/*.d.ts', 'src/**/*.ts', 'src/**/*.js', 'src/**/*.svelte']
-                : preset === 'vue'
-                    ? ['src/**/*.ts', 'src/**/*.d.ts', 'src/**/*.tsx', 'src/**/*.vue']
-                    : ['test']
-        };
-        await fs.mkdir(path.dirname(parsedAnswers.tsConfigFilePath), { recursive: true });
-        await fs.writeFile(parsedAnswers.tsConfigFilePath, JSON.stringify(config, null, 4));
-    }
+    const preset = getPreset(parsedAnswers);
+    const config = {
+        compilerOptions: {
+            // compiler
+            moduleResolution: 'node',
+            module: !parsedAnswers.esmSupport ? 'commonjs' : 'ESNext',
+            target: 'es2022',
+            lib: ['es2022', 'dom'],
+            types,
+            skipLibCheck: true,
+            // bundler
+            noEmit: true,
+            allowImportingTsExtensions: true,
+            resolveJsonModule: true,
+            isolatedModules: true,
+            // linting
+            strict: true,
+            noUnusedLocals: true,
+            noUnusedParameters: true,
+            noFallthroughCasesInSwitch: true,
+            ...Object.assign(preset === 'lit'
+                ? {
+                    experimentalDecorators: true,
+                    useDefineForClassFields: false
+                }
+                : {}, preset === 'react'
+                ? {
+                    jsx: 'react-jsx'
+                }
+                : {}, preset === 'preact'
+                ? {
+                    jsx: 'react-jsx',
+                    jsxImportSource: 'preact'
+                }
+                : {}, preset === 'solid'
+                ? {
+                    jsx: 'preserve',
+                    jsxImportSource: 'solid-js'
+                }
+                : {}, preset === 'stencil'
+                ? {
+                    experimentalDecorators: true,
+                    jsx: 'react',
+                    jsxFactory: 'h',
+                    jsxFragmentFactory: 'Fragment'
+                }
+                : {})
+        },
+        include: preset === 'svelte'
+            ? ['src/**/*.d.ts', 'src/**/*.ts', 'src/**/*.js', 'src/**/*.svelte']
+            : preset === 'vue'
+                ? ['src/**/*.ts', 'src/**/*.d.ts', 'src/**/*.tsx', 'src/**/*.vue']
+                : ['test', 'wdio.conf.ts']
+    };
+    await fs.mkdir(path.dirname(parsedAnswers.tsConfigFilePath), { recursive: true });
+    await fs.writeFile(parsedAnswers.tsConfigFilePath, JSON.stringify(config, null, 4));
     console.log(chalk.green.bold('✔ Success!\n'));
 }
 function getPreset(parsedAnswers) {
@@ -755,7 +828,10 @@ export async function createWDIOConfig(parsedAnswers) {
     try {
         console.log('Creating a WebdriverIO config file...');
         const tplPath = path.resolve(__dirname, 'templates', 'wdio.conf.tpl.ejs');
-        const renderedTpl = await renderFile(tplPath, { answers: parsedAnswers });
+        const renderedTpl = await renderFile(tplPath, {
+            answers: parsedAnswers,
+            _: new EjsHelpers({ useEsm: parsedAnswers.esmSupport, useTypeScript: parsedAnswers.isUsingTypeScript })
+        });
         await fs.writeFile(parsedAnswers.wdioConfigPath, renderedTpl);
         console.log(chalk.green.bold('✔ Success!\n'));
         if (parsedAnswers.generateTestFiles) {
@@ -770,20 +846,33 @@ export async function createWDIOConfig(parsedAnswers) {
 }
 export async function createWDIOScript(parsedAnswers) {
     const projectProps = await getProjectProps(process.cwd());
-    const script = `wdio run ./${path.join('.', parsedAnswers.wdioConfigPath.replace(projectProps?.path || process.cwd(), ''))}`;
-    const args = ['pkg', 'set', `scripts.wdio=${script}`];
-    try {
-        console.log(`Adding ${chalk.bold('"wdio"')} script to package.json.`);
-        await runProgram(NPM_COMMAND, args, { cwd: parsedAnswers.projectRootDir });
-        console.log(chalk.green.bold('✔ Success!'));
-        return true;
-    }
-    catch (err) {
-        const [preArgs, scriptPath] = args.join(' ').split('=');
-        console.error(`⚠️  Couldn't add script to package.json: "${err.message}", you can add it manually ` +
-            `by running:\n\n\t${NPM_COMMAND} ${preArgs}="${scriptPath}"`);
-        return false;
+    const pathToWdioConfig = `./${path.join('.', parsedAnswers.wdioConfigPath.replace(projectProps?.path || process.cwd(), ''))}`;
+    const wdioScripts = {
+        'wdio': `wdio run ${pathToWdioConfig}`,
+    };
+    const serenityScripts = {
+        'serenity': 'failsafe serenity:update serenity:clean wdio serenity:report',
+        'serenity:update': 'serenity-bdd update',
+        'serenity:clean': 'rimraf target',
+        'wdio': `wdio run ${pathToWdioConfig}`,
+        'serenity:report': 'serenity-bdd run',
+    };
+    const scripts = parsedAnswers.serenityAdapter ? serenityScripts : wdioScripts;
+    for (const [script, command] of Object.entries(scripts)) {
+        const args = ['pkg', 'set', `scripts.${script}=${command}`];
+        try {
+            console.log(`Adding ${chalk.bold(`"${script}"`)} script to package.json`);
+            await runProgram(NPM_COMMAND, args, { cwd: parsedAnswers.projectRootDir });
+        }
+        catch (err) {
+            const [preArgs, scriptPath] = args.join(' ').split('=');
+            console.error(`⚠️  Couldn't add script to package.json: "${err.message}", you can add it manually ` +
+                `by running:\n\n\t${NPM_COMMAND} ${preArgs}="${scriptPath}"`);
+            return false;
+        }
     }
+    console.log(chalk.green.bold('✔ Success!'));
+    return true;
 }
 export async function runAppiumInstaller(parsedAnswers) {
     if (parsedAnswers.e2eEnvironment !== 'mobile') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/cli",
-  "version": "8.17.0",
+  "version": "8.18.2",
   "description": "WebdriverIO testrunner command line interface",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cli",
@@ -46,12 +46,12 @@
   "typeScriptVersion": "3.8.3",
   "dependencies": {
     "@types/node": "^20.1.1",
-    "@wdio/config": "8.17.0",
-    "@wdio/globals": "8.17.0",
+    "@wdio/config": "8.18.2",
+    "@wdio/globals": "8.18.2",
     "@wdio/logger": "8.16.17",
-    "@wdio/protocols": "8.16.5",
+    "@wdio/protocols": "8.18.0",
     "@wdio/types": "8.17.0",
-    "@wdio/utils": "8.17.0",
+    "@wdio/utils": "8.18.2",
     "async-exit-hook": "^2.0.1",
     "chalk": "^5.2.0",
     "chokidar": "^3.5.3",
@@ -66,7 +66,7 @@
     "lodash.union": "^4.6.0",
     "read-pkg-up": "10.1.0",
     "recursive-readdir": "^2.2.3",
-    "webdriverio": "8.17.0",
+    "webdriverio": "8.18.2",
     "yargs": "^17.7.2",
     "yarn-install": "^1.0.0"
   },
@@ -83,5 +83,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f7fe9474c580fc2003f6abca130e44ed025b1bd5"
+  "gitHead": "910c79f1640f0100e763a507fdcaee9e4f52560f"
 }