create-wdio 9.0.0 → 9.17.0

package/build/utils.d.ts

@@ -0,0 +1,78 @@
+import type { SpawnOptions } from 'node:child_process';
+import type { ParsedAnswers, ProjectProps, Questionnair, SupportedPackage } from './types.js';
+export declare function runProgram(command: string, args: string[], options: SpawnOptions): Promise<void>;
+export declare function getPackageVersion(): Promise<string>;
+export declare function convertPackageHashToObject(pkg: string, hash?: string): SupportedPackage;
+export declare function getAnswers(yes: boolean): Promise<Questionnair>;
+/**
+ * Receive project properties
+ * @returns {@type ProjectProps} if a package.json can be found in cwd or parent directories, otherwise undefined
+ *                               which means that a new project can be created
+ */
+export declare function getProjectProps(cwd?: string): Promise<ProjectProps | undefined>;
+export declare function getPathForFileGeneration(answers: Questionnair, projectRootDir: string): {
+    destSpecRootPath: string;
+    destStepRootPath: string;
+    destPageObjectRootPath: string;
+    destSerenityLibRootPath: string;
+    relativePath: string;
+};
+/**
+ * Get project root directory based on questionaire answers
+ * @param answers questionaire answers
+ * @param projectProps project properties received via `getProjectProps`
+ * @returns project root path
+ */
+export declare function getProjectRoot(parsedAnswers?: Questionnair): Promise<string>;
+/**
+ * create package.json if not already existing
+ */
+export declare function createPackageJSON(parsedAnswers: ParsedAnswers): Promise<false | undefined>;
+/**
+ * set up TypeScript if it is desired but not installed
+ */
+export declare function setupTypeScript(parsedAnswers: ParsedAnswers): Promise<void>;
+export declare function npmInstall(parsedAnswers: ParsedAnswers, npmTag: string): Promise<void>;
+export declare function addServiceDeps(names: SupportedPackage[], packages: string[], update?: boolean): void;
+export declare function createWDIOConfig(parsedAnswers: ParsedAnswers): Promise<void>;
+export declare const renderFile: (path: string, data: Record<string, unknown>) => Promise<string>;
+export declare function createWDIOScript(parsedAnswers: ParsedAnswers): Promise<boolean>;
+export declare function runAppiumInstaller(parsedAnswers: ParsedAnswers): Promise<void | import("execa").Result<{
+    stdio: "inherit";
+}>>;
+export declare function getSerenityPackages(answers: Questionnair): string[];
+/**
+ * detect the package manager that was used
+ * uses the environment variable `npm_config_user_agent` to detect the package manager
+ * falls back to `npm` if no package manager could be detected
+ */
+export declare function detectPackageManager(): import("./constants.js").PACKAGE_MANAGER;
+export declare function getDefaultFiles(answers: Questionnair, pattern: string): Promise<string>;
+/**
+ * detect if project has a compiler file
+ */
+export declare function detectCompiler(answers: Questionnair): Promise<boolean>;
+/**
+ * Ensure core WebdriverIO packages have the same version as cli so that if someone
+ * installs `@wdio/cli@next` and runs the wizard, all related packages have the same version.
+ * running `matchAll` to a version like "8.0.0-alpha.249+4bc237701", results in:
+ * ['8.0.0-alpha.249+4bc237701', '8', '0', '0', 'alpha', '249', '4bc237701']
+ */
+export declare function specifyVersionIfNeeded(packagesToInstall: string[], version: string, npmTag: string): string[];
+/**
+ * generate test files based on CLI answers
+ */
+export declare function generateTestFiles(answers: ParsedAnswers): Promise<void>;
+export declare function generateBrowserRunnerTestFiles(answers: ParsedAnswers): Promise<void>;
+/**
+ * Helper utility used in `run` and `install` command to format a provided config path,
+ * giving it back as an absolute path, and a version without the file extension
+ * @param config the initially given file path to the WDIO config file
+ */
+export declare function formatConfigFilePaths(config: string): Promise<{
+    fullPath: string;
+    fullPathNoExtension: string;
+}>;
+export declare function findInConfig(config: string, type: string): RegExpMatchArray | null;
+export declare function replaceConfig(config: string, type: string, name: string): string | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAKtD,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAY7F,wBAAgB,UAAU,CAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,YAAY,iBAcjF;AAED,wBAAsB,iBAAiB,oBAStC;AAYD,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,SAAS,GAAG,gBAAgB,CAGvF;AAED,wBAAsB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAmFpE;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,GAAG,SAAgB,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAkB5F;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM;;;;;;EA0BrF;AAaD;;;;;GAKG;AACH,wBAAsB,cAAc,CAAE,aAAa,CAAC,EAAE,YAAY,mBAajE;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,aAAa,EAAE,aAAa,8BAgCnE;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,aAAa,EAAE,aAAa,iBAmHjE;AAMD,wBAAsB,UAAU,CAAC,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,iBA+F5E;AAMD,wBAAgB,cAAc,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,MAAM,UAAQ,QAmB3F;AAED,wBAAsB,gBAAgB,CAAC,aAAa,EAAE,aAAa,iBAmBlE;AAED,eAAO,MAAM,UAAU,EAAgC,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAGvH,wBAAsB,gBAAgB,CAAC,aAAa,EAAE,aAAa,oBAmClE;AAGD,wBAAsB,kBAAkB,CAAC,aAAa,EAAE,aAAa;;IAoBpE;AACD,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,EAAE,CA0CnE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,6CASnC;AAED,wBAAsB,eAAe,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,mBAU3E;AAID;;GAEG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,YAAY,oBASzD;AAGD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,YAelG;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,aAAa,iBAU7D;AA8DD,wBAAsB,8BAA8B,CAAC,OAAO,EAAE,aAAa,iBAiC1E;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,MAAM;;;GAMzD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,2BASxD;AAoBD,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,sBAYvE"}

