@qavajs/create 0.4.2 → 1.0.1

package/CHANGELOG.MD

@@ -8,6 +8,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :beetle: - bugfix
 :x: - deprecation
 
+## [1.0.0]
+- :rocket: release
+
 ## [0.4.2]
 - :beetle: fixed default UI scenario
 

package/lib/deps.js

@@ -8,14 +8,15 @@ exports.default = [
     '@qavajs/validation'
 ];
 exports.steps = [
-    { module: 'playwright', packageName: '@qavajs/steps-playwright' },
-    { module: 'wdio', packageName: '@qavajs/steps-wdio' },
-    { module: 'api', packageName: '@qavajs/steps-api' },
-    { module: 'files', packageName: '@qavajs/steps-files' },
-    { module: 'sql', packageName: '@qavajs/steps-sql' },
-    { module: 'accessibility', packageName: '@qavajs/steps-accessibility' },
-    { module: 'lighthouse', packageName: '@qavajs/steps-lighthouse' },
-    { module: 'visual testing', packageName: '@qavajs/steps-visual-testing' }
+    { module: 'playwright', packageName: '@qavajs/steps-playwright', version: '1' },
+    { module: 'wdio', packageName: '@qavajs/steps-wdio', version: '1' },
+    { module: 'api', packageName: '@qavajs/steps-api', version: '1' },
+    { module: 'files', packageName: '@qavajs/steps-files', version: '1' },
+    { module: 'sql', packageName: '@qavajs/steps-sql', version: '1' },
+    { module: 'accessibility', packageName: '@qavajs/steps-accessibility', version: '1' },
+    { module: 'lighthouse', packageName: '@qavajs/steps-lighthouse', version: '1' },
+    { module: 'visual testing', packageName: '@qavajs/steps-visual-testing', version: '1' },
+    { module: 'memory', packageName: '@qavajs/steps-memory', version: '1' }
 ];
 exports.format = [
     { module: 'report portal', packageName: '@qavajs/format-report-portal', out: 'report/rp.out' },

package/lib/install.js

@@ -38,7 +38,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = install;
 const promises_1 = require("node:fs/promises");
 const fs_extra_1 = require("fs-extra");
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 const yarn_install_1 = __importDefault(require("yarn-install"));
 const deps_1 = __importStar(require("./deps"));
 const ejs_1 = require("ejs");
@@ -50,7 +50,16 @@ const packages = (moduleList, packageMap) => {
         const pkg = packageMap.find((p) => p.module === module);
         if (!pkg)
             throw new Error(`${module} module is not found`);
-        return pkg.packageName;
+        return pkg.version ? `${pkg.packageName}@${pkg.version}` : pkg.packageName;
+    });
+};
+const requireGlob = (moduleList, packageMap) => {
+    return moduleList
+        .map((module) => {
+        const pkg = packageMap.find((p) => p.module === module);
+        if (!pkg)
+            throw new Error(`${module} module is not found`);
+        return `node_modules/${pkg.packageName}/index.js`;
     });
 };
 const replaceNewLines = (text) => text.replace(/(\r?\n\r?)+/g, '\n');
@@ -83,7 +92,7 @@ function install() {
                 choices: packs(deps_1.additionalModules)
             })
         };
