chore!: update dependencies

Author: KuznetsovRoman

package-lock.json

@@ -41,8 +41,8 @@
     "devDependencies": {
         "@commitlint/cli": "^16.3.0",
         "@commitlint/config-conventional": "^16.2.4",
+        "@inquirer/type": "^3.0.8",
         "@tsconfig/recommended": "^1.0.1",
-        "@types/inquirer": "^9.0.1",
         "@types/jest": "^29.5.11",
         "@types/jest-when": "^3.5.5",
         "@types/lodash": "^4.14.185",
@@ -60,15 +60,16 @@
         "prettier": "^2.7.1",
         "testplane": "^0.1.0-rc.0",
         "ts-jest": "^29.1.1",
-        "typescript": "^4.4.4"
+        "typescript": "^5.9.2"
     },
     "dependencies": {
-        "inquirer": "^8.2.4",
+        "@inquirer/prompts": "^7.8.6",
+        "load-esm": "^1.0.3",
         "lodash": "^4.17.21",
-        "ora": "^4.1.1",
-        "yargs": "^17.5.1"
+        "ora": "^8.2.0",
+        "yargs": "^17.7.2"
     },
     "engines": {
-        "node": ">=12.0.0"
+        "node": ">=18.19.0"
     }
 }

package.json

@@ -1,30 +1,39 @@
 #!/usr/bin/env node
 
-import yargs from "yargs";
-import { hideBin } from "yargs/helpers";
+import { loadEsm } from "load-esm";
 
 import launcher from "../index";
 import { optsFromArgv } from "../utils";
 import { ToolArgv } from "../types/toolArgv";
 import { DefaultOpts, ToolOpts } from "../types/toolOpts";
 
-const argv = yargs(hideBin(process.argv))
-    .usage("Usage: $0 <path>")
-    .option("lang", {
-        alias: "l",
-        type: "string",
-        default: "ts",
-        description: "Language, which will be used to write Testplane tests",
-        choices: ["ts", "js"],
-    })
-    .option("verbose", {
-        alias: "v",
-        type: "boolean",
-        default: false,
-        description: "Advanced configuration with extra questions",
-    })
-    .parse();
+async function main(): Promise<void> {
+    const [{ default: yargs }, { hideBin }] = await Promise.all([
+        loadEsm<typeof import("yargs")>("yargs"),
+        loadEsm<typeof import("yargs/helpers")>("yargs/helpers"),
+    ]);
 
-const argvOpts = optsFromArgv(argv as ToolArgv);
-const createOpts = (defaultOpts: DefaultOpts): ToolOpts => ({ ...defaultOpts, ...argvOpts });
-launcher.run({ createOpts });
+    const argv = yargs(hideBin(process.argv))
+        .usage("Usage: $0 <path>")
+        .option("lang", {
+            alias: "l",
+            type: "string",
+            default: "ts",
+            description: "Language, which will be used to write Testplane tests",
+            choices: ["ts", "js"],
+        })
+        .option("verbose", {
+            alias: "v",
+            type: "boolean",
+            default: false,
+            description: "Advanced configuration with extra questions",
+        })
+        .parse();
+
+    const argvOpts = optsFromArgv(argv as ToolArgv);
+    const createOpts = (defaultOpts: DefaultOpts): ToolOpts => ({ ...defaultOpts, ...argvOpts });
+
+    await launcher.run({ createOpts });
+}
+
+main();

src/bin/create-testplane.ts

@@ -1,13 +1,13 @@
 import _ from "lodash";
 import { when } from "jest-when";
-import inquirer from "inquirer";
+import { inquirerPrompt } from "./utils/inquirer";
 import defaultTestplaneConfig from "./constants/defaultTestplaneConfig";
 import { ConfigBuilder } from "./configBuilder";
 import fsUtils from "./fsUtils";
 import defaultPluginsConfig from "./pluginsConfig";
 import type { Answers, GeneralPrompt, TestplaneConfig } from "./types";
 
-jest.mock("inquirer");
+jest.mock("./utils/inquirer");
 
 jest.mock("./fsUtils");
 