package/package.json

@@ -1,16 +1,42 @@
 {
   "name": "create-wdio",
-  "version": "9.0.0",
+  "version": "9.17.0",
   "description": "Install and setup a WebdriverIO project with all its dependencies in a single run",
-  "author": "Christian Bromann <mail@bromann.dev>",
+  "author": "WebdriverIO Team <mail@webdriver.io>",
+  "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/create-wdio",
   "license": "MIT",
-  "homepage": "https://github.com/webdriverio/create-wdio#readme",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "import": "./build/index.js",
+      "importSource": "./src/index.ts"
+    },
+    "./config/cli": {
+      "types": "./build/config/cli.d.ts",
+      "import": "./build/config/cli.js",
+      "importSource": "./src/config/cli.ts"
+    },
+    "./install/cli": {
+      "types": "./build/install/cli.d.ts",
+      "import": "./build/install/cli.js",
+      "importSource": "./src/install/cli.ts"
+    },
+    "./utils": {
+      "types": "./build/utils/index.d.ts",
+      "import": "./build/utils/index.js",
+      "importSource": "./src/utils/index.ts"
+    }
+  },
+  "types": "./build/index.d.ts",
+  "typeScriptVersion": "3.8.3",
+  "engines": {
+    "node": ">=12.0.0"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/webdriverio/create-wdio.git"
-  },
-  "bugs": {
-    "url": "https://github.com/webdriverio/create-wdio/issues"
+    "url": "git+https://github.com/webdriverio/webdriverio.git",
+    "directory": "packages/create-wdio"
   },
   "keywords": [
     "webdriverio",
@@ -19,44 +45,37 @@
     "installer",
     "e2e"
   ],
+  "bugs": {
+    "url": "https://github.com/webdriverio/webdriverio/issues"
+  },
   "bin": {
     "create-wdio": "./bin/wdio.js"
   },
-  "type": "module",
-  "scripts": {
-    "build": "run-s clean compile",
-    "clean": "rimraf tsconfig.tsbuildinfo ./build ./coverage",
-    "compile": "tsc -p ./tsconfig.json",
-    "release": "release-it --github.release",
-    "release:ci": "npm run release -- --ci --npm.skipChecks --no-git.requireCleanWorkingDir",
-    "release:patch": "npm run release -- patch",
-    "release:minor": "npm run release -- minor",
-    "release:major": "npm run release -- major",
-    "test": "run-s build test:*",
-    "test:eslint": "eslint -c ./.eslintrc.cjs ./src/**/*.ts ./tests/**/*.ts",
-    "test:unit": "vitest",
-    "watch": "npm run compile -- --watch"
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^14.0.0",
+    "cross-spawn": "^7.0.3",
+    "ejs": "^3.1.10",
+    "execa": "^9.6.0",
+    "import-meta-resolve": "^4.1.0",
+    "inquirer": "^12.7.0",
+    "normalize-package-data": "^7.0.0",
+    "read-pkg-up": "^10.1.0",
+    "recursive-readdir": "^2.2.3",
+    "semver": "^7.6.3",
+    "type-fest": "^4.41.0",
+    "yargs": "^17.7.2"
   },
   "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.25.0",
