chore: run autofix

Signed-off-by: Jakub Freisler <[email protected]>

Author: FRSgit

src/afterScreenshot.hook.ts

@@ -5,8 +5,12 @@ import { IMAGE_SNAPSHOT_PREFIX, PATH_VARIABLES } from "./constants";
 
 type NotFalsy<T> = T extends false | null | undefined ? never : T;
 
-const MIMIC_ROOT_WIN_REGEX = new RegExp(`^${PATH_VARIABLES.winSystemRootPath}\\${path.sep}([A-Z])\\${path.sep}`);
-const MIMIC_ROOT_UNIX_REGEX = new RegExp(`^${PATH_VARIABLES.unixSystemRootPath}\\${path.sep}`);
+const MIMIC_ROOT_WIN_REGEX = new RegExp(
+  `^${PATH_VARIABLES.winSystemRootPath}\\${path.sep}([A-Z])\\${path.sep}`
+);
+const MIMIC_ROOT_UNIX_REGEX = new RegExp(
+  `^${PATH_VARIABLES.unixSystemRootPath}\\${path.sep}`
+);
 
 const getConfigVariableOrThrow = <K extends keyof Cypress.PluginConfigOptions>(
   config: Cypress.PluginConfigOptions,
@@ -22,29 +26,36 @@ const getConfigVariableOrThrow = <K extends keyof Cypress.PluginConfigOptions>(
 /* c8 ignore stop */
 
 const parseAbsolutePath = ({
-  screenshotPath, projectRoot,
+  screenshotPath,
+  projectRoot,
 }: {
-  screenshotPath: string; projectRoot: string;
+  screenshotPath: string;
+  projectRoot: string;
 }) => {
   let newAbsolutePath: string;
   const matchedMimicingWinRoot = screenshotPath.match(MIMIC_ROOT_WIN_REGEX);
   const matchedMimicingUnixRoot = screenshotPath.match(MIMIC_ROOT_UNIX_REGEX);
   if (matchedMimicingWinRoot && matchedMimicingWinRoot[1]) {
     const driveLetter = matchedMimicingWinRoot[1];
-    newAbsolutePath = path.join(`${driveLetter}:\\`, screenshotPath.substring(matchedMimicingWinRoot[0].length));
+    newAbsolutePath = path.join(
+      `${driveLetter}:\\`,
+      screenshotPath.substring(matchedMimicingWinRoot[0].length)
+    );
   } else if (matchedMimicingUnixRoot) {
-    newAbsolutePath = path.sep + screenshotPath.substring(matchedMimicingUnixRoot[0].length);
+    newAbsolutePath =
+      path.sep + screenshotPath.substring(matchedMimicingUnixRoot[0].length);
   } else {
     newAbsolutePath = path.join(projectRoot, screenshotPath);
   }
   return path.normalize(newAbsolutePath);
-}
+};
 
 export const initAfterScreenshotHook =
   (config: Cypress.PluginConfigOptions) =>
   (
     details: Cypress.ScreenshotDetails
-  ): void
+  ):
+    | void
     | Cypress.AfterScreenshotReturnObject
     | Promise<Cypress.AfterScreenshotReturnObject> => {
     // it's not a screenshot generated by FRSOURCE Cypress Plugin Visual Regression Diff
@@ -55,23 +66,21 @@ export const initAfterScreenshotHook =
       config,
       "screenshotsFolder"
     );
+    const screenshotPath = details.name.substring(
+      IMAGE_SNAPSHOT_PREFIX.length + path.sep.length
+    );
+    const newAbsolutePath = parseAbsolutePath({
+      screenshotPath,
+      projectRoot: config.projectRoot,
+    });
 
-    return new Promise(async (resolve, reject) => {
-      const screenshotPath = details.name.substring(
-        IMAGE_SNAPSHOT_PREFIX.length + path.sep.length
-      );
-      const newAbsolutePath = parseAbsolutePath({ screenshotPath, projectRoot: config.projectRoot });
-
-      try {
-        await moveFile(details.path, newAbsolutePath);
-        await fs.rm(
-          path.join(screenshotsFolder, IMAGE_SNAPSHOT_PREFIX),
-          { recursive: true, force: true },
-        );
+    return (async () => {
+      await moveFile(details.path, newAbsolutePath);
+      await fs.rm(path.join(screenshotsFolder, IMAGE_SNAPSHOT_PREFIX), {
+        recursive: true,
+        force: true,
+      });
 
-        resolve({ path: newAbsolutePath });
-      } catch(e) {
-        reject(e);
-      }
-    });
+      return { path: newAbsolutePath };
+    })();
   };

