@swell/cli 2.0.11 → 2.0.13

package/dist/push-app-command.js

@@ -5,20 +5,30 @@ import * as path from 'node:path';
 import Stream from 'node:stream';
 import ora from 'ora';
 import { default as swellConfig } from './lib/app-config.js';
-import { ConfigType, FrontendProjectTypes, allConfigFilesInDir, appConfigFromFile, filePathExists, findAppConfig, getAppSlugId, getConfigTypeFromPath, getConfigTypeKeyFromValue, getFrontendProjectType, globAllFilesByPath, hashString, isPathDirectory, } from './lib/apps/index.js';
+import { ConfigType, FrontendProjectTypes, allConfigFilesInDir, appConfigFromFile, filePathExists, filePathExistsAsync, findAppConfig, getAppSlugId, getConfigTypeFromPath, getConfigTypeKeyFromValue, getFrontendProjectType, globAllFilesByPath, hashString, isPathDirectory, } from './lib/apps/index.js';
+import { selectEnvironmentId } from './lib/stores.js';
+import { getGlobIgnorePathsChecker } from './lib/apps/paths.js';
 import { default as localConfig } from './lib/config.js';
 import { toAppId } from './lib/create/index.js';
 import style from './lib/style.js';
 import { RemoteAppCommand } from './remote-app-command.js';
 const PUSH_CONCURRENCY = 3;