@@ -73,7 +73,8 @@ describe("configBuilder", () => {
                 { path: "/", extraQuestions: false },
             );
 
-            expect(inquirer.prompt).toBeCalledWith([{ message: "loud question", type: "input", name: "2" }]);
+            expect(inquirerPrompt).toBeCalledWith({ message: "loud question", type: "input", name: "2" });
+            expect(inquirerPrompt).toBeCalledTimes(1);
         });
 
         it("should mutate config with handlers", () => {
@@ -89,7 +90,9 @@ describe("configBuilder", () => {
             when(firstHandler).calledWith(defaultTestplaneConfig, answers).mockResolvedValue(firstHandlerResult);
             when(secondHandler).calledWith(firstHandlerResult, answers).mockResolvedValue(secondHandlerResult);
 
-            when(inquirer.prompt).calledWith(questions).mockResolvedValue(answers);
+            jest.mocked(inquirerPrompt).mockImplementation((prompt: unknown) => {
+                return Promise.resolve(answers[(prompt as { name: string }).name as keyof typeof answers]);
+            });
 
             configBuilder.handleGeneralQuestions(questions, [firstHandler, secondHandler], {
                 path: "/",

src/configBuilder.test.ts

@@ -1,14 +1,14 @@
 import _ from "lodash";
-import inquirer from "inquirer";
 import { writeTestplaneConfig } from "./fsUtils";
 import defaultPluginsConfig from "./pluginsConfig";
 import defaultToolOpts from "./constants/defaultToolOpts";
 import defaultTestplaneConfig from "./constants/defaultTestplaneConfig";
+import { getTemplate } from "./utils/configTemplates";
+import { inquirerPrompt } from "./utils";
 import type { TestplaneConfig, Language } from "./types/testplaneConfig";
 import type { Answers, HandleGeneralPromptsCallback } from "./types/toolOpts";
 import type { CreateBaseConfigCallback, CreatePluginsConfigCallback } from ".";
 import type { GeneralPrompt } from "./types/toolOpts";
-import { getTemplate } from "./utils/configTemplates";
 
 type ConfigurePluginsOpts = {
     pluginNames: string[];
@@ -52,10 +52,17 @@ export class ConfigBuilder {
             }
 
             return acc;
-        }, {});
+        }, {} as Answers);
 
         const promptsToAsk = extraQuestions ? promts : promts.filter(prompt => _.isUndefined(prompt.default));
-        const inquirerAnswers = await inquirer.prompt(promptsToAsk);
+
+        const inquirerAnswers = {} as Answers;
+
+        for (const prompt of promptsToAsk) {
+            const result = await inquirerPrompt(prompt);
+
+            inquirerAnswers[prompt.name] = result;
+        }
 
         Object.assign(answers, defaults, inquirerAnswers, answers);
 

src/configBuilder.ts

@@ -120,7 +120,7 @@ export const writeTest = async (dirPath: string, testName: string, testContent:
 export const writeJson = async (filePath: string, obj: Record<string, unknown>): Promise<void> => {
     await ensureDirectory(path.dirname(filePath));
 
-    return fs.promises.writeFile(filePath, JSON.stringify(obj, null, 4));
+    return fs.promises.writeFile(filePath, JSON.stringify(obj, null, 4) + "\n");
 };
 
 export const readJson = async (filePath: string): Promise<Record<string, unknown>> => {

src/fsUtils.ts

@@ -1,9 +1,9 @@
 import defaultToolOpts from "./constants/defaultToolOpts";
 import { initApp, installPackages } from "./package";
 import {
-    askQuestion,
     baseGeneralPromptsHandler,
     extendWithTypescript,
+    inquirerPrompt,
     printSuccessMessage,
     writeTestExample,
 } from "./utils";
@@ -43,7 +43,7 @@ process.on("unhandledRejection", (reason, p) => {
     console.error("Unhandled Rejection:\n  Promise: ", p, "\n  Reason: ", reason);
 });
 
-export { askQuestion, defineVariable, addModule, asExpression } from "./utils";
+export { inquirerPrompt, defineVariable, addModule, asExpression } from "./utils";
 export { baseGeneralPrompts };
 export { defaultTestplaneTestsDir } from "./constants/defaultTestplaneConfig";
 
@@ -87,5 +87,5 @@ export const run = async ({
     printSuccessMessage(configNotes.concat(extraPackages.notes));
 };
 
-export default { run, askQuestion, baseGeneralPrompts };
+export default { run, inquirerPrompt, baseGeneralPrompts };
 export * from "./types";

src/index.ts

@@ -1,11 +1,11 @@
-import ora from "ora";
+import { loadEsm } from "load-esm";
 import path from "path";
 import { exec } from "child_process";
 
 import fsUtils from "./fsUtils";
 import { DEFAULT_PM, CONFIG_NAMES, PMS, PACKAGE_JSON } from "./constants/packageManagement";
 import { Colors } from "./utils/colors";
-import { askQuestion, packageNameFromPlugin } from "./utils";
+import { inquirerPrompt, packageNameFromPlugin } from "./utils";
 import type { PackageManager } from "./constants/packageManagement";
 
 const getPackageManager = async (dirPath: string, extraQuestions: boolean): Promise<PackageManager> => {
@@ -28,8 +28,8 @@ const getPackageManager = async (dirPath: string, extraQuestions: boolean): Prom
         return DEFAULT_PM;
     }
 
-    return askQuestion<PackageManager>({
-        type: "list",
+    return inquirerPrompt({
+        type: "select",
         message: "Choose preferred package manager:",
         choices: Object.keys(PMS),
         default: DEFAULT_PM,
@@ -104,6 +104,7 @@ export const installPackages = async (
     pluginsToInstall: string[],
     registry: string,
 ): Promise<string> => {
+    const { default: ora } = await loadEsm<typeof import("ora")>("ora");
     const spinner = ora("Installing packages (this may take a while)").start();
 
     const pluginsPackages = pluginsToInstall.map(packageNameFromPlugin).join(" ");

src/package.ts

@@ -1,5 +1,5 @@
 import type { ToolOpts } from "./types/toolOpts";
-import { askQuestion, packageNameFromPlugin } from "./utils";
+import { inquirerPrompt, packageNameFromPlugin } from "./utils";
 
 export type ConfigNote = { plugin: string; configNote: string };
 
@@ -17,42 +17,33 @@ const askPluginNames = async (opts: ToolOpts): Promise<{ pluginNames: string[];
     let pluginNames: string[] = [];
     let configNotes: ConfigNote[] = [];
 
-    const getDefaultFeatures = (opts: ToolOpts): number[] => {
-        const inds: number[] = [];
-        opts.pluginGroups.forEach(({ plugins }, ind) => {
-            if (plugins.some(plugin => plugin.default)) {
-                inds.push(ind);
-            }
-        });
-        return inds;
-    };
-
-    const wantedFeatures = await askQuestion<number[]>({
+    const wantedFeatures = await inquirerPrompt<number[]>({
         type: "checkbox",
         message: "Which features do you need?",
-        choices: opts.pluginGroups.map((group, ind) => ({ name: group.description, value: ind })),
-        default: getDefaultFeatures(opts),
+        choices: opts.pluginGroups.map((group, ind) => ({
+            name: group.description,
+            value: ind,
+            checked: group.plugins.some(plugin => plugin.default),
+        })),
     });
 
     for (const ind of wantedFeatures) {
         const { description, plugins } = opts.pluginGroups[ind];
-        const curGroupPlugins = await askQuestion<number[]>({
+        const curGroupPlugins = await inquirerPrompt<number[]>({
             type: "checkbox",
             message: `Plugins: ${description}`,
-            choices: plugins.map(({ plugin, description }, index) => ({
+            choices: plugins.map(({ plugin, description, default: checked }, index) => ({
                 name: `${description} (${packageNameFromPlugin(plugin)})`,
                 value: index,
+                checked,
             })),
-            default: plugins.reduce((def: number[], plugin, index) => {
-                return plugin.default ? def.concat(index) : def;
-            }, []),
         });
 
         const notesIndToAdd = curGroupPlugins.filter(ind => plugins[ind].configNote);
         const pluginNamesToAdd = curGroupPlugins.map(ind => plugins[ind].plugin);
         const notesToAdd: ConfigNote[] = notesIndToAdd.map(ind => ({
             plugin: plugins[ind].plugin,
-            configNote: plugins[ind].configNote!,
+            configNote: plugins[ind].configNote as string,
         }));
 
         pluginNames = pluginNames.concat(pluginNamesToAdd);

src/plugins.ts

@@ -1,8 +1,9 @@
-import inquirer, { DistinctQuestion } from "inquirer";
 import _ from "lodash";
 import { TESTPLANE_SAFARI_COMMANDS } from "../constants/plugins";
 import { defaultTestplaneTestsDir } from "../constants/defaultTestplaneConfig";
 import type { TestplaneConfig } from "../types/testplaneConfig";
+import { inquirerPrompt } from "../utils";
+import type { InquirerPrompts } from "../utils/inquirer";
 
 type SafariCommand =
     | "url"
@@ -25,19 +26,16 @@ export default {
     fn: async (config: TestplaneConfig): Promise<void> => {
         const browserId = "safari";
 
-        type CreateInputPrompt = (name: string, message: string) => DistinctQuestion<Record<string, string>>;
+        type CreateInputPrompt = (message: string) => InquirerPrompts["input"];
 
-        const createInputPrompt: CreateInputPrompt = (name, message) => ({
+        const createInputPrompt: CreateInputPrompt = message => ({
             type: "input",
-            name,
             message: "testplane-safari-commands: " + message,
         });
 
-        const { deviceName, platformVersion, version } = await inquirer.prompt([
-            createInputPrompt("deviceName", "Enter device name (ex: iPhone 11):"),
-            createInputPrompt("platformVersion", "Enter iOS version (ex: 13.3):"),
-            createInputPrompt("version", "Enter safari version (ex: 13.0):"),
-        ]);
+        const deviceName = await inquirerPrompt(createInputPrompt("Enter device name (ex: iPhone 11):"));
+        const platformVersion = await inquirerPrompt(createInputPrompt("Enter iOS version (ex: 13.3):"));
+        const version = await inquirerPrompt(createInputPrompt("Enter safari version (ex: 13.0):"));
 
         _.mergeWith(
             config,