add more options for upload command

Author: parthlambdatest

src/commander/upload.ts

@@ -16,6 +16,13 @@ command
     .description('Upload screenshots from given directory')
     .argument('<directory>', 'Path of the directory')
     .option('-R, --ignoreResolutions', 'Ignore resolution')
+    .option('-F, --files <extensions>', 'Comma-separated list of allowed file extensions', val => {
+        return val.split(',').map(ext => ext.trim().toLowerCase());
+    })
+    .option('-E, --ignoreStripExtensions', 'Strips file extensions from snapshot names')
+    .option('-i, --ignorePattern <patterns>', 'Comma-separated list of directories to ignore', val => {
+        return val.split(',').map(pattern => pattern.trim());
+    })
     .action(async function(directory, _, command) {
         let ctx: Context = ctxInit(command.optsWithGlobals());
 

src/lib/ctx.ts

@@ -14,7 +14,9 @@ export default (options: Record<string, string>): Context => {
     let config = constants.DEFAULT_CONFIG;
     let port: number;
     let resolutionOff: boolean;
-
+    let extensionFiles: string;
+    let ignoreStripExtension: Array<string>;
+    let ignoreFilePattern: Array<string>;
     try {
         if (options.config) {
             config = JSON.parse(fs.readFileSync(options.config, 'utf-8'));
@@ -35,6 +37,9 @@ export default (options: Record<string, string>): Context => {
             throw new Error('Invalid port number. Port number must be an integer between 1 and 65535.');
         }
         resolutionOff = options.ignoreResolutions || false;
+        extensionFiles = options.files || ['png', 'jpeg', 'jpg'];
+        ignoreStripExtension = options.ignoreStripExtensions || false
+        ignoreFilePattern = options.ignorePattern || []
     } catch (error: any) {
         console.log(`[smartui] Error: ${error.message}`);
         process.exit();
@@ -85,7 +90,10 @@ export default (options: Record<string, string>): Context => {
             markBaseline: options.markBaseline ? true : false,
             buildName: options.buildName || '',
             port: port,
-            ignoreResolutions: resolutionOff
+            ignoreResolutions: resolutionOff,
+            fileExtension: extensionFiles,
+            stripExtension: ignoreStripExtension,
+            ignorePattern: ignoreFilePattern,
         },
         cliVersion: version,
         totalSnapshots: -1

src/lib/screenshot.ts

@@ -1,6 +1,5 @@
 import fs from 'fs';
 import path from 'path';
-import sizeOf from 'image-size';
 import { Browser, BrowserContext, Page } from "@playwright/test"
 import { Context } from "../types.js"
 import * as utils from "./utils.js"
@@ -167,30 +166,47 @@ function getImageDimensions(filePath: string): { width: number, height: number }
 }
 
 export async function uploadScreenshots(ctx: Context): Promise<void> {
-    let screenshotsDir = ctx.uploadFilePath;
+    const allowedExtensions = ctx.options.fileExtension.map(ext => `.${ext.trim().toLowerCase()}`);
 
-    // Read all files in the screenshots directory
-    const files = fs.readdirSync(screenshotsDir);
+    async function processDirectory(directory: string, relativePath: string = ''): Promise<void> {
+        const files = fs.readdirSync(directory);
 
-    for (let file of files) {
-        let fileExtension = path.extname(file).toLowerCase();
-        if (fileExtension === '.png' || fileExtension === '.jpeg' || fileExtension === '.jpg') {
-            let filePath = `${screenshotsDir}/${file}`;
-            let ssId = path.basename(file, fileExtension);
+        for (let file of files) {
+            const filePath = path.join(directory, file);
+            const stat = fs.statSync(filePath);
+            const relativeFilePath = path.join(relativePath, file);
 
-            let viewport = 'default'
+            if (stat.isDirectory() && ctx.options.ignorePattern.includes(relativeFilePath)) {
+                continue; // Skip this path
+            }
 
-            if(!ctx.options.ignoreResolutions){
-                const dimensions = getImageDimensions(filePath);
-                if (!dimensions) {
-                    throw new Error(`Unable to determine dimensions for image: ${filePath}`);
+            if (stat.isDirectory()) {
+                await processDirectory(filePath, relativeFilePath); // Recursively process subdirectory
+            } else {
+                let fileExtension = path.extname(file).toLowerCase();
+                if (allowedExtensions.includes(fileExtension)) {
+                    let ssId = relativeFilePath;
+                    if (ctx.options.stripExtension) {
+                        ssId = path.join(relativePath, path.basename(file, fileExtension));
+                    }
+
+                    let viewport = 'default';
+
+                    if (!ctx.options.ignoreResolutions) {
+                        const dimensions = getImageDimensions(filePath);
+                        if (!dimensions) {
+                            throw new Error(`Unable to determine dimensions for image: ${filePath}`);
+                        }
+                        const width = dimensions.width;
+                        const height = dimensions.height;
+                        viewport = `${width}x${height}`;
+                    }
+
+                    await ctx.client.uploadScreenshot(ctx.build, filePath, ssId, 'default', viewport, ctx.log);
                 }
-                const width = dimensions.width;
-                const height = dimensions.height;
-                viewport = `${width}x${height}`;
             }
-
-            await ctx.client.uploadScreenshot(ctx.build, filePath, ssId, 'default', viewport, ctx.log);
         }
     }
+
+    await processDirectory(ctx.uploadFilePath);
 }

src/types.ts

@@ -33,6 +33,9 @@ export interface Context {
         buildName?: string,
         port?: number,
         ignoreResolutions?: boolean,
+        fileExtension?: Array<string>,
+        stripExtension?: boolean,
+        ignorePattern?: Array<string>,
     }
     cliVersion: string;
     totalSnapshots: number;