create-wdio 9.0.0 → 9.17.0

package/README.md

@@ -1,4 +1,4 @@
-WebdriverIO Starter Toolkit [![Test Changes](https://github.com/webdriverio/create-wdio/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/webdriverio/create-wdio/actions/workflows/test.yml) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/webdriverio/create-wdio/blob/main/CONTRIBUTING.md)
+WebdriverIO Starter Toolkit [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/webdriverio/webdriverio/blob/main/CONTRIBUTING.md)
 ===========================
 
 <img alt="Logo" align="right" src="https://webdriver.io/assets/images/robot-3677788dd63849c56aa5cb3f332b12d5.svg" width="20%" />
@@ -9,11 +9,11 @@ One command to create a fresh WebdriverIO project or add WebdriverIO to an exist
 - [Supported Options](#supported-options) - command line parameters
 
 `create-wdio` works on macOS, Windows, and Linux.<br>
-If something doesn’t work, please [file an issue](https://github.com/webdriverio/create-wdio/issues/new).<br>
-If you have questions or need help, please ask in our [Gitter Support Chat](https://gitter.im/webdriverio/webdriverio).
+If something doesn’t work, please [file an issue](https://github.com/webdriverio/webdriverio/issues/new).<br>
+If you have questions or need help, please ask in our [Discord Support channel](https://discord.webdriver.io).
 
 <p align="center">
-    <img src="https://raw.githubusercontent.com/webdriverio/wdio/main/.github/assets/demo.gif" alt="Example" />
+    <img src="https://raw.githubusercontent.com/webdriverio/webdriverio/main/packages/create-wdio/assets/demo.gif" alt="Example" />
 </p>
 
 ## Usage
@@ -34,7 +34,7 @@ _[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f
 npm init wdio@latest ./e2e
 ```
 
-_[`npm init <initializer>`](https://docs.npmjs.com/cli/v7/commands/npm-init) is available in npm 6+_
+_[`npm init <initializer>`](https://docs.npmjs.com/cli/v10/commands/npm-init) is available in npm 6+_
 
 #### yarn
 
@@ -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/cli/config.d.ts

@@ -0,0 +1,51 @@
+import type { Argv } from 'yargs';
+import { runConfigCommand } from './utils.js';
+import type { ConfigCommandArguments } from '../types.js';
+export declare const command = "config";
+export declare const desc = "Initialize WebdriverIO and setup configuration in your current project.";
+export declare const cmdArgs: {
+    readonly yarn: {
+        readonly type: "boolean";
+        readonly desc: "Install packages via Yarn package manager.";
+        readonly default: boolean;
+    };
+    readonly yes: {
+        readonly alias: "y";
+        readonly desc: "will fill in all config defaults without prompting";
+        readonly type: "boolean";
+        readonly default: false;
+    };
+    readonly npmTag: {
+        readonly alias: "t";
+        readonly desc: "define NPM tag to use for WebdriverIO related packages";
+        readonly type: "string";
+        readonly default: "latest";
+    };
+};
+export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, "yarn" | "yes" | "npmTag"> & import("yargs").InferredOptionTypes<{
+    readonly yarn: {
+        readonly type: "boolean";
+        readonly desc: "Install packages via Yarn package manager.";
+        readonly default: boolean;
+    };
+    readonly yes: {
+        readonly alias: "y";
+        readonly desc: "will fill in all config defaults without prompting";
+        readonly type: "boolean";
+        readonly default: false;
+    };
+    readonly npmTag: {
+        readonly alias: "t";
+        readonly desc: "define NPM tag to use for WebdriverIO related packages";
+        readonly type: "string";
+        readonly default: "latest";
+    };
+}>>;
+export declare function handler(argv: ConfigCommandArguments, runConfigCmd?: typeof runConfigCommand): Promise<{
+    success: boolean;
+    parsedAnswers: import("../types.js").ParsedAnswers;
+    installedPackages: string[];
+}>;
+export { missingConfigurationPrompt, canAccessConfigPath } from './utils.js';
+export { formatConfigFilePaths } from '../utils.js';
+//# sourceMappingURL=config.d.ts.map

package/build/cli/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/cli/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAIjC,OAAO,EAEH,gBAAgB,EACnB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAUzD,eAAO,MAAM,OAAO,WAAW,CAAA;AAC/B,eAAO,MAAM,IAAI,4EAA4E,CAAA;AAE7F,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;CAkBV,CAAA;AAEV,eAAO,MAAM,OAAO,GAAI,OAAO,IAAI;;;;;;;;;;;;;;;;;;GAKlC,CAAA;AAED,wBAAsB,OAAO,CAAC,IAAI,EAAE,sBAAsB,EAAE,YAAY,0BAAmB;;;;GAQ1F;AAED,OAAO,EAAE,0BAA0B,EAAE,mBAAmB,EAAG,MAAM,YAAY,CAAA;AAC7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA"}

package/build/cli/install.d.ts

@@ -0,0 +1,12 @@
+import type { Argv } from 'yargs';
+import type { InstallCommandArguments } from '../types.js';
+export declare const command = "install <type> <name>";
+export declare const desc: string;
+export declare const cmdArgs: {
+    readonly config: {
+        readonly desc: "Location of your WDIO configuration (default: wdio.conf.(js|ts|cjs|mjs))";
+    };
+};
+export declare const builder: (yargs: Argv) => Argv<{}>;
+export declare function handler(argv: InstallCommandArguments): Promise<void>;
+//# sourceMappingURL=install.d.ts.map

package/build/cli/install.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../../src/cli/install.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAcjC,OAAO,KAAK,EAAE,uBAAuB,EAAoB,MAAM,aAAa,CAAA;AAW5E,eAAO,MAAM,OAAO,0BAA0B,CAAA;AAC9C,eAAO,MAAM,IAAI,QAIN,CAAA;AAEX,eAAO,MAAM,OAAO;;;;CAIV,CAAA;AAEV,eAAO,MAAM,OAAO,GAAI,OAAO,IAAI,aAalC,CAAA;AAED,wBAAsB,OAAO,CAAC,IAAI,EAAE,uBAAuB,iBAiF1D"}

package/build/cli/utils.d.ts

@@ -0,0 +1,18 @@
+import type { ParsedAnswers } from '../types.js';
+export declare function runConfigCommand(parsedAnswers: ParsedAnswers, npmTag: string): Promise<void>;
+/**
+ * Helper utility used in `run` and `install` command to create config if none exist
+ * @param {string} command to be executed by user
+ * @param {string} configPath the path to a wdio.conf.[js/ts] file
+ * @param {Function} runConfigCmd runConfig method to be replaceable for unit testing
+ */
+export declare function missingConfigurationPrompt(command: string, configPath: string, runConfigCmd?: Function): Promise<string>;
+export declare const parseAnswers: (yes: boolean) => Promise<ParsedAnswers>;
+/**
+ * Helper utility used in `run` and `install` command to check whether a config file currently exists
+ * @param configPathNoExtension the file path to the WDIO config file without extension
+ * @param configPath the file path to the WDIO config file that is checked first if set
+ * @returns {string} the path to the config file that exists, otherwise undefined
+ */
+export declare function canAccessConfigPath(configPathNoExtension: string, configPath?: string): Promise<string | undefined>;
+//# sourceMappingURL=utils.d.ts.map

package/build/cli/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/cli/utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAGhD,wBAAsB,gBAAgB,CAAC,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,iBAqBlF;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,GAAE,QAA2B,mBA+B9H;AAED,eAAO,MAAM,YAAY,GAAmB,KAAK,OAAO,KAAG,OAAO,CAAC,aAAa,CAyF/E,CAAA;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,qBAAqB,EAAC,MAAM,EAAE,UAAU,CAAC,EAAC,MAAM,GAAG,OAAO,CAAC,MAAM,GAAC,SAAS,CAAC,CAcrH"}

package/build/config/cli.d.ts

@@ -0,0 +1,2 @@
+export * as config from '../cli/config.js';
+//# sourceMappingURL=cli.d.ts.map

package/build/config/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/config/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAA"}