Merge pull request #109 from parthlambdatest/Dot-6103

[Dot-6103] feat: add support for `exclude` in custom viewport

Author: sushobhit-lt

commands/storybook.js

@@ -45,6 +45,7 @@ async function storybook(serve, options) {
                     process.exit(constants.ERROR_CATCHALL);
                 }
                 console.log('[smartui] Stories found: ', Object.keys(stories).length);
+                console.log('[smartui] Number of stories rendered may differ based on the config file.');
 
                 // Capture DoM of every story and send it to renderer API
                 await sendDoM(url, stories, storybookConfig, options);

commands/utils/static.js

@@ -72,6 +72,7 @@ function filterStories(dirPath, storybookConfig) {
 		process.exit(constants.ERROR_CATCHALL);
 	}
 	console.log('[smartui] Stories found: ', storyIds.length);
+	console.log('[smartui] Number of stories rendered may differ based on the config file.');
 
 	return storyIds
 }

commands/utils/validate.js

@@ -128,10 +128,19 @@ function validateConfig(configFile) {
 
     try {
         validateConfigBrowsers(storybookConfig.browsers);
-        resolutions = storybookConfig.resolutions || storybookConfig.viewports
-        storybookConfig.resolutions = validateConfigResolutions(resolutions);
+        let resolutions = storybookConfig.resolutions || storybookConfig.viewports
+        if (resolutions) {
+            storybookConfig.resolutions = validateConfigResolutions(resolutions);
+        }
         storybookConfig.viewports = storybookConfig.resolutions;
-        validateCustomViewPorts(storybookConfig.customViewports)
+        let customViewports = storybookConfig.customViewports;
+        if (customViewports && customViewports.length > 0) {
+            validateCustomViewPorts(storybookConfig.customViewports)
+        }
+        if (!resolutions && (!customViewports || customViewports.length === 0)) {
+            console.log('[smartui] Error: No resolutions or customViewports found in config file');
+            process.exit(constants.ERROR_CATCHALL);
+        }
     } catch (error) {
         console.log(`[smartui] Error: Invalid config, ${error.message}`);
         process.exit(constants.ERROR_CATCHALL);
@@ -210,7 +219,7 @@ function validateConfigResolutions(resolutions) {
         if (width && width < MIN_RESOLUTION_WIDTH || width > MAX_RESOLUTION_WIDTH) {
             throw new ValidationError(`width must be > ${MIN_RESOLUTION_WIDTH}, < ${MAX_RESOLUTION_WIDTH}`);
         }
-        if (height & (height < MIN_RESOLUTION_WIDTH || height > MAX_RESOLUTION_WIDTH)) {
+        if (height && (height < MIN_RESOLUTION_HEIGHT|| height > MAX_RESOLUTION_HEIGHT)) {
             throw new ValidationError(`height must be > ${MIN_RESOLUTION_HEIGHT}, < ${MAX_RESOLUTION_HEIGHT}`);
         }
         res.push([width, height || 0]);
@@ -228,8 +237,8 @@ function validateCustomViewPorts(customViewports) {
         return
     }
     customViewports.forEach(element => {
-        if (!Array.isArray(element.stories) || element.stories == 0) {
-            throw new ValidationError('Missing `stories` in customViewports config. please check the config file');
+        if (element.stories && element.stories.length !== 0 && element.exclude && element.exclude.length !== 0) {
+            throw new ValidationError('Cannot specify both stories and excludeStories in customViewports');
         }
         if (element.styles) {
             if (!element.styles?.width) {
@@ -246,7 +255,7 @@ function validateCustomViewPorts(customViewports) {
             if (width && width < MIN_RESOLUTION_WIDTH || width > MAX_RESOLUTION_WIDTH) {
                 throw new ValidationError(`customViewports.styles width must be > ${MIN_RESOLUTION_WIDTH}, < ${MAX_RESOLUTION_WIDTH}`);
             }
-            if (height & (height < MIN_RESOLUTION_WIDTH || height > MAX_RESOLUTION_WIDTH)) {
+            if (height && (height < MIN_RESOLUTION_HEIGHT || height > MAX_RESOLUTION_HEIGHT)) {
                 throw new ValidationError(`customViewports.styles height must be > ${MIN_RESOLUTION_HEIGHT}, < ${MAX_RESOLUTION_HEIGHT}`);
             }
             element.styles.width = width;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-storybook",
-  "version": "1.1.24",
+  "version": "1.1.25",
   "description": "LambdaTest's command-line interface (CLI) aimed to help you run your SmartUI tests on LambdaTest platform",
   "main": "index.js",
   "repository": {