regressify 1.0.28 → 1.0.29

package/.github/workflows/deploy.yml

@@ -5,11 +5,7 @@ on:
     branches:
       - release
     paths:
-      - .engine_scripts/**
-      - cli/**
-      - src/**
       - package.json
-      - cli.js
 
   workflow_dispatch:
 

package/cli/generate-tests.js

@@ -1,13 +1,14 @@
 import fs from 'fs';
 import path from 'path';
-import { fileURLToPath } from 'url';
 import pkg from 'ncp';
 import chalk from 'chalk';
+import { getLibraryPath } from './helpers';
+import slash from 'slash';
 
 const { ncp } = pkg;
 
-async function askUser() {
-  const sourceFolder = path.join(path.dirname(fileURLToPath(import.meta.url)), 'visual_tests');
+async function initVisualTestsFolder() {
+  const sourceFolder = slash(path.join(getLibraryPath(), 'visual_tests'));
   const destinationFolder = path.join(process.cwd(), 'visual_tests');
 
   if (!fs.existsSync(destinationFolder)) {
@@ -23,4 +24,4 @@ async function askUser() {
   }
 }
 
-askUser().catch((err) => console.error('Error:', err));
+initVisualTestsFolder().catch((err) => console.error('Error:', err));

package/cli/helpers.js

@@ -0,0 +1,8 @@
+import { dirname } from 'path';
+import slash from 'slash';
+import { fileURLToPath } from 'url';
+
+export function getLibraryPath() {
+  const fileName = fileURLToPath(import.meta.url);
+  return slash(dirname(dirname(fileName)));
+}

package/cli.js

@@ -4,12 +4,10 @@ import path, { dirname } from 'path';
 import { exec } from 'child_process';
 import { fileURLToPath, pathToFileURL } from 'url';
 import chalk from 'chalk';
+import { getLibraryPath } from './cli/helpers';
 import slash from 'slash';
 
-function getLibraryPath() {
-  const fileName = fileURLToPath(import.meta.url);
-  return slash(dirname(fileName));
-}
+const libraryPath = getLibraryPath();
 
 function runCommand(command) {
   const childProcess = exec(command, { env: { ...process.env, FORCE_COLOR: '1' } });
@@ -36,13 +34,10 @@ function runCommand(command) {
 const args = process.argv.slice(2);
 const command = args[0].toLowerCase();
 
-let commandBase = `node ${getLibraryPath()}/dist/index.js`;
+let commandBase = `node ${libraryPath}/dist/index.js`;
 
 if (command === 'init') {
-  const __filename = fileURLToPath(import.meta.url);
-  const __dirname = dirname(__filename);
-
-  const postInstallPath = pathToFileURL(path.join(__dirname, 'cli', 'generate-tests.js'));
+  const postInstallPath = slash(pathToFileURL(path.join(libraryPath, 'cli', 'generate-tests.js')));
   if (fs.existsSync(postInstallPath)) {
     console.log(chalk.yellow('Generate folder visual_tests ...'));
     await import(postInstallPath);
@@ -50,7 +45,7 @@ if (command === 'init') {
     console.log(chalk.red('generate-tests.js not found!'));
   }
 
-  const updatePackageJsonPath = pathToFileURL(path.join(__dirname, 'cli', 'update-package.js'));
+  const updatePackageJsonPath = slash(pathToFileURL(path.join(libraryPath, 'cli', 'update-package.js')));
   if (fs.existsSync(updatePackageJsonPath)) {
     console.log(chalk.yellow('Update package.json ...'));
     await import(updatePackageJsonPath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "regressify",
-  "version": "1.0.28",
+  "version": "1.0.29",
   "description": "Visual regression tests support",
   "main": "src/index.ts",
   "type": "module",

package/src/config.ts

@@ -3,16 +3,15 @@ import { Config, Scenario, ViewportNext } from 'backstopjs';
 import { createScenario } from './scenarios.js';
 import path from 'path';
 import { getFlagArg, getStringArg, parseDataFromFile, getLibraryPath } from './helpers.js';
-import { fileURLToPath } from 'url';
 import { TestSuiteModel, ScenarioModel } from './types.js';
 import chalk from 'chalk';
 import { exit } from 'process';
 import YAML from 'js-yaml';
 import { getTestUrl } from './replacements.js';
 
+const libraryPath = getLibraryPath();
 const engine: 'puppeteer' | 'playwright' = 'playwright';
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const testSuite = getStringArg('--test-suite');
 const isRef = getFlagArg('--ref');
 const globalRequiredLogin = getFlagArg('--requiredLogin');
@@ -23,7 +22,7 @@ if (globalRequiredLogin) {
 const scenarios: Scenario[] = [];
 
 const getScriptPath = (scriptPath: string, engine: 'puppeteer' | 'playwright') => {
-  return path.join(__dirname, '..', '.engine_scripts', (engine == 'puppeteer' ? 'puppet' : 'playwright') + scriptPath);
+  return path.join(libraryPath, '.engine_scripts', (engine == 'puppeteer' ? 'puppet' : 'playwright') + scriptPath);
 };
 
 if (!testSuite) {

package/src/replacements.ts

@@ -2,15 +2,15 @@ import fs from 'fs';
 import path from 'path';
 import { ReplacementModel, ReplacementsModel } from './types';
 import YAML from 'js-yaml';
-import { getStringArg } from './helpers.js';
-import { fileURLToPath } from 'url';
+import { getLibraryPath, getStringArg } from './helpers.js';
+import slash from 'slash';
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const libraryPath = getLibraryPath();
 
 const getReplacementProfile = (): ReplacementModel[] | undefined => {
   const replacementProfileName = getStringArg('replacement-profile') ?? process.env.REPLACEMENT_PROFILE;
   if (!!replacementProfileName) {
-    const replacementProfilePath = path.resolve(__dirname, '../visual_tests/_replacement-profiles.yaml');
+    const replacementProfilePath = slash(path.join(libraryPath, 'visual_tests', '_replacement-profiles.yaml'));
     if (!fs.existsSync(replacementProfilePath)) {
       throw "Replacement profile doesn't exist: " + replacementProfilePath;
     }