@bigcommerce/stencil-cli 3.5.2 → 3.6.3

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 3.6.3 (2021-10-22)
+
+-   Bump paper to rc51
+-   fix: strf-8846 Send stencil-cli header to storefront api ([789](https://github.com/bigcommerce/stencil-cli/pull/789))
+
+### 3.6.2 (2021-10-06)
+
+-   feat: Add overwrite option to download command ([785](https://github.com/bigcommerce/stencil-cli/pull/785))
+
+### 3.6.1 (2021-10-04)
+
+-   fix: strf-9375 Fix custom release tag selection ([f41d6dd44fb](https://github.com/bigcommerce/stencil-cli/commit/f41d6dd44fb))
+
+### 3.6.0 (2021-09-28)
+
+-   feat: strf-9332 added timeout parameter for stencil bundle command ([9c762fa0aa1](https://github.com/bigcommerce/stencil-cli/commit/9c762fa0aa1))
+-   feat: strf-9040 Support dart-sass as primary engine for css rendering ([514ea778eda](https://github.com/bigcommerce/stencil-cli/commit/514ea778eda))
+
 ### 3.5.2 (2021-09-17)
 
 -   fix: strf-9356 Support npm 7 for stencil cli ([d67747d5384](https://github.com/bigcommerce/stencil-cli/commit/d67747d5384))

package/bin/stencil-bundle.js

@@ -8,6 +8,7 @@ const ThemeConfig = require('../lib/theme-config');
 const Bundle = require('../lib/stencil-bundle');
 const { printCliResultErrorAndExit } = require('../lib/cliCommon');
 const { checkNodeVersion } = require('../lib/cliCommon');
+const BuildConfigManager = require('../lib/BuildConfigManager');
 
 program
     .version(PACKAGE_INFO.version)
@@ -23,6 +24,11 @@ program
         '-m, --marketplace',
         'Runs extra bundle validations for partners who can create marketplace themes',
     )
+    .option(
+        '-t, --timeout [timeout]',
+        'Set a timeout for the bundle operation. Default is 20 secs',
+        '60',
+    )
     .parse(process.argv);
 
 const cliOptions = program.opts();
@@ -49,7 +55,15 @@ async function run() {
         }
 
         const rawConfig = await themeConfig.getRawConfig();
-        const bundle = new Bundle(THEME_PATH, themeConfig, rawConfig, cliOptions);
+        const timeout = cliOptions.timeout * 1000; // seconds
+        const buildConfigManager = new BuildConfigManager({ timeout });
+        const bundle = new Bundle(
+            THEME_PATH,
+            themeConfig,
+            rawConfig,
+            cliOptions,
+            buildConfigManager,
+        );
 
         const bundlePath = await bundle.initBundle();
 

package/bin/stencil-download.js

@@ -15,6 +15,7 @@ program
     .option('-f, --file [filename]', 'specify the filename to download only')
     .option('-e, --exclude [exclude]', 'specify a directory to exclude from download')
     .option('-c, --channel_id [channelId]', 'specify the channel ID of the storefront', parseInt)
+    .option('-o, --overwrite', 'overwrite local with remote files')
     .parse(process.argv);
 
 checkNodeVersion();
@@ -25,6 +26,7 @@ const options = {
     exclude: ['parsed', 'manifest.json', ...extraExclude],
     apiHost: cliOptions.host,
     channelId: cliOptions.channel_id,
+    overwrite: cliOptions.overwrite,
     applyTheme: true, // fix to be compatible with stencil-push.utils
     file: cliOptions.file,
 };
@@ -32,16 +34,23 @@ const options = {
 async function run(opts) {
     const overwriteType = opts.file ? opts.file : 'files';
 
-    const answers = await inquirer.prompt([
+    const promptAnswers = await inquirer.prompt([
         {
             message: `${'Warning'.yellow} -- overwrite local with remote ${overwriteType}?`,
             name: 'overwrite',
-            type: 'checkbox',
-            choices: ['Yes', 'No'],
+            type: 'confirm',
+            when() {
+                return !opts.overwrite;
+            },
         },
     ]);
 
-    if (!answers.overwrite.includes('Yes')) {
+    const answers = {
+        ...opts,
+        ...promptAnswers,
+    };
+
+    if (!answers.overwrite) {
         console.log(`Request cancelled by user ${'No'.red}`);
         return;
     }

package/bin/stencil-start.js

@@ -5,6 +5,7 @@ const { PACKAGE_INFO } = require('../constants');
 const program = require('../lib/commander');
 const StencilStart = require('../lib/stencil-start');
 const { printCliResultErrorAndExit } = require('../lib/cliCommon');
+const BuildConfigManager = require('../lib/BuildConfigManager');
 
 program
     .version(PACKAGE_INFO.version)
@@ -20,6 +21,7 @@ program
         '-n, --no-cache',
         'Turns off caching for API resource data per storefront page. The cache lasts for 5 minutes before automatically refreshing.',
     )
+    .option('-t, --timeout', 'Set a timeout for the bundle operation. Default is 20 secs', '60')
     .parse(process.argv);
 
 const cliOptions = program.opts();
@@ -33,4 +35,6 @@ const options = {
     cache: cliOptions.cache,
 };
 
-new StencilStart().run(options).catch(printCliResultErrorAndExit);
+const timeout = cliOptions.timeout * 1000; // seconds
+const buildConfigManager = new BuildConfigManager({ timeout });
+new StencilStart({ buildConfigManager }).run(options).catch(printCliResultErrorAndExit);

package/lib/BuildConfigManager.js

@@ -6,7 +6,7 @@ const fsModule = require('fs');
 const { THEME_PATH } = require('../constants');
 
 class BuildConfigManager {
-    constructor({ workDir = THEME_PATH, fs = fsModule } = {}) {
+    constructor({ workDir = THEME_PATH, fs = fsModule, timeout = 20000 } = {}) {
         this.configFileName = 'stencil.conf.js';
 
         this._workDir = workDir;
@@ -15,6 +15,7 @@ class BuildConfigManager {
         this._onReadyCallbacks = [];
         this._worker = null;
         this._workerIsReady = false;
+        this.timeout = timeout;
 
         const config = this._getConfig(this._buildConfigPath);
 
@@ -81,13 +82,17 @@ class BuildConfigManager {
             return;
         }
 
-        const timeout = setTimeout(() => {
+        const timeoutId = setTimeout(() => {
             this.stopWorker();
+            console.log(
+                'The process was timed out. Try to increase it by providing --timeout [number] option'
+                    .yellow,
+            );
             callback('worker timed out');
-        }, 20000);
+        }, this.timeout);
 
         this._onWorkerReady(() => {
-            clearTimeout(timeout);
+            clearTimeout(timeoutId);
             // send a message to the worker to start bundling js
             this._worker.send('production');
             this._worker.on('message', (message) => {

package/lib/release/questions.js

@@ -63,6 +63,7 @@ async function askQuestions(currentVersion, githubToken, remotes) {
             name: 'version',
             type: 'input',
             message: 'What specific version would you like',
+            askAnswered: true,
             when: (answers) => answers.version === 'custom',
             validate: (value) => {
                 const valid = semver.valid(value) && true;

package/lib/stencil-bundle.js

@@ -43,7 +43,7 @@ class Bundle {
         themeConfig,
         rawConfig,
         options = {},
-        buildConfigManger = new BuildConfigManager(),
+        buildConfigManager = new BuildConfigManager(),
     ) {
         const tasks = {};
         this.options = options;
@@ -68,10 +68,10 @@ class Bundle {
         tasks.schema = this.assembleSchema.bind(this);
         tasks.schemaTranslations = this.assembleSchemaTranslations.bind(this);
 
-        if (typeof buildConfigManger.production === 'function') {
+        if (typeof buildConfigManager.production === 'function') {
             tasks.theme = (callback) => {
                 console.log('Theme task Started...');
-                buildConfigManger.initWorker().production((err) => {
+                buildConfigManager.initWorker().production((err) => {
                     if (err) {
                         return callback(err);
                     }

package/lib/stencil-start.js

@@ -5,7 +5,7 @@ const path = require('path');
 
 const Cycles = require('./Cycles');
 const templateAssemblerModule = require('./template-assembler');
-const { THEME_PATH } = require('../constants');
+const { PACKAGE_INFO, THEME_PATH } = require('../constants');
 const Server = require('../server');
 const StencilConfigManager = require('./StencilConfigManager');
 const ThemeConfig = require('./theme-config');
@@ -23,7 +23,7 @@ class StencilStart {
         cliCommon = cliCommonModule,
         stencilConfigManager = new StencilConfigManager(),
         themeConfigManager = ThemeConfig.getInstance(THEME_PATH),
-        buildConfigManger = new BuildConfigManager(),
+        buildConfigManager = new BuildConfigManager(),
         templateAssembler = templateAssemblerModule,
         CyclesDetector = Cycles,
         stencilPushUtils = stencilPushUtilsModule,
@@ -35,7 +35,7 @@ class StencilStart {
         this._cliCommon = cliCommon;
         this._stencilConfigManager = stencilConfigManager;
         this._themeConfigManager = themeConfigManager;
-        this._buildConfigManger = buildConfigManger;
+        this._buildConfigManager = buildConfigManager;
         this._templateAssembler = templateAssembler;
         this._CyclesDetector = CyclesDetector;
         this._stencilPushUtils = stencilPushUtils;
@@ -131,6 +131,7 @@ class StencilStart {
             variationIndex: this._themeConfigManager.variationIndex || 0,
             useCache: cliOptions.cache,
             themePath: this._themeConfigManager.themePath,
+            stencilCliVersion: PACKAGE_INFO.version,
         });
     }
 
@@ -138,7 +139,7 @@ class StencilStart {
         const DEFAULT_WATCH_FILES = ['/assets', '/templates', '/lang', '/.config'];
         const DEFAULT_WATCH_IGNORED = ['/assets/scss', '/assets/css'];
         const { themePath, configPath } = this._themeConfigManager;
-        const { watchOptions } = this._buildConfigManger;
+        const { watchOptions } = this._buildConfigManager;
 
         // Watch sccs directory and automatically reload all css files if a file changes
         const stylesPath = path.join(themePath, 'assets/scss');
@@ -211,8 +212,8 @@ class StencilStart {
             }
         });
 
-        if (this._buildConfigManger.development) {
-            this._buildConfigManger.initWorker().development(this._browserSync);
+        if (this._buildConfigManager.development) {
+            this._buildConfigManager.initWorker().development(this._browserSync);
         }
     }