-        const stepsPackages = ['@qavajs/steps-memory', ...packages(answers.steps, deps_1.steps)];
+        const stepsPackages = [...packages(['memory'], deps_1.steps), ...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);
@@ -98,23 +107,23 @@ 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');
+        const gitignoreTemplate = yield (0, promises_1.readFile)((0, node_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');
+        const packageJsonTemplate = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/package.json'), 'utf-8');
         yield (0, promises_1.writeFile)(`./package.json`, packageJsonTemplate, 'utf-8');
         // add ts-node and typescript packages if module system is typescript
         // put tsconfig
         if (isTypescript) {
             requiredDeps.push('ts-node');
             requiredDeps.push('typescript');
-            const tsconfig = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/tsconfig.json'), 'utf-8');
+            const tsconfig = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/tsconfig.json'), 'utf-8');
             yield (0, promises_1.writeFile)(`./tsconfig.json`, tsconfig, 'utf-8');
         }
-        const configTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/config.ejs'), 'utf-8');
+        const configTemplate = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/config.ejs'), 'utf-8');
         const configEjs = (0, ejs_1.compile)(configTemplate);
         const stepDefinitionGlob = `step_definition/*.${isTypescript ? 'ts' : 'js'}`;
-        const stepsPackagesGlobs = [...stepsPackages].map(p => `node_modules/${p}/index.js`);
+        const stepsPackagesGlobs = [...requireGlob(['memory'], deps_1.steps), ...requireGlob(answers.steps, deps_1.steps)];
         const config = configEjs({
             steps: JSON.stringify([...stepsPackagesGlobs, stepDefinitionGlob]),
             moduleSystem: answers.moduleSystem,
@@ -138,13 +147,13 @@ function install() {
                 poModule = '@qavajs/steps-playwright/po';
             if (!poModule)
                 throw new Error('No PO module');
-            const featureTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/feature.ejs'), 'utf-8');
+            const featureTemplate = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/feature.ejs'), 'utf-8');
             const featureEjs = (0, ejs_1.compile)(featureTemplate);
             const featureFile = featureEjs();
             yield (0, promises_1.writeFile)('./features/qavajs.feature', replaceNewLines(featureFile), 'utf-8');
             //create page object folder
             yield (0, fs_extra_1.ensureDir)('./page_object');
-            const poTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/po.ejs'), 'utf-8');
+            const poTemplate = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/po.ejs'), 'utf-8');
             const poEjs = (0, ejs_1.compile)(poTemplate);
             const poFile = poEjs({
                 moduleSystem: answers.moduleSystem,
@@ -153,7 +162,7 @@ function install() {
             yield (0, promises_1.writeFile)(`./page_object/index.${isTypescript ? 'ts' : 'js'}`, replaceNewLines(poFile), 'utf-8');
         }
         if (isApiIncluded) {
-            const featureTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/featureApi.ejs'), 'utf-8');
+            const featureTemplate = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/featureApi.ejs'), 'utf-8');
             const featureEjs = (0, ejs_1.compile)(featureTemplate);
             const featureFile = featureEjs();
             yield (0, promises_1.writeFile)('./features/qavajsApi.feature', replaceNewLines(featureFile), 'utf-8');
@@ -162,13 +171,13 @@ function install() {
             yield (0, fs_extra_1.ensureDir)('./templates');
         }
         yield (0, promises_1.writeFile)(`config.${isTypescript ? 'ts' : 'js'}`, replaceNewLines(config), 'utf-8');
-        const memoryTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/memory.ejs'), 'utf-8');
+        const memoryTemplate = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/memory.ejs'), 'utf-8');
         const memoryEjs = (0, ejs_1.compile)(memoryTemplate);
         const memoryFile = memoryEjs({
             moduleSystem: answers.moduleSystem
         });
         yield (0, promises_1.writeFile)(`./memory/index.${isTypescript ? 'ts' : 'js'}`, replaceNewLines(memoryFile), 'utf-8');
-        const readmeTemplate = yield (0, promises_1.readFile)((0, path_1.resolve)(__dirname, '../templates/readme.ejs'), 'utf-8');
+        const readmeTemplate = yield (0, promises_1.readFile)((0, node_path_1.resolve)(__dirname, '../templates/readme.ejs'), 'utf-8');
         const readmeEjs = (0, ejs_1.compile)(readmeTemplate);
         const readmeFile = readmeEjs({
             moduleSystem: answers.moduleSystem

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/create",
-  "version": "0.4.2",
+  "version": "1.0.1",
   "description": "initializer of @qavajs project",
   "main": "index.js",
   "scripts": {
@@ -20,17 +20,17 @@
   "author": "Alexandr Galichenko",
   "license": "MIT",
   "dependencies": {
-    "@inquirer/prompts": "^5.5.0",
+    "@inquirer/prompts": "^7.0.1",
     "ejs": "^3.1.10",
     "fs-extra": "^11.2.0",
-    "typescript": "^5.6.2",
+    "typescript": "^5.6.3",
     "yarn-install": "^1.0.0"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.16.5",
-    "@vitest/coverage-v8": "^2.0.5",
-    "vitest": "^2.0.5"
+    "@types/node": "^22.8.2",
+    "@vitest/coverage-v8": "^2.1.4",
+    "vitest": "^2.1.4"
   }
 }

package/src/deps.ts

@@ -8,18 +8,20 @@ export default [
 export type ModuleDefinition = {
     module: string,
     packageName: string,
-    out?: string
+    out?: string,
+    version?: string
 }
 
 export const steps: Array<ModuleDefinition> = [
-    { module: 'playwright', packageName: '@qavajs/steps-playwright' },
-    { module: 'wdio', packageName: '@qavajs/steps-wdio' },
-    { module: 'api', packageName: '@qavajs/steps-api' },
-    { module: 'files', packageName: '@qavajs/steps-files' },
-    { module: 'sql', packageName: '@qavajs/steps-sql' },
-    { module: 'accessibility', packageName: '@qavajs/steps-accessibility' },
-    { module: 'lighthouse', packageName: '@qavajs/steps-lighthouse' },
-    { module: 'visual testing', packageName: '@qavajs/steps-visual-testing' }
+    { module: 'playwright', packageName: '@qavajs/steps-playwright', version: '1' },
+    { module: 'wdio', packageName: '@qavajs/steps-wdio', version: '1' },
+    { module: 'api', packageName: '@qavajs/steps-api', version: '1' },
+    { module: 'files', packageName: '@qavajs/steps-files', version: '1' },
+    { module: 'sql', packageName: '@qavajs/steps-sql', version: '1' },
+    { module: 'accessibility', packageName: '@qavajs/steps-accessibility', version: '1' },
+    { module: 'lighthouse', packageName: '@qavajs/steps-lighthouse', version: '1' },
+    { module: 'visual testing', packageName: '@qavajs/steps-visual-testing', version: '1' },
+    { module: 'memory', packageName: '@qavajs/steps-memory', version: '1' }
 ]
 
 export const format: Array<ModuleDefinition> = [

package/src/install.ts

@@ -1,6 +1,6 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { ensureDir } from 'fs-extra';
-import { resolve } from 'path';
+import { resolve } from 'node:path';
 import yarnInstall from 'yarn-install';
 import deps, { steps, format, modules, additionalModules, ModuleDefinition } from './deps';
 import { compile } from 'ejs';
@@ -12,7 +12,15 @@ const packages = (moduleList: Array<string>, packageMap: Array<ModuleDefinition>
         .map((module: string) => {
             const pkg = packageMap.find((p: ModuleDefinition) => p.module === module);
             if (!pkg) throw new Error(`${module} module is not found`);
-            return pkg.packageName
+            return pkg.version ? `${pkg.packageName}@${pkg.version}` : pkg.packageName;
+        }) as Array<string>
+}
+const requireGlob = (moduleList: Array<string>, packageMap: Array<ModuleDefinition>): Array<string> => {
+    return moduleList
+        .map((module: string) => {
+            const pkg = packageMap.find((p: ModuleDefinition) => p.module === module);
+            if (!pkg) throw new Error(`${module} module is not found`);
+            return `node_modules/${pkg.packageName}/index.js`;
         }) as Array<string>
 }
 
@@ -48,7 +56,7 @@ export default async function install(): Promise<void> {
         })
     };
 
-    const stepsPackages: Array<string> = ['@qavajs/steps-memory', ...packages(answers.steps, steps)];
+    const stepsPackages: Array<string> = [...packages(['memory'], steps), ...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);
@@ -94,7 +102,7 @@ export default async function install(): Promise<void> {
     );
     const configEjs = compile(configTemplate);
     const stepDefinitionGlob = `step_definition/*.${isTypescript ? 'ts' : 'js'}`;
-    const stepsPackagesGlobs = [...stepsPackages].map(p => `node_modules/${p}/index.js`);
+    const stepsPackagesGlobs = [...requireGlob(['memory'], steps), ...requireGlob(answers.steps, steps)];
     const config = configEjs({
         steps: JSON.stringify([...stepsPackagesGlobs, stepDefinitionGlob]),
         moduleSystem: answers.moduleSystem,