@bigcommerce/stencil-cli 8.3.0 → 8.4.0

package/lib/stencil-init.js

@@ -1,12 +1,10 @@
-require('colors');
-
-const inquirerModule = require('inquirer');
-const nypmModule = require('nypm');
-
-const spinnerModule = require('./spinner');
-const serverConfigModule = require('../server/config');
-const StencilConfigManager = require('./StencilConfigManager');
-const { DEFAULT_CUSTOM_LAYOUTS_CONFIG, API_HOST, THEME_PATH } = require('../constants');
+import 'colors';
+import inquirerModule from 'inquirer';
+import * as nypmModule from 'nypm';
+import spinnerModule from './spinner.js';
+import * as serverConfigModule from '../server/config.js';
+import StencilConfigManager from './StencilConfigManager.js';
+import { DEFAULT_CUSTOM_LAYOUTS_CONFIG, API_HOST, THEME_PATH } from '../constants.js';
 
 class StencilInit {
     /**
@@ -48,7 +46,6 @@ class StencilInit {
         const updatedStencilConfig = this.applyAnswers(oldStencilConfig, answers, cliOptions);
         await this._stencilConfigManager.save(updatedStencilConfig);
         await this.installDependencies(THEME_PATH, answers.packageManager, cliOptions);
-
         this._logger.log(
             'You are now ready to go! To start developing, run $ ' + 'stencil start'.cyan,
         );
@@ -59,7 +56,6 @@ class StencilInit {
      */
     async readStencilConfig() {
         let parsedConfig;
-
         try {
             parsedConfig = await this._stencilConfigManager.read(true, true);
         } catch (err) {
@@ -69,7 +65,6 @@ class StencilInit {
                 '\nThe file will be rewritten with your answers',
             );
         }
-
         return parsedConfig || {};
     }
 
@@ -93,7 +88,6 @@ class StencilInit {
      */
     getQuestions(defaultAnswers, cliOptions) {
         const prompts = [];
-
         if (!cliOptions.normalStoreUrl) {
             prompts.push({
                 type: 'input',
@@ -103,7 +97,6 @@ class StencilInit {
                 default: defaultAnswers.normalStoreUrl,
             });
         }
-
         if (!cliOptions.accessToken) {
             prompts.push({
                 type: 'input',
@@ -113,7 +106,6 @@ class StencilInit {
                 filter: (val) => val.trim(),
             });
         }
-
         if (!cliOptions.port) {
             prompts.push({
                 type: 'input',
@@ -131,7 +123,6 @@ class StencilInit {
                 },
             });
         }
-
         if (!cliOptions.packageManager) {
             prompts.push({
                 type: 'list',
@@ -141,7 +132,6 @@ class StencilInit {
                 default: this.getPackageManager(),
             });
         }
-
         return prompts;
     }
 
@@ -155,9 +145,7 @@ class StencilInit {
 
     updateApiHost(stencilConfig, cliOptions) {
         const host = cliOptions.apiHost || API_HOST;
-
         console.log('Set API host to: ' + host);
-
         return { ...stencilConfig, apiHost: host };
     }
 
@@ -179,15 +167,12 @@ class StencilInit {
 
     getPackageManager() {
         const userAgent = process.env.npm_config_user_agent || '';
-
         if (userAgent.startsWith('yarn')) {
             return 'yarn';
         }
-
         if (userAgent.startsWith('pnpm')) {
             return 'pnpm';
         }
-
         return 'npm';
     }
 
@@ -216,5 +201,4 @@ class StencilInit {
         );
     }
 }
-
-module.exports = StencilInit;
+export default StencilInit;

package/lib/stencil-pull.js

@@ -1,6 +1,6 @@
-const async = require('async');
-const stencilPushUtils = require('./stencil-push.utils');
-const stencilPullUtils = require('./stencil-pull.utils');
+import async from 'async';
+import stencilPushUtils from './stencil-push.utils.js';
+import stencilPullUtils from './stencil-pull.utils.js';
 
 function stencilPull(options = {}, callback) {
     async.waterfall(
@@ -18,5 +18,4 @@ function stencilPull(options = {}, callback) {
         callback,
     );
 }
-
-module.exports = stencilPull;
+export default stencilPull;

package/lib/stencil-pull.utils.js

@@ -1,31 +1,25 @@
-const fs = require('fs');
-const _ = require('lodash');
-const themeApiClient = require('./theme-api-client');
-const { parseJsonFile } = require('./utils/fsUtils');
+import * as fs from 'fs';
+import * as _ from 'lodash-es';
+import themeApiClient from './theme-api-client.js';
+import { parseJsonFile } from './utils/fsUtils.js';
 
 const utils = {};
-
 utils.getChannelActiveTheme = async (options) => {
     const {
         config: { accessToken },
         storeHash,
         channelId,
     } = options;
-
     const apiHost = options.apiHost || options.config.apiHost;
-
     const activeTheme = await themeApiClient.getChannelActiveTheme({
         accessToken,
         apiHost,
         storeHash,
         channelId,
     });
-
     console.log('ok'.green + ` -- Fetched theme details for channel ${channelId}`);
-
     return { ...options, activeTheme };
 };
-
 utils.getCurrentVariation = async (options) => {
     const {
         config: { accessToken },
@@ -43,11 +37,9 @@ utils.getCurrentVariation = async (options) => {
         themeId,
     });
     const variation = variations.find((v) => v.uuid === remoteThemeConfiguration.variation_uuid);
-
     console.log('ok'.green + ` -- Fetched ${saved ? 'saved' : 'active'} variation name`);
     return { ...options, variation };
 };
-
 utils.getThemeConfiguration = async (options) => {
     const {
         config: { accessToken },
@@ -55,15 +47,11 @@ utils.getThemeConfiguration = async (options) => {
         activeTheme,
         saved,
     } = options;
-
     const apiHost = options.apiHost || options.config.apiHost;
-
     const themeId = activeTheme.active_theme_uuid;
-
     const configurationId = saved
         ? activeTheme.saved_theme_configuration_uuid
         : activeTheme.active_theme_configuration_uuid;
-
     const remoteThemeConfiguration = await themeApiClient.getThemeConfiguration({
         accessToken,
         apiHost,
@@ -71,19 +59,14 @@ utils.getThemeConfiguration = async (options) => {
         themeId,
         configurationId,
     });
-
     console.log('ok'.green + ` -- Fetched ${saved ? 'saved' : 'active'} configuration`);
-
     return { ...options, remoteThemeConfiguration };
 };
-
 utils.mergeThemeConfiguration = async (options) => {
     const { remoteThemeConfiguration } = options;
-
     const localConfig = await parseJsonFile('config.json');
     const variation = localConfig.variations.find((v) => v.name === options.variation.name);
     let diffDetected = false;
-
     // For any keys the remote configuration has in common with the local configuration,
     // overwrite the local configuration if the remote configuration differs
     for (const [key, remoteVal] of Object.entries(remoteThemeConfiguration.settings)) {
@@ -91,7 +74,6 @@ utils.mergeThemeConfiguration = async (options) => {
             continue;
         }
         const defaultVal = localConfig.settings[key];
-
         // Check for different types, and throw an error if they are found
         if (typeof defaultVal !== typeof remoteVal) {
             throw new Error(
@@ -99,7 +81,6 @@ utils.mergeThemeConfiguration = async (options) => {
                     `Remote configuration is of type ${typeof remoteVal} while local configuration is of type ${typeof defaultVal}.`,
             );
         }
-
         // If a different value is found, overwrite the local config
         if (!_.isEqual(defaultVal, remoteVal)) {
             if (!variation.settings) {
@@ -109,7 +90,6 @@ utils.mergeThemeConfiguration = async (options) => {
             diffDetected = true;
         }
     }
-
     // Does a file need to be written?
     if (diffDetected || options.saveConfigName !== 'config.json') {
         if (diffDetected) {
@@ -119,7 +99,6 @@ utils.mergeThemeConfiguration = async (options) => {
                 'ok'.green + ' -- Remote and local configurations are in sync for all common keys',
             );
         }
-
         await fs.promises.writeFile(options.saveConfigName, JSON.stringify(localConfig, null, 2));
         console.log('ok'.green + ` -- Configuration written to ${options.saveConfigName}`);
     } else {
@@ -128,8 +107,6 @@ utils.mergeThemeConfiguration = async (options) => {
                 ` -- Remote and local configurations are in sync for all common keys, no action taken`,
         );
     }
-
     return options;
 };
-
-module.exports = utils;
+export default utils;

package/lib/stencil-push.js

@@ -1,5 +1,5 @@
-const async = require('async');
-const utils = require('./stencil-push.utils');
+import async from 'async';
+import utils from './stencil-push.utils.js';
 
 function stencilPush(options = {}, callback) {
     async.waterfall(
@@ -28,5 +28,4 @@ function stencilPush(options = {}, callback) {
         callback,
     );
 }
-
-module.exports = stencilPush;
+export default stencilPush;