src/commands.ts

@@ -40,14 +40,24 @@ const constructCypressError = (log: Cypress.Log, err: Error) => {
   return err;
 };
 
-export const getConfig = (options: Cypress.MatchImageOptions) => {
-  const imagesDir = options.imagesDir || Cypress.env("pluginVisualRegressionImagesDir") as string | undefined;
+const getImagesDir = (options: Cypress.MatchImageOptions) => {
+  const imagesDir =
+    options.imagesDir ||
+    (Cypress.env("pluginVisualRegressionImagesDir") as string | undefined);
 
   // TODO: remove in 4.0.0
   if (imagesDir) {
-    console.warn('@frsource/cypress-plugin-visual-regression-diff] `imagesDir` option is deprecated, use `imagesPath` instead (https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff#configuration)');
+    console.warn(
+      "@frsource/cypress-plugin-visual-regression-diff] `imagesDir` option is deprecated, use `imagesPath` instead (https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff#configuration)"
+    );
   }
 
+  return imagesDir;
+};
+
+export const getConfig = (options: Cypress.MatchImageOptions) => {
+  const imagesDir = getImagesDir(options);
+
   return {
     scaleFactor:
       Cypress.env("pluginVisualRegressionForceDeviceScaleFactor") === false
@@ -60,7 +70,7 @@ export const getConfig = (options: Cypress.MatchImageOptions) => {
         | undefined) ||
       false,
     imagesPath:
-      imagesDir && `{spec_path}/${imagesDir}` ||
+      (imagesDir && `{spec_path}/${imagesDir}`) ||
       options.imagesPath ||
       (Cypress.env("pluginVisualRegressionImagesPath") as string | undefined) ||
       "{spec_path}/__image_snapshots__",
@@ -83,7 +93,7 @@ export const getConfig = (options: Cypress.MatchImageOptions) => {
         | undefined) ||
       {},
   };
-}
+};
 
 Cypress.Commands.add(
   "matchImage",

src/constants.ts

@@ -17,9 +17,9 @@ export const TASK = {
 };
 
 export const PATH_VARIABLES = {
-  specPath: '{spec_path}',
-  unixSystemRootPath: '{unix_system_root_path}',
-  winSystemRootPath: '{win_system_root_path}',
+  specPath: "{spec_path}",
+  unixSystemRootPath: "{unix_system_root_path}",
+  winSystemRootPath: "{win_system_root_path}",
 };
 
 export const WINDOWS_LIKE_DRIVE_REGEX = /^[A-Z]:$/;

src/task.hook.ts

@@ -4,7 +4,13 @@ import { PNG } from "pngjs";
 import pixelmatch, { PixelmatchOptions } from "pixelmatch";
 import moveFile from "move-file";
 import sanitize from "sanitize-filename";
-import { FILE_SUFFIX, IMAGE_SNAPSHOT_PREFIX, TASK, PATH_VARIABLES, WINDOWS_LIKE_DRIVE_REGEX } from "./constants";
+import {
+  FILE_SUFFIX,
+  IMAGE_SNAPSHOT_PREFIX,
+  TASK,
+  PATH_VARIABLES,
+  WINDOWS_LIKE_DRIVE_REGEX,
+} from "./constants";
 import { alignImagesToSameSize, importAndScaleImage } from "./image.utils";
 import type { CompareImagesTaskReturn } from "./types";
 
@@ -53,7 +59,7 @@ export const getScreenshotPathTask = ({
     ...imagesPath.split("/").map(parsePathPartVariables),
     `${sanitize(title)}${FILE_SUFFIX.actual}.png`
   );
-}
+};
 
 export const approveImageTask = ({ img }: { img: string }) => {
   const oldImg = img.replace(FILE_SUFFIX.actual, "");