@bigcommerce/stencil-cli 8.3.0 → 8.4.0

package/lib/StencilConfigManager.js

@@ -1,9 +1,8 @@
-require('colors');
-const fsModule = require('fs');
-const path = require('path');
-
-const fsUtilsModule = require('./utils/fsUtils');
-const { THEME_PATH, API_HOST } = require('../constants');
+import 'colors';
+import fsModule from 'fs';
+import path from 'path';
+import fsUtilsModule from './utils/fsUtils.js';
+import { THEME_PATH, API_HOST } from '../constants.js';
 
 class StencilConfigManager {
     constructor({
@@ -15,13 +14,11 @@ class StencilConfigManager {
         this.oldConfigFileName = '.stencil';
         this.configFileName = 'config.stencil.json';
         this.secretsFileName = 'secrets.stencil.json';
-
         this.themePath = themePath;
         this.oldConfigPath = path.join(themePath, this.oldConfigFileName);
         this.configPath = path.join(themePath, this.configFileName);
         this.secretsPath = path.join(themePath, this.secretsFileName);
         this.secretFieldsSet = new Set(['accessToken', 'githubToken']);
-
         this._fs = fs;
         this._fsUtils = fsUtils;
         this._logger = logger;
@@ -46,21 +43,17 @@ class StencilConfigManager {
             await this._migrateOldConfig(parsedConfig);
             return this._validateStencilConfig(parsedConfig, ignoreMissingFields);
         }
-
         const generalConfig = this._fs.existsSync(this.configPath)
             ? await this._fsUtils.parseJsonFile(this.configPath)
             : null;
         const secretsConfig = await this._getSecretsConfig(generalConfig);
-
         if (generalConfig || secretsConfig) {
             const parsedConfig = { ...generalConfig, ...secretsConfig };
             return this._validateStencilConfig(parsedConfig, ignoreMissingFields);
         }
-
         if (ignoreFileNotExists) {
             return null;
         }
-
         throw new Error('Please run'.red + ' $ stencil init'.cyan + ' first.'.red);
     }
 
@@ -69,7 +62,6 @@ class StencilConfigManager {
      */
     async save(config) {
         const { generalConfig, secretsConfig } = this._splitStencilConfig(config);
-
         await this._fs.promises.writeFile(this.configPath, JSON.stringify(generalConfig, null, 2));
         await this._fs.promises.writeFile(this.secretsPath, JSON.stringify(secretsConfig, null, 2));
     }
@@ -100,12 +92,10 @@ class StencilConfigManager {
     async _getSecretsConfig(generalConfig) {
         if (generalConfig && generalConfig.secretsFileName) {
             const secretsPath = path.join(this.themePath, generalConfig.secretsFileName);
-
             if (this._fs.existsSync(secretsPath)) {
                 return this._fsUtils.parseJsonFile(secretsPath);
             }
         }
-
         return this._fs.existsSync(this.secretsPath)
             ? this._fsUtils.parseJsonFile(this.secretsPath)
             : null;
@@ -119,7 +109,6 @@ class StencilConfigManager {
      */
     _validateStencilConfig(configFile, ignoreMissingFields) {
         const config = configFile;
-
         if (!ignoreMissingFields && (!config.normalStoreUrl || !config.customLayouts)) {
             throw new Error(
                 'Error: Your stencil config is outdated. Please run'.red +
@@ -127,13 +116,11 @@ class StencilConfigManager {
                     ' again.'.red,
             );
         }
-
         if (!config.apiHost) {
             config.apiHost = API_HOST;
         } else {
             this._logger.log(`API host set in config file: ${config.apiHost}`);
         }
-
         return config;
     }
 
@@ -146,10 +133,8 @@ class StencilConfigManager {
             `Detected a deprecated ${this.oldConfigFileName.cyan} file.\n` +
                 `It will be replaced with ${this.configFileName.cyan} and ${this.secretsFileName.cyan}\n`,
         );
-
         await this.save(config);
         await this._fs.promises.unlink(this.oldConfigPath);
-
         this._logger.log(
             `The deprecated ${this.oldConfigFileName.cyan} file was successfully replaced.\n` +
                 `Make sure to add ${this.secretsFileName.cyan} to .gitignore.\n` +
@@ -157,5 +142,4 @@ class StencilConfigManager {
         );
     }
 }
-
-module.exports = StencilConfigManager;
+export default StencilConfigManager;

package/lib/StencilDebug.js

@@ -1,10 +1,9 @@
-const fsModule = require('fs');
-const path = require('path');
-const osModule = require('os');
-
-const { PACKAGE_INFO, THEME_PATH } = require('../constants');
-const ThemeConfig = require('./theme-config');
-const StencilConfigManager = require('./StencilConfigManager');
+import fsModule from 'fs';
+import path from 'path';
+import osModule from 'os';
+import { PACKAGE_INFO, THEME_PATH } from '../constants.js';
+import ThemeConfig from './theme-config.js';
+import StencilConfigManager from './StencilConfigManager.js';
 
 class StencilDebug {
     constructor({
@@ -55,7 +54,6 @@ class StencilDebug {
 
     async getThemeInfo() {
         this.checkExecutableLocation(this._themeConfig);
-
         const rawConfig = await this._themeConfig.getRawConfig();
         const {
             name,
@@ -109,5 +107,4 @@ class StencilDebug {
         }
     }
 }
-
-module.exports = StencilDebug;
+export default StencilDebug;

package/lib/archiveManager.js

@@ -1,15 +1,10 @@
-/**
- * @module Contains functions for working with archives
- */
-
-const yauzl = require('yauzl');
-const fs = require('fs');
-const path = require('path');
-const { promisify } = require('util');
-const stream = require('stream');
+import yauzl from 'yauzl';
+import fs from 'fs';
+import path from 'path';
+import { promisify } from 'util';
+import stream from 'stream';
 
 const pipeline = promisify(stream.pipeline);
-
 /**
  * @param {object}   options
  * @param {string}   options.zipPath
@@ -20,9 +15,7 @@ const pipeline = promisify(stream.pipeline);
  */
 async function extractZipFiles({ zipPath, fileToExtract, exclude = [], outputNames = {} }) {
     let foundMatch = false;
-
     const zipFile = await promisify(yauzl.open)(zipPath, { lazyEntries: true });
-
     await new Promise((resolve, reject) => {
         zipFile.on('entry', async (entry) => {
             try {
@@ -33,50 +26,41 @@ async function extractZipFiles({ zipPath, fileToExtract, exclude = [], outputNam
                     exclude.length &&
                     // startsWith used to exclude files from the specified directories
                     exclude.some((excludeItem) => entry.fileName.startsWith(excludeItem));
-
                 if (isDirectory || isNotTheSearchedFile || isExcluded) {
                     zipFile.readEntry();
                     return;
                 }
-
                 const outputFilePath = outputNames[entry.fileName] || entry.fileName;
                 const outputDir = path.parse(outputFilePath).dir;
                 // Create a directory if the parent directory does not exists
                 if (outputDir && !fs.existsSync(outputDir)) {
                     await fs.promises.mkdir(outputDir, { recursive: true });
                 }
-
                 const readableStream = await promisify(zipFile.openReadStream.bind(zipFile))(entry);
                 const writeStream = fs.createWriteStream(outputFilePath, { flag: 'w+' });
                 await pipeline(readableStream, writeStream);
-
                 if (foundMatch) {
                     zipFile.close();
                     resolve();
                     return;
                 }
-
                 zipFile.readEntry();
             } catch (err) {
                 reject(err);
             }
         });
-
         zipFile.readEntry();
-
         zipFile.once('end', () => {
             zipFile.close();
-
             if (!foundMatch && fileToExtract) {
                 reject(new Error(`${fileToExtract} not found`));
                 return;
             }
-
             resolve();
         });
     });
 }
-
-module.exports = {
+export { extractZipFiles };
+export default {
     extractZipFiles,
 };

package/lib/bundle-validator.js

@@ -1,21 +1,17 @@
-require('colors');
-const os = require('os');
-const _ = require('lodash');
-const async = require('async');
-const fs = require('fs');
-const sizeOf = require('image-size');
-const path = require('path');
-const Validator = require('ajv');
-const yamlValidator = require('js-yaml');
-
-const { recursiveReadDir } = require('./utils/fsUtils');
-const { getFrontmatterContent, interpolateThemeSettings } = require('./utils/frontmatter');
-const ValidatorSchemaTranslations = require('./validator/schema-translations');
-const privateThemeConfigValidationSchema = require('./schemas/privateThemeConfig.json');
-const themeConfigValidationSchema = require('./schemas/themeConfig.json');
-const themeValidationSchema = require('./schemas/themeSchema.json');
-const ScssValidator = require('./ScssValidator');
-const LangHelpersValidator = require('./lang/validator');
+import 'colors';
+import os from 'os';
+import { isObject, isArray, difference, uniq, flatten, every } from 'lodash-es';
+import async from 'async';
+import fs from 'fs';
+import sizeOf from 'image-size';
+import path from 'path';
+import Validator from 'ajv';
+import yamlValidator from 'js-yaml';
+import { recursiveReadDir } from './utils/fsUtils.js';
+import { getFrontmatterContent, interpolateThemeSettings } from './utils/frontmatter.js';
+import ValidatorSchemaTranslations from './validator/schema-translations.js';
+import ScssValidator from './ScssValidator.js';
+import LangHelpersValidator from './lang/validator.js';
 
 const VALID_IMAGE_TYPES = ['.jpg', '.jpeg', '.png', '.gif'];
 const WIDTH_COMPOSED = 600;
@@ -28,6 +24,15 @@ const MAX_SIZE_COMPOSED = 1024 * 1024 * 2; // 2MB
 const MAX_SIZE_MOBILE = 1024 * 1024; // 1MB
 const MAX_SIZE_DESKTOP = 1024 * 1024 * 5; // 5MB
 
+const privateThemeConfigUrl = new URL('./schemas/privateThemeConfig.json', import.meta.url);
+const privateThemeConfigValidationSchema = JSON.parse(fs.readFileSync(privateThemeConfigUrl));
+
+const themeConfigValidationSchemaUrl = new URL('./schemas/themeConfig.json', import.meta.url);
+const themeConfigValidationSchema = JSON.parse(fs.readFileSync(themeConfigValidationSchemaUrl));
+
+const themeValidationSchemaUrl = new URL('./schemas/themeSchema.json', import.meta.url);
+const themeValidationSchema = JSON.parse(fs.readFileSync(themeValidationSchemaUrl));
+
 class BundleValidator {
     /**
      * Run some validations to ensure that the platform will accept the theme
@@ -44,7 +49,6 @@ class BundleValidator {
         this.jsonSchemaValidatorOptions = { schemaId: 'auto', allErrors: true };
         this.scssValidator = new ScssValidator(themePath, themeConfig);
         this.langHelpersValidator = new LangHelpersValidator(themePath, themeConfig);
-
         // Array of tasks used in async.series
         this.validationTasks = [
             this._validateThemeConfiguration.bind(this),
@@ -54,7 +58,6 @@ class BundleValidator {
             this._validateCssFiles.bind(this),
             this._validateLangFiles.bind(this),
         ];
-
         if (!this.isPrivate) {
             this.validationTasks.push(this._validateMetaImages.bind(this));
         }
@@ -87,10 +90,8 @@ class BundleValidator {
                                 new RegExp(`{+\\s*${element}\\s*}+`),
                             ) !== -1,
                     );
-
                     validated.push(...matches);
                 }
-
                 cb(null, validated);
             },
             (err, validationRes) => {
@@ -98,18 +99,13 @@ class BundleValidator {
                     callback(err);
                     return;
                 }
-
-                const results = _.difference(
-                    this.objectsToValidate,
-                    _.uniq(_.flatten(validationRes)),
-                );
+                const results = difference(this.objectsToValidate, uniq(flatten(validationRes)));
                 if (results.length !== 0) {
                     callback(
                         new Error(`Missing required objects/properties: ${results.join('\n')}`),
                     );
                     return;
                 }
-
                 callback(null, !!results);
             },
         );
@@ -134,7 +130,6 @@ class BundleValidator {
             const rawSchema = await this.themeConfig.getRawSchema();
             this._validateJsonSchema('schema', themeValidationSchema, rawSchema);
         }
-
         return true;
     }
 
@@ -151,17 +146,14 @@ class BundleValidator {
                 ' file in your top level theme directory.';
             throw new Error(errMsg);
         }
-
         if (!this.isPrivate && !this.themeConfig.schemaExists()) {
             console.log("Warning: Your theme is missing a 'schema.json' file.".orange);
         }
-
         // Validate against the theme registry config schema
         const validationSchema = this.isPrivate
             ? privateThemeConfigValidationSchema
             : themeConfigValidationSchema;
         const rawConfig = await this.themeConfig.getRawConfig();
-
         return this._validateJsonSchema('config', validationSchema, rawConfig);
     }
 
@@ -175,7 +167,6 @@ class BundleValidator {
     _validateJsonSchema(type, schema, data) {
         const validator = new Validator(this.jsonSchemaValidatorOptions);
         validator.validate(schema, data);
-
         if (validator.errors && validator.errors.length > 0) {
             let errorMessage = `Your theme's ${type}.json has errors:`;
             for (const error of validator.errors) {
@@ -183,7 +174,6 @@ class BundleValidator {
             }
             throw new Error(errorMessage.red);
         }
-
         return true;
     }
 
@@ -195,11 +185,9 @@ class BundleValidator {
     async _validateSchemaTranslations() {
         const validatorSchemaTranslations = new ValidatorSchemaTranslations();
         const validator = new Validator(this.jsonSchemaValidatorOptions);
-
         if (this.themeConfig.schemaExists()) {
             validatorSchemaTranslations.setSchema(await this.themeConfig.getRawSchema());
         }
-
         if (this.themeConfig.schemaTranslationsExists()) {
             try {
                 const rawSchemaTranslations = await this.themeConfig.getRawSchemaTranslations();
@@ -210,38 +198,31 @@ class BundleValidator {
         } else if (validatorSchemaTranslations.getSchemaKeys().length) {
             throw new Error('Missed schemaTranslations.json file'.red);
         }
-
         const missedKeys = validatorSchemaTranslations.findMissedKeys();
         const unusedKeys = validatorSchemaTranslations.findUnusedKeys();
         validator.validate(
             validatorSchemaTranslations.getValidationSchema(),
             validatorSchemaTranslations.getTranslations(),
         );
-
         if (
             (validator.errors && validator.errors.length) ||
             missedKeys.length ||
             unusedKeys.length
         ) {
             let errorMessage = "Your theme's schemaTranslations.json has errors:";
-
             missedKeys.forEach((key) => {
                 errorMessage += `\r\nmissing translation key "${key}"`;
             });
-
             unusedKeys.forEach((key) => {
                 errorMessage += `\r\nunused translation key "${key}"`;
             });
-
             if (validator.errors && validator.errors.length) {
                 validator.errors.forEach((error) => {
                     errorMessage += `\r\nschemaTranslations${error.message}`;
                 });
             }
-
             throw new Error(errorMessage.red);
         }
-
         return true;
     }
 
@@ -254,7 +235,6 @@ class BundleValidator {
         const { meta, variations } = await this.themeConfig.getConfig();
         const composedImagePath = path.resolve(this.themePath, 'meta', meta.composed_image);
         const imageTasks = [];
-
         if (!this._isValidImageType(composedImagePath)) {
             throw new Error(
                 'Invalid file type for "meta.composed_image".'.red +
@@ -269,16 +249,13 @@ class BundleValidator {
         imageTasks.push((cb) =>
             this._validateImage(composedImagePath, WIDTH_COMPOSED, HEIGHT_COMPOSED, cb),
         );
-
         for (const variation of variations) {
             const id = variation.id.blue;
-
             const desktopScreenshotPath = path.resolve(
                 this.themePath,
                 'meta',
                 variation.meta.desktop_screenshot,
             );
-
             if (!this._isValidImageType(desktopScreenshotPath)) {
                 throw new Error(
                     `Invalid file type for ${id} variation's "desktop_screenshot".`.red +
@@ -293,13 +270,11 @@ class BundleValidator {
             imageTasks.push((cb) =>
                 this._validateImage(desktopScreenshotPath, WIDTH_DESKTOP, HEIGHT_DESKTOP, cb),
             );
-
             const mobileScreenshotPath = path.resolve(
                 this.themePath,
                 'meta',
                 variation.meta.mobile_screenshot,
             );
-
             if (!this._isValidImageType(mobileScreenshotPath)) {
                 throw new Error(
                     `Invalid file type for ${id} variation's "mobile_screenshot".`.red +
@@ -315,7 +290,6 @@ class BundleValidator {
                 this._validateImage(mobileScreenshotPath, WIDTH_MOBILE, HEIGHT_MOBILE, cb),
             );
         }
-
         return async.parallel(imageTasks);
     }
 
@@ -342,12 +316,10 @@ class BundleValidator {
                 cb(err);
                 return;
             }
-
             let failureMessage = '';
             const imageHeight = dimensions.height;
             const imageWidth = dimensions.width;
             const { size } = fs.statSync(imagePath);
-
             if (width === WIDTH_DESKTOP && height === HEIGHT_DESKTOP && size > MAX_SIZE_DESKTOP) {
                 failureMessage =
                     `Image of size ${size} bytes at path (${imagePath}) ` +
@@ -369,7 +341,6 @@ class BundleValidator {
                     `Image of size ${size} bytes at path (${imagePath}) ` +
                     `is greater than allowed size ${MAX_SIZE_MOBILE}\n`;
             }
-
             if (imageWidth !== width || imageHeight !== height) {
                 failureMessage +=
                     `Image at (${imagePath}) has incorrect dimensions (${imageWidth}x${imageHeight}) should be` +
@@ -377,7 +348,6 @@ class BundleValidator {
                 cb(new Error(failureMessage));
                 return;
             }
-
             cb(null, true);
         });
     }
@@ -387,13 +357,11 @@ class BundleValidator {
         const filePaths = await recursiveReadDir(path.join(this.themePath, 'templates'), [
             '!*.html',
         ]);
-
         for await (const filePath of filePaths) {
             const fileContent = await fs.promises.readFile(filePath, { encoding: 'utf-8' });
             const frontmatter = getFrontmatterContent(fileContent);
             if (frontmatter) {
                 const yaml = interpolateThemeSettings(frontmatter, config.settings);
-
                 try {
                     const result = yamlValidator.loadAll(yaml);
                     this.validateTrailingSymbols(result[0]);
@@ -404,7 +372,6 @@ class BundleValidator {
                 }
             }
         }
-
         return true;
     }
 
@@ -417,13 +384,12 @@ class BundleValidator {
     }
 
     validateTrailingSymbols(data) {
-        if (_.isObject(data)) {
-            return _.every(data, (value) => this.validateTrailingSymbols(value));
+        if (isObject(data)) {
+            return every(data, (value) => this.validateTrailingSymbols(value));
         }
-        if (_.isArray(data)) {
+        if (isArray(data)) {
             return data.every((row) => this.validateTrailingSymbols(row));
         }
-
         return data ? this.hasFrontmatterValidValue(data) : true;
     }
 
@@ -431,7 +397,6 @@ class BundleValidator {
         if (this.hasUnallowedTrailingSymbol(value)) {
             throw new Error(`Found unallowed trailing symbol in: "${value}"`);
         }
-
         return true;
     }
 
@@ -445,5 +410,4 @@ class BundleValidator {
         return symbols.includes(trailingSymbol);
     }
 }
-
-module.exports = BundleValidator;
+export default BundleValidator;

package/lib/cliCommon.js

@@ -1,6 +1,6 @@
-const semver = require('semver');
-const { PACKAGE_INFO } = require('../constants');
-const stencilCLISettings = require('./StencilCLISettings');
+import semver from 'semver';
+import { PACKAGE_INFO } from '../constants.js';
+import stencilCLISettings from './StencilCLISettings.js';
 
 const messages = {
     visitTroubleshootingPage:
@@ -8,7 +8,6 @@ const messages = {
     submitGithubIssue:
         'If this error persists, please visit https://github.com/bigcommerce/stencil-cli/issues and submit an issue.',
 };
-
 /**
  * @param {Object} object
 
@@ -19,13 +18,13 @@ function printObject(object) {
         console.log(`${property}: ${object[property]}`);
     }
 }
-
 /**
  * @param {Error} error
 
  * @returns {void}
  */
 function printNetworkError(config) {
+    console.log(config);
     console.log(`URL: `.yellow + config.url);
     console.log(`Method: `.yellow + config.method.toUpperCase());
     if (config.data) {
@@ -33,7 +32,6 @@ function printNetworkError(config) {
         printObject(config.data);
     }
 }
-
 /**
  * @param {Error} error
  * @param {Array<{message: string}>} [error.messages]
@@ -41,7 +39,6 @@ function printNetworkError(config) {
  */
 function printCliResultError(error) {
     console.error(`\n\n${'not ok'.red} -- ${error || 'Unknown error'}\n`);
-
     if (error && Array.isArray(error.messages)) {
         for (const item of error.messages) {
             if (item && item.message) {
@@ -49,41 +46,34 @@ function printCliResultError(error) {
             }
         }
     }
-
     if (error && (error.config || error.response)) {
         // In case if request didn't receive any response, response object is not available
         const networkReq = error.config || error.response;
         printNetworkError(networkReq);
     }
-
     console.log(messages.visitTroubleshootingPage);
-
     console.log(messages.submitGithubIssue);
 }
-
 /**
  * @param {Error} error
  * @returns {void}
  */
 function printCliResultErrorAndExit(error) {
+    console.log(error);
     printCliResultError(error);
     // Exit with error code so automated systems recognize it as a failure
     // eslint-disable-next-line no-process-exit
     process.exit(1);
 }
-
 function checkNodeVersion() {
     const satisfies = semver.satisfies(process.versions.node, PACKAGE_INFO.engines.node);
-
     if (!satisfies) {
         throw new Error(
             `You are running an unsupported version of node. Please upgrade to ${PACKAGE_INFO.engines.node}`,
         );
     }
-
     return satisfies;
 }
-
 function applyCommonOptions(program) {
     program
         .option('-h, --host [hostname]', 'specify the api host')
@@ -95,22 +85,22 @@ function applyCommonOptions(program) {
         )
         .parse(process.argv);
 }
-
 function setupCLI(options) {
     stencilCLISettings.setVerbose(options.verbose);
 }
-
 function prepareCommand(program) {
     applyCommonOptions(program);
     checkNodeVersion();
-
     const options = program.opts();
     setupCLI(options);
-
     return options;
 }
-
-module.exports = {
+export { messages };
+export { printCliResultError };
+export { printCliResultErrorAndExit };
+export { checkNodeVersion };
+export { prepareCommand };
+export default {
     messages,
     printCliResultError,
     printCliResultErrorAndExit,

package/lib/commander.js

@@ -1,8 +1,7 @@
-const program = require('commander');
+import program from 'commander';
 
 program
     // Avoid option name clashes https://www.npmjs.com/package/commander#avoiding-option-name-clashes
     .storeOptionsAsProperties(false)
     .passCommandToAction(false);
-
-module.exports = program;
+export default program;