-    "c8": "^7.12.0",
-    "eslint": "^8.24.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-unicorn": "^45.0.0",
-    "npm-run-all": "^4.1.5",
-    "release-it": "^15.4.2",
-    "typescript": "^4.8.4",
-    "vitest": "^0.25.0"
+    "@types/cross-spawn": "^6.0.6",
+    "@types/ejs": "^3.1.5",
+    "@types/fs-extra": "^11.0.4",
+    "@types/normalize-package-data": "^2.4.4",
+    "@types/semver": "^7.5.8",
+    "@types/yargs": "^17.0.33"
   },
-  "dependencies": {
-    "chalk": "^5.0.1",
-    "commander": "^9.4.0",
-    "cross-spawn": "^7.0.3",
-    "semver": "^7.3.7"
-  }
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "796df04f0f5c744d5ef4bafd3759995fa4829d6f"
 }

package/.eslintrc.cjs

@@ -1,37 +0,0 @@
-module.exports = {
-    root: true,
-    parser: '@typescript-eslint/parser',
-    plugins: ['@typescript-eslint', 'unicorn'],
-    extends: [
-        'eslint:recommended',
-        'plugin:import/errors',
-        'plugin:import/warnings'
-    ],
-    env: {
-        node: true,
-        es6: true,
-        jest: true
-    },
-    parserOptions: {
-        ecmaVersion: 2019,
-        sourceType: 'module'
-    },
-    rules: {
-        semi: ['error', 'never'],
-        quotes: ['error', 'single'],
-        indent: [2, 4],
-
-        'no-constant-condition': 0,
-        // see https://stackoverflow.com/questions/55280555/typescript-eslint-eslint-plugin-error-route-is-defined-but-never-used-no-un
-        'no-unused-vars': 'off',
-        '@typescript-eslint/no-unused-vars': 'error',
-
-        'import/no-unresolved': 0,
-        'import/named': 2,
-        'import/namespace': 2,
-        'import/default': 2,
-        'import/export': 2,
-
-        'unicorn/prefer-node-protocol': ['error']
-    }
-}

package/__mocks__/commander.ts

@@ -1,18 +0,0 @@
-import { vi } from 'vitest'
-
-const command: any = {}
-command.name = vi.fn().mockReturnValue(command)
-command.version = vi.fn().mockReturnValue(command)
-command.usage = vi.fn().mockReturnValue(command)
-command.arguments = vi.fn().mockReturnValue(command)
-command.action = vi.fn((cb) => {
-    cb('someProjectName')
-    return command
-})
-command.option = vi.fn().mockReturnValue(command)
-command.allowUnknownOption = vi.fn().mockReturnValue(command)
-command.on = vi.fn().mockReturnValue(command)
-command.parse = vi.fn().mockReturnValue(command)
-command.opts = vi.fn().mockReturnValue('foobar')
-
-export const Command = vi.fn().mockReturnValue(command)

package/build/constants.js

