@qavajs/create 0.2.0 → 0.4.0

package/CHANGELOG.MD

@@ -1,6 +1,6 @@
 # Change Log
 
-All notable changes to the "@qavajs/cli" will be documented in this file.
+All notable changes to the "@qavajs/create" will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
@@ -8,6 +8,16 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :beetle: - bugfix
 :x: - deprecation
 
+## [0.4.0]
+- :rocket: updated formatters to modern syntax
+- :rocket: added .gitignore template
+- :rocket: migrated to @inquirer/prompts
+- :rocket: updated wizard to support built-in po
+
+## [0.3.0]
+- :rocket: added @qavajs/validation as dependency
+- :rocket: added @qavajs/steps-memory as default module
+
 ## [0.2.0]
 - :rocket: added typescript to required modules
 - :rocket: added package.json template

package/lib/deps.js

@@ -4,13 +4,13 @@ exports.additionalModules = exports.modules = exports.format = exports.steps = v
 exports.default = [
     '@cucumber/cucumber',
     '@qavajs/memory',
-    '@qavajs/cli'
+    '@qavajs/cli',
+    '@qavajs/validation'
 ];
 exports.steps = [
-    { module: 'wdio', packageName: '@qavajs/steps-wdio' },
     { module: 'playwright', packageName: '@qavajs/steps-playwright' },
+    { module: 'wdio', packageName: '@qavajs/steps-wdio' },
     { module: 'api', packageName: '@qavajs/steps-api' },
-    { module: 'memory', packageName: '@qavajs/steps-memory' },
     { module: 'files', packageName: '@qavajs/steps-files' },
     { module: 'sql', packageName: '@qavajs/steps-sql' },
     { module: 'accessibility', packageName: '@qavajs/steps-accessibility' },

package/lib/install.js

@@ -35,14 +35,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const promises_1 = require("fs/promises");
+exports.default = install;
+const promises_1 = require("node:fs/promises");
 const fs_extra_1 = require("fs-extra");
 const path_1 = require("path");
 const yarn_install_1 = __importDefault(require("yarn-install"));
 const deps_1 = __importStar(require("./deps"));
 const ejs_1 = require("ejs");
-const inquirer = import('inquirer').then(m => m.default);
-const packs = (deps) => deps.map(({ module }) => module);
+const prompts_1 = require("@inquirer/prompts");
+const packs = (deps) => deps.map(({ module }) => ({ value: module }));
 const packages = (moduleList, packageMap) => {
     return moduleList
         .map((module) => {
@@ -56,44 +57,33 @@ const replaceNewLines = (text) => text.replace(/(\r?\n\r?)+/g, '\n');
 function install() {
     return __awaiter(this, void 0, void 0, function* () {
         const requiredDeps = [...deps_1.default];
-        const { prompt } = yield inquirer;
-        const answers = yield prompt([
-            {
-                type: 'list',
+        const answers = {
+            moduleSystem: yield (0, prompts_1.select)({
                 message: 'select module system you want to use:',
-                name: 'moduleSystem',
                 choices: [
-                    'CommonJS',
-                    'ES Modules',
-                    'Typescript'
+                    { value: 'CommonJS' },
+                    { value: 'ES Modules' },
+                    { value: 'Typescript' }
                 ]
-            },
-            {
-                type: 'checkbox',
+            }),
+            steps: yield (0, prompts_1.checkbox)({
                 message: 'select step packages to install:',
-                name: 'steps',
                 choices: packs(deps_1.steps)
-            },
-            {
-                type: 'checkbox',
-                message: 'select modules to install:',
-                name: 'modules',
-                choices: packs(deps_1.modules)
-            },
-            {
-                type: 'checkbox',
+            }),
+            formats: yield (0, prompts_1.checkbox)({
                 message: 'select formatters (reporters) to install:',
-                name: 'formats',
                 choices: packs(deps_1.format)
-            },
-            {
-                type: 'checkbox',
+            }),
+            modules: yield (0, prompts_1.checkbox)({
+                message: 'select modules to install:',
+                choices: packs(deps_1.modules)
+            }),
+            additionalModules: yield (0, prompts_1.checkbox)({
                 message: 'select additional modules to install:',
-                name: 'additionalModules',
                 choices: packs(deps_1.additionalModules)
-            },
-        ]);
-        const stepsPackages = packages(answers.steps, deps_1.steps);
+            })
+        };
+        const stepsPackages = ['@qavajs/steps-memory', ...packages(answers.steps, deps_1.steps)];
         const formatPackages = packages(answers.formats, deps_1.format);
         const modulePackages = packages(answers.modules, deps_1.modules);
         const additionalPackages = packages(answers.additionalModules, deps_1.additionalModules);
@@ -107,6 +97,9 @@ function install() {
         }
         const isPOIncluded = isWdioIncluded || isPlaywrightIncluded;
         const isTemplateIncluded = answers.modules.includes('template');
+        // add .gitignore
+        const gitignoreTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/.gitignore'), 'utf-8');
+        yield (0, promises_1.writeFile)(`./.gitignore`, gitignoreTemplate, 'utf-8');
         // add package.json
         const packageJsonTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/package.json'), 'utf-8');
         yield (0, promises_1.writeFile)(`./package.json`, packageJsonTemplate, 'utf-8');
@@ -123,12 +116,12 @@ function install() {
         const stepDefinitionGlob = `step_definition/*.${isTypescript ? 'ts' : 'js'}`;
         const stepsPackagesGlobs = [...stepsPackages].map(p => `node_modules/${p}/index.js`);
         const config = configEjs({
-            steps: JSON.stringify([stepDefinitionGlob, ...stepsPackagesGlobs]),
+            steps: JSON.stringify([...stepsPackagesGlobs, stepDefinitionGlob]),
             moduleSystem: answers.moduleSystem,
             modules: JSON.stringify(modulePackages),
             format: JSON.stringify(deps_1.format
                 .filter(p => formatPackages.includes(p.packageName))
-                .map(p => p.packageName + (p.out ? `:${p.out}` : ''))),
+                .map(p => p.out ? [p.packageName, p.out] : p.packageName)),
             isWdioIncluded,
             isPlaywrightIncluded,
             isTemplateIncluded
@@ -140,12 +133,11 @@ function install() {
         if (isPOIncluded) {
             let poModule;
             if (isWdioIncluded)
-                poModule = '@qavajs/po';
+                poModule = '@qavajs/steps-wdio/po';
             if (isPlaywrightIncluded)
-                poModule = '@qavajs/po-playwright';
+                poModule = '@qavajs/steps-playwright/po';
             if (!poModule)
                 throw new Error('No PO module');
-            requiredDeps.push(poModule);
             const featureTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/feature.ejs'), 'utf-8');
             const featureEjs = (0, ejs_1.compile)(featureTemplate);
             const featureFile = featureEjs();
@@ -197,7 +189,6 @@ function install() {
             respectNpm5: true
         });
         console.log('test script:');
-        console.log(`npx qavajs run --config config.${isTypescript ? 'ts' : 'js'}`);
+        console.log(`npx qavajs --config config.${isTypescript ? 'ts' : 'js'}`);
     });
 }
-exports.default = install;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/create",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "initializer of @qavajs project",
   "main": "index.js",
   "scripts": {
@@ -20,18 +20,17 @@
   "author": "Alexandr Galichenko",
   "license": "MIT",
   "dependencies": {
-    "ejs": "^3.1.9",
+    "@inquirer/prompts": "^5.3.2",
+    "ejs": "^3.1.10",
     "fs-extra": "^11.2.0",
-    "inquirer": "^9.2.16",
-    "typescript": "^5.4.2",
+    "typescript": "^5.5.4",
     "yarn-install": "^1.0.0"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
-    "@types/inquirer": "^9.0.7",
-    "@types/node": "^20.11.28",
-    "@vitest/coverage-v8": "^1.4.0",
-    "vitest": "^1.4.0"
+    "@types/node": "^20.14.11",
+    "@vitest/coverage-v8": "^2.0.4",
+    "vitest": "^2.0.4"
   }
 }

package/src/deps.ts

@@ -1,7 +1,8 @@
 export default [
     '@cucumber/cucumber',
     '@qavajs/memory',
-    '@qavajs/cli'
+    '@qavajs/cli',
+    '@qavajs/validation'
 ]
 
 export type ModuleDefinition = {
@@ -11,10 +12,9 @@ export type ModuleDefinition = {
 }
 
 export const steps: Array<ModuleDefinition> = [
-    { module: 'wdio', packageName: '@qavajs/steps-wdio' },
     { module: 'playwright', packageName: '@qavajs/steps-playwright' },
+    { module: 'wdio', packageName: '@qavajs/steps-wdio' },
     { module: 'api', packageName: '@qavajs/steps-api' },
-    { module: 'memory', packageName: '@qavajs/steps-memory' },
     { module: 'files', packageName: '@qavajs/steps-files' },
     { module: 'sql', packageName: '@qavajs/steps-sql' },
     { module: 'accessibility', packageName: '@qavajs/steps-accessibility' },

package/src/install.ts

@@ -1,21 +1,12 @@
-import { readFile, writeFile } from 'fs/promises';
+import { readFile, writeFile } from 'node:fs/promises';
 import { ensureDir } from 'fs-extra';
 import { resolve } from 'path';
 import yarnInstall from 'yarn-install';
-import deps, {steps, format, modules, additionalModules, ModuleDefinition} from './deps';
+import deps, { steps, format, modules, additionalModules, ModuleDefinition } from './deps';
 import { compile } from 'ejs';
-const inquirer = import('inquirer').then(m => m.default);
-
-type Answers = {
-    steps: Array<string>,
-    formats: Array<string>,
-    modules: Array<string>,
-    additionalModules: Array<string>,
-    parallel: number,
-    moduleSystem: string
-}
+import { select, checkbox } from '@inquirer/prompts';
 
-const packs = (deps: Array<ModuleDefinition>) => deps.map(({module}) => module);
+const packs = (deps: Array<ModuleDefinition>) => deps.map(({module}) => ({ value: module }));
 const packages = (moduleList: Array<string>, packageMap: Array<ModuleDefinition>): Array<string> => {
     return moduleList
         .map((module: string) => {
@@ -29,45 +20,35 @@ const replaceNewLines = (text: string) => text.replace(/(\r?\n\r?)+/g, '\n');
 
 export default async function install(): Promise<void> {
     const requiredDeps = [...deps];
-    const { prompt } = await inquirer;
-    const answers = await prompt([
-        {
-            type: 'list',
+
+    const answers = {
+        moduleSystem: await select({
             message: 'select module system you want to use:',
-            name: 'moduleSystem',
             choices: [
-                'CommonJS',
-                'ES Modules',
-                'Typescript'
+                { value: 'CommonJS' },
+                { value: 'ES Modules' },
+                { value: 'Typescript' }
             ]
-        },
-        {
-            type: 'checkbox',
+        }),
+        steps: await checkbox({
             message: 'select step packages to install:',
-            name: 'steps',
             choices: packs(steps)
-        },
-        {
-            type: 'checkbox',
-            message: 'select modules to install:',
-            name: 'modules',
-            choices: packs(modules)
-        },
-        {
-            type: 'checkbox',
+        }),
+        formats: await checkbox({
             message: 'select formatters (reporters) to install:',
-            name: 'formats',
             choices: packs(format)
-        },
-        {
-            type: 'checkbox',
+        }),
+        modules: await checkbox({
+            message: 'select modules to install:',
+            choices: packs(modules)
+        }),
+        additionalModules: await checkbox({
             message: 'select additional modules to install:',
-            name: 'additionalModules',
             choices: packs(additionalModules)
-        },
-    ]) as Answers;
+        })
+    };
 
-    const stepsPackages: Array<string> = packages(answers.steps, steps);
+    const stepsPackages: Array<string> = ['@qavajs/steps-memory', ...packages(answers.steps, steps)];
     const formatPackages: Array<string> = packages(answers.formats, format);
     const modulePackages: Array<string> = packages(answers.modules, modules);
     const additionalPackages: Array<string> = packages(answers.additionalModules, additionalModules);
@@ -83,6 +64,13 @@ export default async function install(): Promise<void> {
     const isPOIncluded: boolean = isWdioIncluded || isPlaywrightIncluded;
     const isTemplateIncluded: boolean = answers.modules.includes('template');
 
+    // add .gitignore
+    const gitignoreTemplate = await readFile(
+        resolve(__dirname, '../templates/.gitignore'),
+        'utf-8'
+    );
+    await writeFile(`./.gitignore`, gitignoreTemplate, 'utf-8');
+
     // add package.json
     const packageJsonTemplate = await readFile(
         resolve(__dirname, '../templates/package.json'),
@@ -108,13 +96,13 @@ export default async function install(): Promise<void> {
     const stepDefinitionGlob = `step_definition/*.${isTypescript ? 'ts' : 'js'}`;
     const stepsPackagesGlobs = [...stepsPackages].map(p => `node_modules/${p}/index.js`);
     const config = configEjs({
-        steps: JSON.stringify([stepDefinitionGlob, ...stepsPackagesGlobs]),
+        steps: JSON.stringify([...stepsPackagesGlobs, stepDefinitionGlob]),
         moduleSystem: answers.moduleSystem,
         modules: JSON.stringify(modulePackages),
         format: JSON.stringify(
             format
                 .filter(p => formatPackages.includes(p.packageName))
-                .map(p => p.packageName + (p.out ? `:${p.out}` : ''))
+                .map(p => p.out ? [p.packageName, p.out] : p.packageName)
         ),
         isWdioIncluded,
         isPlaywrightIncluded,
@@ -128,10 +116,9 @@ export default async function install(): Promise<void> {
 
     if (isPOIncluded) {
         let poModule: string | undefined;
-        if (isWdioIncluded) poModule = '@qavajs/po';
-        if (isPlaywrightIncluded) poModule = '@qavajs/po-playwright';
+        if (isWdioIncluded) poModule = '@qavajs/steps-wdio/po';
+        if (isPlaywrightIncluded) poModule = '@qavajs/steps-playwright/po';
         if (!poModule) throw new Error('No PO module');
-        requiredDeps.push(poModule);
         const featureTemplate: string = await readFile(
             resolve(__dirname, '../templates/feature.ejs'),
             'utf-8'
@@ -209,5 +196,5 @@ export default async function install(): Promise<void> {
     });
 
     console.log('test script:');
-    console.log(`npx qavajs run --config config.${isTypescript ? 'ts' : 'js'}`);
+    console.log(`npx qavajs --config config.${isTypescript ? 'ts' : 'js'}`);
 }