artes 1.2.18 → 1.2.19

package/README.md

@@ -15,34 +15,40 @@ Artes is a test runner for Playwright that executes [predefined Cucumber tests](
 ## 🌟 Artes Benefits
 
 ### 🚀 Fast Setup & Smooth Onboarding
+
 - Install in minutes and create a test project effortlessly
 - Well-structured, easy-to-follow documentation for a smooth learning curve
 - Designed for long-term maintainability and scalability
 
 ### 🧩 Powerful & Developer-Friendly Architecture
+
 - Intuitive API for writing custom step definitions
 - Rich set of ready-to-use step definitions to speed up test creation
 - Fully extensible — add your own step definitions anytime
 
 ### 🌐 Advanced API Testing
+
 - Schema validation to ensure API response correctness
 - Rich assertion library for precise validations
 - Support for all HTTP methods
 - Environment-based API configuration for flexible testing
 
 ### 🔁 Smart Variable & Data Handling
+
 - Page Object Model (POM) support for structured data management
 - Save, reuse, and share variables across steps
 - Built-in data randomization for dynamic and realistic test data
 - Environment-specific variables for clean environment separation
 
 ### 🖥️ Modern UI Automation
+
 - Wide locator strategy support (CSS, XPath, text-based, and more)
 - Built-in browser actions
 - Cookie management
 - Local & session storage handling
 
 ### ⚙️ Flexible Configuration & Hooks
+
 - Environment-based configuration system
 - Powerful and customizable configuration files
 - Full hook support:
@@ -50,11 +56,13 @@ Artes is a test runner for Playwright that executes [predefined Cucumber tests](
   - Step-level and scenario-level hooks
 
 ### 🧪 CLI, CI/CD & Containerization
+
 - Powerful CLI for full control from the command line
 - Official [Artes Docker image](https://hub.docker.com/r/vahidaghayev/artes) for seamless containerized execution
 - CI/CD-ready — integrate easily with any pipeline
 
 ### 📊 Artes Reporting System
+
 - Easy installation with docker compose (For detailed info: [Artes Reporting System](https://github.com/4gayev1/artes-reporting-system))
 - Multiple reporting formats supported
 - Native Allure reporting integration
@@ -100,6 +108,7 @@ npx artes [options]
 | 🏷️ `-v, --version`        | Show the current version of Artes                                                  | `artes -v` or `artes --version`                                       |
 | 🏗️ `-c, --create`         | Create an example project with Artes                                               | `artes -c` or `artes --create`                                        |
 | ✅ `-y, --yes`            | Skip the confirmation prompt when creating an example project                      | `artes -c -y` or `artes --create --yes`                               |
+| 🚫 --noDeps               | Skip installing dependencies when creating example project                         | `artes -c --noDeps`                                                   |
 | 📊 `-r, --report`         | Run tests and generate Allure report                                               | `artes -r` or `artes --report`                                        |
 | `--reportSuccess`         | Add screenshots and video records for also Success test cases                      | `artes --reportSuccess`                                               |
 | `--trace`                 | Enable tracing                                                                     | `artes --trace`                                                       |
@@ -393,6 +402,7 @@ Hooks are **user-defined**.
 ### 📁 Hooks File Location
 
 Create the following file **inside your project** (optional):
+
 ```
 tests/steps/hooks.js
 ```
@@ -408,27 +418,27 @@ Undefined hooks are automatically skipped.
 // tests/steps/hooks.js
 
 export function BeforeStep() {
-    // hook for before each step
+  // hook for before each step
 }
 
 export function Before() {
-    // hook for before each test
+  // hook for before each test
 }
 
 export function BeforeAll() {
-    // hook for before all tests
+  // hook for before all tests
 }
 
 export function AfterStep() {
-    // hook for after each step
+  // hook for after each step
 }
 
 export function After() {
-    // hook for after each test
+  // hook for after each test
 }
 
 export function AfterAll() {
-    // hook for after all tests
+  // hook for after all tests
 }
 ```
 
@@ -450,6 +460,7 @@ export function AfterAll() {
 ### ▶️ Execution Order Example
 
 For a scenario with steps:
+
 ```
 BeforeAll
 Before
@@ -514,18 +525,20 @@ Artes supports environment-specific configurations through environment variables
 ### Setting Up Environment Variables
 
 1. **Configure Environment in artes.config.js:**
+
    ```javascript
    module.exports = {
      baseURL: {
        dev: "https://dev.alma.az",
-       pre: "https://pre.alma.az", 
-       prod: "https://api.alma.az"
+       pre: "https://pre.alma.az",
+       prod: "https://api.alma.az",
      },
      env: "dev", // Specify which environment to use
    };
    ```
 
    **Alternative single URL configuration:**
+
    ```javascript
    module.exports = {
      baseURL: "https://api.alma.az", // Direct string URL
@@ -536,6 +549,7 @@ Artes supports environment-specific configurations through environment variables
    Create JSON files under `src/tests/environment_variables/` folder with names matching your environment:
 
    **dev.env.json:**
+
    ```json
    {
      "api_key": "dev-api-key-12345",
@@ -559,7 +573,7 @@ Artes supports environment-specific configurations through environment variables
 ### Important Notes
 
 - ⚠️ **Base URLs must be defined in `artes.config.js`** - they cannot be set in the environment variable JSON files
-- 📁 Environment variable files should be placed in `src/tests/environment_variables/` 
+- 📁 Environment variable files should be placed in `src/tests/environment_variables/`
 - 🏷️ File names must follow the format `{env}.env.json` (e.g., `dev.env.json` for `env: "dev"`)
 - 🔄 Variables are loaded into variable storage and can be accessed during test runs
 - 🌐 Use environment variables for headers, API keys, timeouts, and other environment-specific configurations
@@ -627,4 +641,4 @@ If you don't use the -c or --create option that the package offers, save the fil
 
 ---
 
-## 🧑‍💻 Have a Good Testing
+## 🧑‍💻 Have a Good Testing

package/cucumber.config.js

@@ -32,9 +32,15 @@ const finalFormats = [
 
 function resolveEnv(artesConfig) {
   if (typeof artesConfig.baseURL === "object" && artesConfig.baseURL !== null) {
-    if (process.env.ENV && artesConfig.baseURL.hasOwnProperty(process.env.ENV.trim())) {
+    if (
+      process.env.ENV &&
+      artesConfig.baseURL.hasOwnProperty(process.env.ENV.trim())
+    ) {
       return process.env.ENV.trim();
-    } else if (artesConfig.env && artesConfig.baseURL.hasOwnProperty(artesConfig.env.trim())) {
+    } else if (
+      artesConfig.env &&
+      artesConfig.baseURL.hasOwnProperty(artesConfig.env.trim())
+    ) {
       return artesConfig.env.trim();
     } else {
       return Object.keys(artesConfig.baseURL)[0];
@@ -131,9 +137,14 @@ module.exports = {
     // World parameters
     worldParameters: artesConfig.worldParameters || {}, // Custom world parameters
   },
-  report:{
-    singleFileReport: process.env.SINGLE_FILE_REPORT == "true" ? true : artesConfig.singleFileReport ? true : false,
-    zip: process.env.ZIP == "true" ? true : artesConfig.zip ? true : false
+  report: {
+    singleFileReport:
+      process.env.SINGLE_FILE_REPORT == "true"
+        ? true
+        : artesConfig.singleFileReport
+          ? true
+          : false,
+    zip: process.env.ZIP == "true" ? true : artesConfig.zip ? true : false,
   },
   env: env,
   baseURL: process.env.BASE_URL

package/docs/functionDefinitions.md

@@ -434,7 +434,6 @@ await getURL();
 ```
 
 - **Returns**:
-
   - _(string)_: The current page URL.
 
   ***
@@ -656,7 +655,6 @@ await shouldHaveId("#element-id", "unique-id");
 ```
 
 - **Parameters**:
-
   - `id` _(string)_: The expected ID.
 
   Got it! Here’s the refined format for the assertion methods:
@@ -1544,7 +1542,6 @@ await shouldObjectContaining(".element", { key: "value" });
 ```
 
 - **Parameters**:
-
   - `selector` _(string)_: The CSS selector for the element.
   - `properties` _(object)_: The object properties to check for.
 

package/docs/stepDefinitions.md

@@ -208,12 +208,14 @@
 # Variable Management
 
 ## Manual Variable Assignment
+
 - User saves `{string}` variable from response as `{string}`
 - User saves `{string}` variable as `{string}`
 
 ## Random Variable Management
 
 ### Random Words
+
 - User sets random word as `{string}`
 - User sets random word that has `{int}` character as `{string}`
 - User sets random word that has character between `{int}` and `{int}` as `{string}`
@@ -222,19 +224,23 @@
 - User sets random words that range between `{int}` and `{int}` as `{string}`
 
 ### Random Numbers
+
 - User sets random number as `{string}`
 - User sets random number from `{int}` to `{int}` as `{string}`
 
 ### Random Text Content
+
 - User sets random paragraph as `{string}`
 - User sets random paragraph that range between `{int}` and `{int}` as `{string}`
 - User sets random sentences that has `{int}` paragraph as `{string}`
 
 ### Random Characters & Alphanumeric
+
 - User sets random characters from `{string}` as `{string}`
 - User sets random alphanumeric in range from `{int}` to `{int}` as `{string}`
 
 ### Random Personal Information
+
 - User sets random email as `{string}`
 - User sets random fullname as `{string}`
 - User sets random first name as `{string}`
@@ -242,18 +248,23 @@
 - User sets random middle name as `{string}`
 
 ### Random Internet Data
+
 - User sets random url as `{string}`
 
 ### Random Dates
+
 - User sets random date between `{int}` and `{int}` as `{string}`
 - User sets date `{int}` days after today as `{string}`
 - User sets date `{int}` days before today as `{string}`
 
 ### Random from API Response
+
 - User sends GET request to `{string}` and save `{string}` variable from `{string}` array as `{string}` randomly
 
 ### Random from Array
+
 - User sets random value from given `{string}` array as `{string}`
+
 ---
 
 # Debugging / Console Output
@@ -264,7 +275,6 @@
 
 ---
 
-
 # Random Data Generation
 
 - User sets random words as `{string}` variable

package/executer.js

@@ -25,6 +25,7 @@ const flags = {
   version: args.includes("-v") || args.includes("--version"),
   create: args.includes("-c") || args.includes("--create"),
   createYes: args.includes("-y") || args.includes("--yes"),
+  noDeps: args.includes("--noDeps"),
   report: args.includes("-r") || args.includes("--report"),
   reportSuccess: args.includes("--reportSuccess"),
   trace: args.includes("-t") || args.includes("--trace"),
@@ -64,8 +65,7 @@ const height = args[args.indexOf("--height") + 1];
 const timeout = args[args.indexOf("--timeout") + 1];
 const slowMo = args[args.indexOf("--slowMo") + 1];
 
-
-flags.env ? (process.env.ENV = env) : ""
+flags.env ? (process.env.ENV = env) : "";
 
 flags.reportWithTrace ||
 artesConfig.reportWithTrace ||
@@ -91,11 +91,15 @@ flags.report ? (process.env.REPORT = true) : "";
 
 flags.trace ? (process.env.TRACE = true) : "";
 
-flags.reportWithTrace ? (process.env.REPORT_WITH_TRACE = true) : (process.env.REPORT_WITH_TRACE=false);
+flags.reportWithTrace
+  ? (process.env.REPORT_WITH_TRACE = true)
+  : (process.env.REPORT_WITH_TRACE = false);
 
-flags.singleFileReport ? (process.env.SINGLE_FILE_REPORT = true) : (process.env.SINGLE_FILE_REPORT=false);
+flags.singleFileReport
+  ? (process.env.SINGLE_FILE_REPORT = true)
+  : (process.env.SINGLE_FILE_REPORT = false);
 
-flags.zip ? (process.env.ZIP = true) : (process.env.ZIP=false);
+flags.zip ? (process.env.ZIP = true) : (process.env.ZIP = false);
 
 flags.headless &&
   console.log("Running mode:", flags.headless ? "headless" : "headed");
@@ -131,7 +135,7 @@ flags.slowMo ? (process.env.SLOWMO = slowMo) : "";
 function main() {
   if (flags.help) return showHelp();
   if (flags.version) return showVersion();
-  if (flags.create) return createProject(flags.createYes);
+  if (flags.create) return createProject(flags.createYes, flags.noDeps);
 
   runTests();
   if (

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.2.18",
+  "version": "1.2.19",
   "description": "The simplest way to automate UI and API tests using Cucumber-style steps.",
   "main": "index.js",
   "scripts": {

package/src/helper/contextManager/browserManager.js

@@ -8,7 +8,7 @@ const invokeBrowser = async () => {
 
   if (typeof cucumberConfig.baseURL === "object") {
     const env = (cucumberConfig.env || "").trim();
-      baseURL = cucumberConfig.baseURL[env];
+    baseURL = cucumberConfig.baseURL[env];
   } else {
     baseURL = cucumberConfig.baseURL;
   }

package/src/helper/contextManager/requestManager.js

@@ -5,14 +5,14 @@ let baseURL = "";
 
 if (typeof cucumberConfig.baseURL === "object") {
   const env = (cucumberConfig.env || "").trim();
-    baseURL = cucumberConfig.baseURL[env];
+  baseURL = cucumberConfig.baseURL[env];
 } else {
   baseURL = cucumberConfig.baseURL;
 }
 
 const requestContextOptions = {
   baseURL: baseURL,
-  ignoreHTTPSErrors: true
+  ignoreHTTPSErrors: true,
 };
 
 async function invokeRequest() {

package/src/helper/executers/helper.js

@@ -21,6 +21,9 @@ function showHelp() {
       
             ✅ -y, --yes       Skip confirmation prompt for creating example project
                 Usage:  artes -c -y or artes --create --yes
+
+            🚫 --noDeps       Skip installing dependencies when creating example project
+                Usage:  artes -c --noDeps or artes --create --noDeps
       
             📊 -r, --report    Run tests and generate Allure report
                 Usage:   artes -r or artes --report

package/src/helper/executers/projectCreator.js

@@ -4,7 +4,7 @@ const fs = require("fs");
 const path = require("path");
 const { execSync } = require("child_process");
 
-function createProject(createYes) {
+function createProject(createYes, noDeps) {
   const projectDir = path.join(process.cwd(), "artes");
   const srcDir = path.join(projectDir, "tests");
 
@@ -16,13 +16,16 @@ function createProject(createYes) {
     path.join(projectDir, ".vscode"),
   ].forEach((dir) => fs.mkdirSync(dir, { recursive: true }));
 
-  
   console.log("🚀 Initializing project...");
-  execSync(`npm init ${createYes ? "-y" : ""}`, {cwd: projectDir,  stdio: "inherit" });
-  execSync("npm i artes", {cwd: projectDir, stdio: "inherit" });
+  execSync(`npm init ${createYes ? "-y" : ""}`, {
+    cwd: projectDir,
+    stdio: "inherit",
+  });
+
+  !noDeps ? execSync("npm i artes", { cwd: projectDir, stdio: "inherit" }) : "";
 
   console.log("📦 Setting up browsers...");
-  execSync("npx playwright install", {cwd: projectDir, stdio: "inherit" });
+  execSync("npx playwright install", { cwd: projectDir, stdio: "inherit" });
 
   const packageJsonPath = path.join(projectDir, "package.json");
   const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
@@ -128,7 +131,7 @@ await context.page.goto("https://www.saucedemo.com/");
 });
 `;
 
-const hooksContent = `
+  const hooksContent = `
 export function BeforeStep() {
   // hook for before each step
 }

package/src/helper/executers/reportGenerator.js

@@ -5,22 +5,37 @@ const { spawnSync } = require("child_process");
 const { moduleConfig } = require("../imports/commons");
 
 function generateReport() {
-  
   try {
     console.log("📊 Generating report...");
 
-    spawnSync("allure", [ "generate", "--clean", `${process.env.SINGLE_FILE_REPORT == "true" ? "--single-file" : "" }`, "allure-result",  "--output", moduleConfig.reportPath], {
-      cwd: moduleConfig.modulePath,
-      stdio: "ignore",
-      shell: true,
-    });
+    spawnSync(
+      "allure",
+      [
+        "generate",
+        "--clean",
+        `${process.env.SINGLE_FILE_REPORT == "true" ? "--single-file" : ""}`,
+        "allure-result",
+        "--output",
+        moduleConfig.reportPath,
+      ],
+      {
+        cwd: moduleConfig.modulePath,
+        stdio: "ignore",
+        shell: true,
+      },
+    );
 
-    console.log(`📋 Report generated successfully in ${moduleConfig.reportPath}!`);
+    console.log(
+      `📋 Report generated successfully in ${moduleConfig.reportPath}!`,
+    );
 
     if (fs.existsSync(moduleConfig.reportPath) && process.env.ZIP) {
       console.log(`🗜️ Zipping report folder`);
 
-      const zipPath = path.join(path.dirname(moduleConfig.reportPath), "report.zip");
+      const zipPath = path.join(
+        path.dirname(moduleConfig.reportPath),
+        "report.zip",
+      );
 
       let done = false;
       let error = null;
@@ -46,9 +61,10 @@ function generateReport() {
       console.log(`🗜️ Zipped in ${moduleConfig.reportPath}/report.zip!`);
       if (error) throw error;
     } else {
-      console.warn(`⚠️ Report folder does not exist: ${moduleConfig.reportPath}`);
+      console.warn(
+        `⚠️ Report folder does not exist: ${moduleConfig.reportPath}`,
+      );
     }
-
   } catch (err) {
     console.error("❌ Report generation failed:", err);
     process.env.EXIT_CODE = 1;

package/src/helper/imports/commons.js

@@ -34,7 +34,8 @@ const moduleConfig = {
   featuresPath: path.join(projectPath, "/tests/features/"),
   stepsPath: path.join(projectPath, "/tests/steps/*.js"),
   pomPath: path.join(projectPath, "/tests/POMs"),
-  cleanUpPaths: "allure-result allure-results test-results @rerun.txt testsStatus EXIT_CODE.txt",
+  cleanUpPaths:
+    "allure-result allure-results test-results @rerun.txt testsStatus EXIT_CODE.txt",
 };
 
 module.exports = {

package/src/helper/stepFunctions/APIActions.js

@@ -31,9 +31,8 @@ function getMimeType(filePath) {
 function processForm(requestBody) {
   let formData = {};
   for (const [key, value] of Object.entries(requestBody)) {
-    
     if (value === null || value === undefined) {
-      continue; 
+      continue;
     }
 
     if (typeof value === "object") {
@@ -360,4 +359,4 @@ const api = {
   },
 };
 
-module.exports = { api };
+module.exports = { api };

package/src/hooks/hooks.js

@@ -46,8 +46,10 @@ function saveTestStatus(result, pickle) {
   );
 }
 
-
-const projectHooksPath = path.resolve(moduleConfig.projectPath, "tests/steps/hooks.js");
+const projectHooksPath = path.resolve(
+  moduleConfig.projectPath,
+  "tests/steps/hooks.js",
+);
 
 let projectHooks = {};
 
@@ -72,7 +74,6 @@ BeforeAll(async () => {
 });
 
 Before(async function () {
-
   context.vars = {};
 
   const envFilePath = path.join(
@@ -223,7 +224,6 @@ After(async function ({ pickle, result }) {
       }
     }
   }
-
 });
 
 AfterAll(async () => {