@@ -1,51 +0,0 @@
-import { colorItBold, colorIt } from './utils.js';
-export const DEFAULT_NPM_TAG = 'latest';
-export const ASCII_ROBOT = `
-                 -:...........................-:.
-                 +                              +
-              \`\` +      \`...\`        \`...\`      + \`
-            ./+/ +    .:://:::\`    \`::///::\`  \` + ++/.
-           .+oo+ +    /:+ooo+-/    /-+ooo+-/ ./ + +oo+.
-           -ooo+ +    /-+ooo+-/    /-+ooo+-/ .: + +ooo.
-            -+o+ +    \`::///:-\`    \`::///::\`    + +o+-
-             \`\`. /.     \`\`\`\`\`        \`\`\`\`\`     .: .\`\`
-                  .----------------------------.
-           \`-::::::::::::::::::::::::::::::::::::::::-\`
-          .+oooo/:------------------------------:/oooo+.
-      \`.--/oooo-                                  :oooo/--.\`
-    .::-\`\`:oooo\`                                  .oooo-\`\`-::.
-  ./-\`    -oooo\`--.: :.--                         .oooo-    \`-/.
- -/\`    \`-/oooo////////////////////////////////////oooo/.\`    \`/-
-\`+\`   \`/+oooooooooooooooooooooooooooooooooooooooooooooooo+:\`   .+\`
--/    +o/.:oooooooooooooooooooooooooooooooooooooooooooo:-/o/    +.
--/   .o+  -oooosoooososssssooooo------------------:oooo- \`oo\`   +.
--/   .o+  -oooodooohyyssosshoooo\`                 .oooo-  oo.   +.
--/   .o+  -oooodooysdooooooyyooo\` \`.--.\`\`     .:::-oooo-  oo.   +.
--/   .o+  -oooodoyyodsoooooyyooo.//-..-:/:.\`.//.\`./oooo-  oo.   +.
--/   .o+  -oooohsyoooyysssysoooo+-\`     \`-:::.    .oooo-  oo.   +.
--/   .o+  -ooooosooooooosooooooo+//////////////////oooo-  oo.   +.
--/   .o+  -oooooooooooooooooooooooooooooooooooooooooooo-  oo.   +.
--/   .o+  -oooooooooooooooooooooooooooooooooooooooooooo-  oo.   +.
--+////o+\` -oooo---:///:----://::------------------:oooo- \`oo////+-
-+ooooooo/\`-oooo\`\`:-\`\`\`.:\`.:.\`.+/-    .::::::::::\` .oooo-\`+ooooooo+
-oooooooo+\`-oooo\`-- \`/\` .:+  -/-\`/\`   .::::::::::  .oooo-.+oooooooo
-+-/+://-/ -oooo-\`:\`.o-\`:.:-\`\`\`\`.:    .///:\`\`\`\`\`\`  -oooo-\`/-//:+:-+
-: :..--:-:.+ooo+/://o+/-.-:////:-....-::::-....--/+ooo+.:.:--.-- /
-- /./\`-:-\` .:///+/ooooo/+///////////////+++ooooo/+///:. .-:.\`+./ :
-:-:/.           :\`ooooo\`/\`              .:.ooooo :           ./---
-                :\`ooooo\`/\`              .:.ooooo :
-                :\`ooooo./\`              .:-ooooo :
-                :\`ooooo./\`              .:-ooooo :
-            \`...:-+++++:/.              ./:+++++-:...\`
-           :-.\`\`\`\`\`\`\`\`/../              /.-:\`\`\`\`\`\`\`\`.:-
-          -/::::::::://:/+             \`+/:+::::::::::+.
-          :oooooooooooo++/              +++oooooooooooo-
-`;
-export const PROGRAM_TITLE = `
-                           ${colorItBold('Webdriver.IO')}
-              ${colorIt('Next-gen browser and mobile automation')}
-                    ${colorIt('test framework for Node.js')}
-`;
-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/types.js

@@ -1 +0,0 @@
-export {};

package/build/utils.js

@@ -1,38 +0,0 @@
-import url from 'node:url';
-import path from 'node:path';
-import fs from 'node:fs/promises';
-import spawn from 'cross-spawn';
-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 runProgram(command, args, options) {
-    const child = spawn(command, args, { stdio: 'inherit', ...options });
-    return new Promise((resolve, reject) => {
-        let error;
-        child.on('error', (e) => (error = e));
-        child.on('close', code => {
-            if (code !== 0) {
-                return reject(new Error((error && error.message) ||
-                    `Error calling: ${command} ${args.join(' ')}`));
-            }
-            resolve();
-        });
-    });
-}
-/* c8 ignore start */
-export function shouldUseYarn() {
-    return runProgram('yarnpkg', ['--version'], { stdio: 'ignore' }).then(() => true, () => false);
-}
-/* c8 ignore end */
-export async function getPackageVersion() {
-    try {
-        const pkgJsonPath = path.join(__dirname, '..', 'package.json');
-        const pkg = JSON.parse((await fs.readFile(pkgJsonPath)).toString());
-        return `v${pkg.version}`;
-    }
-    catch (e) {
-        /* ignore */
-    }
-    return 'unknown';
-}

package/vitest.config.ts

@@ -1,23 +0,0 @@
-/// <reference types="vitest" />
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-    test: {
-        include: ['tests/**/*.test.ts'],
-        /**
-         * not to ESM ported packages
-         */
-        exclude: [
-            'build', '.idea', '.git', '.cache',
-            '**/node_modules/**', '__mocks__'
-        ],
-        coverage: {
-            enabled: true,
-            exclude: ['**/build/**', '__mocks__', '**/*.test.ts'],
-            lines: 100,
-            functions: 82,
-            branches: 85,
-            statements: 100
-        }
-    }
-})