+const WATCH_WINDOW_MS = 100;
 export class PushAppCommand extends RemoteAppCommand {
     frontendPath = '';
     logWatchChanges = true;
     onWatchChange;
-    watchingChangeQueue = [];
-    watchingChangeQueueRunning = false;
-    watchingFiles = [];
+    watchingChangeQueue = new Map();
+    watchingFiles = new Set();
+    watchingIgnoreFilter = null;
+    watchingTimer = null;
     watchListener = async (eventType, filename) => {
+        if (!filename) {
+            return;
+        }
+        if (this.watchingIgnoreFilter && this.watchingIgnoreFilter(filename)) {
+            return;
+        }
         const configFile = filename;
         const pathParsed = path.parse(configFile);
         const fileDirs = pathParsed.dir.split(path.sep);
@@ -26,8 +36,6 @@ export class PushAppCommand extends RemoteAppCommand {
         const configDir = fileDirs[0];
         // we only want to watch files in the root of the app directory
         // and ignore build files etc
-        this.setWatchingFiles();
-        const isWatching = this.watchingFiles.includes(configFile);
         // TODO: renaming a folder doesn't seem to work
         // because isWatching = false for the new files
         if (!configDir) {
@@ -37,6 +45,7 @@ export class PushAppCommand extends RemoteAppCommand {
         if (!configType) {
             return;
         }
+        const isWatching = this.watchingFiles.has(configFile);
         let watchFileEvent;
         // per node docs:
         //
@@ -47,12 +56,14 @@ export class PushAppCommand extends RemoteAppCommand {
         // correct API request
         if (eventType === 'rename') {
             watchFileEvent = 'new';
-            if (!filePathExists(path.join(this.appPath, configFile))) {
+            if (!(await filePathExistsAsync(path.join(this.appPath, configFile)))) {
                 watchFileEvent = 'deleted';
+                this.watchingFiles.delete(configFile);
             }
             else if (!isWatching) {
                 return;
             }
+            this.watchingFiles.add(configFile);
         }
         else if (isWatching) {
             watchFileEvent = 'change';
@@ -85,9 +96,7 @@ export class PushAppCommand extends RemoteAppCommand {
         const typeLabelPlural = this.appType === 'theme' ? 'themes' : 'apps';
         const typeLabelPrefixed = this.appType === 'theme' ? 'a theme' : 'an app';
         const typeQuery = this.appType === 'theme' ? { type: 'theme' } : { type: 'storefront' };
-        const apps = await this.api.get({
-            adminPath: `/apps`,
-        }, { query: { limit: null, ...typeQuery, ...query } });
+        const apps = await this.api.get({ adminPath: '/apps' }, { query: { limit: null, ...typeQuery, ...query } });
         if (!apps.count) {
             const currentStore = localConfig.getDefaultStore();
             this.error(`There are no ${typeLabelPlural} associated with your store ${style.storeId(currentStore)}`);
@@ -220,12 +229,11 @@ export class PushAppCommand extends RemoteAppCommand {
         }
     }
     async ensureAppExists(file, shouldCreate = true) {
-        let currentStore = localConfig.getDefaultStore();
-        this.api.setStoreEnv(currentStore, 'test');
-        const loggedIn = await this.ensureLoggedIn();
-        if (loggedIn) {
-            currentStore = localConfig.getDefaultStore();
-            this.api.setStoreEnv(currentStore, 'test');
+        const klass = this.ctor;
+        const currentStore = localConfig.getDefaultStore();
+        await this.ensureLoggedIn();
+        if (klass.orientation?.env) {
+            await this.api.setStoreEnv(currentStore, klass.orientation?.env);
         }
         const app = await this.getAppWithConfig('').catch((_error) => 
         // Ignore so we can continue to create it
@@ -234,9 +242,12 @@ export class PushAppCommand extends RemoteAppCommand {
         if (app && !isTheme && this.appType === 'theme') {
             this.error(`App ${style.appConfigValue(app?.name)} is not a theme.`);
         }
-        const confirmExistingApp = await this.confirmRemoveInstalledApp(app, currentStore);
-        if (confirmExistingApp === false) {
-            return false;
+        // Confirm development app unless theme without app syncing
+        if (!isTheme || this.themeSyncApp) {
+            const confirmExistingApp = await this.confirmRemoveInstalledApp(app, currentStore);
+            if (confirmExistingApp === false) {
+                return false;
+            }
         }
         // Do not create or update if app already exists and not forcing it
         if (!shouldCreate && app) {
@@ -326,8 +337,9 @@ export class PushAppCommand extends RemoteAppCommand {
     }
     async getAppToPull(args, shouldChoose = true) {
         const { appId, targetPath } = args;
+        const klass = this.ctor;
         const currentStore = localConfig.getDefaultStore();
-        this.api.setStoreEnv(currentStore, 'test');
+        await this.api.setStoreEnv(currentStore, klass.orientation?.env);
         this.resolveAppPath(appId, targetPath);
         if (isPathDirectory(this.appPath)) {
             this.swellConfig = swellConfig(this.appPath);
@@ -393,15 +405,16 @@ export class PushAppCommand extends RemoteAppCommand {
     }
     async getStorefrontToPull(args = {}, flags = {}) {
         const { appId, targetPath } = args;
-        const targetApp = await this.getAppToPull(args, false);
         const targetStorefront = flags['storefront-id'];
+        const targetApp = await this.getAppToPull(args, false);
         this.resolveAppPath(appId, targetPath);
         // Only use default if path exists
-        let currentStorefront;
+        let defaultStorefront;
         if (isPathDirectory(this.appPath)) {
-            currentStorefront = localConfig.getDefaultStorefront(this.appPath);
+            defaultStorefront = localConfig.getDefaultStorefront(this.appPath);
         }
-        let storefrontId = targetStorefront || targetApp ? currentStorefront : undefined;
+        await this.setStorefrontEnv(flags, defaultStorefront);
+        let storefrontId = targetStorefront || targetApp ? defaultStorefront?.id : undefined;
         if (!storefrontId || flags['storefront-select']) {
             const storefronts = await this.getAllStorefronts(targetApp?.id
                 ? this.appType === 'theme'
@@ -452,8 +465,12 @@ export class PushAppCommand extends RemoteAppCommand {
     }
     async getStorefrontToPush(flags = {}) {
         const targetStorefront = flags['storefront-id'];
-        const currentStorefront = localConfig.getDefaultStorefront(this.appPath);
-        let storefrontId = targetStorefront || currentStorefront;
+        const defaultStorefront = localConfig.getDefaultStorefront(this.appPath);
+        let storefrontId = targetStorefront || defaultStorefront?.id;
+        // Force storefront select if pushing app from default storefront in live environment
+        if (this.themeSyncApp && defaultStorefront?.id && !defaultStorefront.env) {
+            storefrontId = '';
+        }
         if (!storefrontId || flags['storefront-select']) {
             const storefronts = await this.getAllAppStorefronts({
                 type: this.appType,
@@ -494,28 +511,64 @@ export class PushAppCommand extends RemoteAppCommand {
         this.app = await this.getApp(this.app.id);
         return this.storefront;
     }
+    async setStorefrontEnv(flags, defaultStorefront) {
+        const currentStore = localConfig.getDefaultStore();
+        const targetStorefront = flags['storefront-id'];
+        if (defaultStorefront &&
+            !targetStorefront &&
+            !flags['storefront-id'] &&
+            !flags['storefront-select']) {
+            const klass = this.ctor;
+            if (klass.orientation?.env === undefined) {
+                await this.api.setStoreEnv(currentStore, defaultStorefront?.env);
+            }
+        }
+        else if (flags['env']) {
+            await this.api.setStoreEnv(currentStore, flags['env']);
+        }
+        else {
+            const hasTestEnv = await this.api.isTestEnvEnabled();
+            if (hasTestEnv) {
+                const env = await selectEnvironmentId();
+                await this.api.setStoreEnv(currentStore, env);
+            }
+        }
+    }
     async handleWatchFileChange(configFile, configType, event) {
         let config;
-        if (event === 'deleted') {
-            config = findAppConfig(this.app, configFile, configType);
-            if (!config) {
-                return;
+        switch (event) {
+            case 'deleted': {
+                config = findAppConfig(this.app, configFile, configType);
+                if (!config) {
+                    return;
+                }
+                this.watchingChangeQueue.set(configFile, {
+                    action: 'remove',
+                    appConfig: config,
+                    configFile,
+                });
+                break;
+            }
+            default: {
+                config = appConfigFromFile(configFile, configType, this.appPath);
+                this.watchingChangeQueue.set(configFile, {
+                    action: 'push',
+                    appConfig: config,
+                    configFile,
+                });
+                break;
             }
-            this.watchingChangeQueue.push({
-                action: 'remove',
-                appConfig: config,
-                configFile,
-            });
         }
-        else {
-            config = appConfigFromFile(configFile, configType, this.appPath);
-            this.watchingChangeQueue.push({
-                action: 'push',
-                appConfig: config,
-                configFile,
-            });
+        if (this.watchingTimer === null) {
+            this.watchingTimer = setTimeout(async () => {
+                try {
+                    await this.runWatchChangeQueue();
+                }
+                finally {
+                    this.watchingTimer = null;
+                }
+            }, WATCH_WINDOW_MS);
         }
-        await this.runWatchChangeQueue();
     }
     logAppFrontendUrl() {
         const currentStore = localConfig.getDefaultStore();
@@ -533,11 +586,8 @@ export class PushAppCommand extends RemoteAppCommand {
         if (!this.storefront) {
             this.error('Storefront not connected');
         }
-        const { name, theme_app } = this.storefront;
-        const themeLog = theme_app && theme_app.name !== name
-            ? ` [theme] ${style.appName(theme_app.name)} v${theme_app.version}`
-            : '';
-        this.log(`[storefront] ${style.appName(name)}${themeLog}\n`);
+        const { name } = this.storefront;
+        this.log(`[storefront] ${style.appName(name)}\n`);
     }
     logStorefrontFrontendUrl(storefront, branchId) {
         const currentStore = localConfig.getDefaultStore();
@@ -603,44 +653,44 @@ export class PushAppCommand extends RemoteAppCommand {
             isPathDirectory(path.resolve(process.cwd(), resolvedAppId))) {
             resolvedPath = resolvedAppId;
         }
-        // Reset app config and path if appId is provided
-        if (resolvedPath && this.appPath === '.') {
+        // Reset app path if appId is provided
+        if (resolvedPath && this.appPath === process.cwd()) {
             this.appPath = path.resolve(process.cwd(), resolvedPath);
         }
         return this.appPath;
     }
     async runWatchChangeQueue() {
-        if (this.watchingChangeQueueRunning) {
+        if (this.watchingChangeQueue.size <= 0) {
             return;
         }
-        while (this.watchingChangeQueue.length > 0) {
-            this.watchingChangeQueueRunning = true;
+        const queue = [...this.watchingChangeQueue.values()];
+        this.watchingChangeQueue.clear();
+        while (queue.length > 0) {
             // eslint-disable-next-line no-await-in-loop
-            await Promise.all(this.watchingChangeQueue
-                .splice(0, PUSH_CONCURRENCY)
-                .map(async ({ action, appConfig }) => {
+            await Promise.all(queue.splice(0, PUSH_CONCURRENCY).map(async ({ action, appConfig }) => {
                 const result = await (action === 'remove'
                     ? this.removeRemoteFile(appConfig, this.logWatchChanges)
                     : this.pushRemoteFile(appConfig, this.logWatchChanges));
                 this.onWatchChange?.(appConfig, result);
             }));
         }
-        this.watchingChangeQueueRunning = false;
         // refetch app to get updated configs
         this.app = await this.getAppWithConfig(this.app.id);
+        // Process next accumulated changes
+        return this.runWatchChangeQueue();
     }
     saveCurrentStorefront() {
         const currentStorefront = localConfig.getDefaultStorefront(this.appPath);
         if (this.storefront && this.storefront.id !== currentStorefront) {
-            localConfig.setDefaultStorefront(this.appPath, this.storefront.id);
+            localConfig.setDefaultStorefront(this.appPath, this.storefront.id, this.api.envId);
         }
     }
-    setWatchingFiles() {
-        this.watchingFiles = globAllFilesByPath(this.appPath);
+    async setWatchingFiles() {
+        this.watchingFiles = new Set(await globAllFilesByPath(this.appPath));
     }
     async updateFrontendDeployment(currentStore, projectType, deploymentUrl, deploymentHash) {
         const spinner = ora();
-        spinner.start(`Updating frontend deployment...`);
+        spinner.start('Updating frontend deployment...');
         await this.handleRequestErrors(async () => this.api.put({ adminPath: `/apps/${this.app.id}` }, {
             body: {
                 $client_id: currentStore,
@@ -656,14 +706,15 @@ export class PushAppCommand extends RemoteAppCommand {
         spinner.succeed('Updated frontend deployment.\n');
     }
     async watchForChanges({ logChanges, onChange, syncAll, } = {}) {
+        this.watchingIgnoreFilter = await getGlobIgnorePathsChecker(this.appPath);
         this.logWatchChanges = logChanges ?? true;
         this.onWatchChange = onChange;
-        this.setWatchingFiles();
+        await this.setWatchingFiles();
         if (syncAll) {
             await this.pushAppConfigs();
             fs.watch(this.appPath, { recursive: true }, async (_eventType, _filename) => {
                 await this.pushAppConfigs();
-                this.setWatchingFiles();
+                await this.setWatchingFiles();
             });
             return;
         }

package/dist/remote-app-command.d.ts

@@ -5,11 +5,11 @@ import { App, AppConfig, AppVersion } from './lib/apps/index.js';
  * configurations.
  */
 export declare abstract class RemoteAppCommand extends AppCommand {
+    appType: string;
     static delayOrientation: boolean;
     static orientation: AppCommandOrientation;
     app: App;
     appCreated: boolean;
-    appType: string;
     storefront?: any;
     storefrontLocalUrl?: string;
     themeSyncApp?: boolean;
@@ -32,7 +32,7 @@ export declare abstract class RemoteAppCommand extends AppCommand {
     protected installApp(version: string, spinner?: any): Promise<any>;
     isConfigDeprecated(config: AppConfig): boolean;
     localFrontendUrl(storeId: string, sessionId: string): string;
-    logOrientation(): Promise<void>;
+    logOrientation(orientation?: AppCommandOrientation): Promise<void>;
     postConfigData(configJson: any): Promise<any>;
     protected pullAppConfigs(force?: boolean, confirmRemove?: boolean): Promise<{
         pulled: string[];

package/dist/remote-app-command.js

@@ -15,6 +15,7 @@ import style from './lib/style.js';
  * configurations.
  */
 export class RemoteAppCommand extends AppCommand {
+    appType = 'any';
     // allows child commands to set orientation
     static delayOrientation = false;
     // most of the times this will be the target environment
@@ -23,7 +24,6 @@ export class RemoteAppCommand extends AppCommand {
     app = {};
     // Indicates the app was created during the command execution
     appCreated = false;
-    appType = 'any';
     // API instance of the target storefront, if applicable
     storefront = null;
     // Indicates we are syncing with a local app frontend via proxy
@@ -322,11 +322,11 @@ export class RemoteAppCommand extends AppCommand {
     localFrontendUrl(storeId, sessionId) {
         return getLocalFrontendHost(storeId, sessionId);
     }
-    async logOrientation() {
+    async logOrientation(orientation) {
         const klass = this.ctor;
         const { flags } = await this.parse(klass);
-        if (klass.orientation) {
-            this.showOrientation(klass.orientation, flags);
+        if (klass.orientation || orientation) {
+            this.showOrientation(klass.orientation || orientation, flags);
         }
     }
     async postConfigData(configJson) {
@@ -334,7 +334,9 @@ export class RemoteAppCommand extends AppCommand {
         return this.api.post({ adminPath: `/apps/${this.app.id}/configs` }, {
             body: {
                 ...configJson,
-                ...(themeId ? { theme_id: themeId } : undefined),
+                ...(themeId
+                    ? { theme_id: themeId, $environment_id: this.api.envId }
+                    : undefined),
                 ...(this.themeSyncApp ? { $sync_app: true } : undefined),
                 ...(this.storefrontLocalUrl
                     ? { $storefront_local_url: this.storefrontLocalUrl }
@@ -629,9 +631,13 @@ export class RemoteAppCommand extends AppCommand {
         const orientationOutput = [];
         const currentStore = localConfig.getDefaultStore();
         const { env, store } = flags;
-        orientationOutput.push(`[${this.app.type === 'theme' ? 'theme' : 'app'}] ${style.appName(this.app.name)}${this.app.version ? ` v${this.app.version}` : ''}${this.storefront && this.storefront.name !== this.app.name
-            ? ` [storefront] ${style.appName(this.storefront.name)}`
-            : ``}`);
+        if (this.app.name) {
+            // Show theme version if not syncing app
+            const version = !this.themeSyncApp && this.app.type === 'theme' && this.storefront?.theme_version
+                ? this.storefront?.theme_version
+                : this.app.version;
+            orientationOutput.push(`[${this.app.type === 'theme' ? 'theme' : 'app'}] ${style.appName(this.app.name)}${version ? ` v${version}` : ''}`);
+        }
         if (store) {
             orientationOutput.push(`[store] ${style.storeId(store)}`);
         }

package/oclif.manifest.json

@@ -623,6 +623,9 @@
       "pluginType": "core",
       "strict": true,
       "summary": "Pull app files from Swell to your local machine.",
+      "orientation": {
+        "env": "test"
+      },
       "isESM": true,
       "relativePath": [
         "dist",
@@ -758,6 +761,9 @@
       "pluginType": "core",
       "strict": true,
       "summary": "Release a new version of your an app for publishing to the App Store.",
+      "orientation": {
+        "env": "test"
+      },
       "isESM": true,
       "relativePath": [
         "dist",
@@ -825,6 +831,9 @@
       "pluginType": "core",
       "strict": true,
       "summary": "Increment the version of your Swell app.",
+      "orientation": {
+        "env": "test"
+      },
       "isESM": true,
       "relativePath": [
         "dist",
@@ -1519,6 +1528,14 @@
           "name": "storefront-select",
           "allowNo": false,
           "type": "boolean"
+        },
+        "env": {
+          "char": "e",
+          "description": "target environment to push to, defaults to live",
+          "name": "env",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1529,9 +1546,6 @@
       "pluginType": "core",
       "strict": true,
       "summary": "Run a theme in dev mode from your local machine.",
-      "orientation": {
-        "env": "test"
-      },
       "isESM": true,
       "relativePath": [
         "dist",
@@ -1646,6 +1660,14 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "env": {
+          "char": "e",
+          "description": "target environment to pull from, defaults to live",
+          "name": "env",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "sync-app": {
           "description": "pull app files in addition to theme files to",
           "name": "sync-app",
@@ -1660,6 +1682,9 @@
       "pluginName": "@swell/cli",
       "pluginType": "core",
       "summary": "Pull theme files from Swell to your local machine.",
+      "orientation": {
+        "env": "test"
+      },
       "isESM": true,
       "relativePath": [
         "dist",
@@ -1667,8 +1692,7 @@
         "theme",
         "pull.js"
       ],
-      "delayOrientation": true,
-      "orientation": {}
+      "delayOrientation": true
     },
     "theme:push": {
       "aliases": [],
@@ -1708,6 +1732,14 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "env": {
+          "char": "e",
+          "description": "target environment to push to, defaults to live",
+          "name": "env",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "sync-app": {
           "description": "push app files in addition to theme files",
           "name": "sync-app",
@@ -1723,7 +1755,9 @@
       "pluginType": "core",
       "summary": "Push local files to your Swell theme.",
       "delayOrientation": true,
-      "orientation": {},
+      "orientation": {
+        "env": "test"
+      },
       "isESM": true,
       "relativePath": [
         "dist",
@@ -1857,5 +1891,5 @@
       ]
     }
   },
-  "version": "2.0.11"
+  "version": "2.0.13"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swell/cli",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "type": "module",
   "description": "Swell's command line interface/utility",
   "keywords": [
@@ -42,7 +42,7 @@
     "execa": "8.0.1",
     "find-up": "7.0.0",
     "get-port": "7.0.0",
-    "globby": "14.0.1",
+    "globby": "^14.1.0",
     "inflection": "3.0.0",
     "istextorbinary": "9.5.0",
     "lodash": "4.17.21",