Version 1.1.1

Author: kerrishotts

README.md

@@ -22,6 +22,7 @@ UXP CLI is a standard tooling for Adobe UXP plugin development. Its a full syste
 
 - Yarn version >= 1.5
 - Node version >= 10.16
+- Git
 
 Devtools helper uses N-api v4. Node-version and n-api compatible matrix  is available [here](https://nodejs.org/api/n-api.html#n_api_n_api_version_matrix)
 
@@ -44,12 +45,14 @@ You can run this command on terminal to add yarn global bin path.
 You can add yarn global bin path to system variables by following the steps given [here](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v%3Doffice.14)).
 
 
-### Installation
+### Installation through npm (Work in progress)
 
-Navigate to the root of this project and type:
+    npm install @adobe/uxp-devtools-cli
 
-    yarn install
- 
+or
+
+    yarn add @adobe/uxp-devtools-cli
+  
 
 ### Quick guide for getting started
 
@@ -64,22 +67,6 @@ After a successful yarn install, First, start a cli service ( Make sure Applicat
 
 ```$ uxp service start```
 
-> **IMPORTANT**
->
-> For macOS, there is a bug where `uxp service start` won't work if devtools hasn't been enabled before. If you can a permissions error about a path, use the following steps to work around it manually.
->
-> * Navigate to `/Library/Application Support/Adobe/UXP/Developer`
-> * Create a new file called `settings.json` (this will require `sudo`). I use `vi`, but any editor will do.
-> 
-> Inside this file, put:
-> 
-> ```
-> {
->         "developer": true
-> }
-> ```
-
-
 In another terminal instance - run plugin commands for to load plugin 
 
 ```$ uxp plugin load```

package.json

@@ -29,8 +29,5 @@
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-plugin-import": "^2.20.1",
     "jest": "^26.0.1"
-  },
-  "dependencies": {
-    "fancy-log": "^1.3.3"
   }
 }

packages/uxp-cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/uxp",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Command line interface for rapid UXP plugin development",
   "main": "index.js",
   "scripts": {

packages/uxp-cli/src/cli/commands/plugin/load.js

@@ -22,20 +22,28 @@ const loadOptions = {
         describe: "Space delimited list of app IDs into which the plugin should be loaded. The supported app IDs can be retrieved using `uxp apps list`. The default action is to load the plugin into all currently running apps specified in the plugin's manifest.",
         demandOption: false,
     },
+    breakOnStart: {
+        describe: "Blocks the plugin until a debugger attaches. If specified, attach is assumed, and a debugger will immediately be spawned. Defaults to false.",
+        demandOption: false,
+    }
 };
 
 function handlePluginLoadCommand(args) {
     const manifestRelPath = args.manifest ? args.manifest : "manifest.json";
     const manifest = path.resolve(manifestRelPath);
     const apps = args.apps ? args.apps.split(" ") : [];
+    const breakOnStart = (args.breakOnStart === "true") ? true : false;
     const params = {
         manifest,
         apps,
+        breakOnStart,
     };
 
     const prom = this.uxp.pluginMgr.loadPlugin(params);
     return prom.then((res) => {
-        this.log('Plugin Loaded Successfully.');
+        if (!breakOnStart) {
+            this.log('Plugin Loaded Successfully.');
+        }
         return res;
     });
 }

packages/uxp-cli/src/cli/commands/plugin/reload.js

@@ -27,7 +27,9 @@
 function handlePluginReloadCommand() {
     const prom = this.uxp.pluginMgr.reloadPlugin();
     return prom.then((res) => {
-        console.log("Plugin Reload successfull.");
+        if (res && !res.breakOnStart) {
+            console.log("Plugin Reload successfull.");
+        }
         return res;
     });
 }

packages/uxp-cli/src/core/client/PluginMgr.js

@@ -38,8 +38,8 @@ class PluginMgr {
     }
 
     debugPlugin(params) {
-        const pluginLoadCommand = new PluginDebugCommand(this, params);
-        return pluginLoadCommand.execute();
+        const pluginDebugCommand = new PluginDebugCommand(this, params);
+        return pluginDebugCommand.execute();
     }
 
     reloadPlugin() {

packages/uxp-cli/src/core/client/connection/CliClientController.js

@@ -93,6 +93,7 @@ class CliClientController {
         const url = `ws://localhost:${port}/socket/cli`;
         this._callerPromise = createDeferredPromise();
         this._connection.connect(this, url);
+        this._isConnected = true;
         return this._callerPromise.promise;
     }
 

packages/uxp-cli/src/core/client/plugin/actions/PluginLoadCommand.js

@@ -28,7 +28,7 @@ function validateManifest(manifestPath) {
     return report.manifest;
 }
 
-function createLoadMessage(pluginFolder) {
+function createLoadMessage(pluginFolder, breakOnStart) {
     const msg = {
         command: "Plugin",
         action: "load",
@@ -38,6 +38,7 @@ function createLoadMessage(pluginFolder) {
                 path: pluginFolder,
             },
         },
+        breakOnStart,
     };
     return msg;
 }
@@ -76,7 +77,7 @@ class PluginLoadCommand extends PluginBaseCommand {
             throw new Error("Load command didn't find any of the currently running apps applicable for loading this plugin. Make sure your target application is running and try again.");
         }
         const pluginFolder = path.dirname(this.params.manifest);
-        const loadJsonMsg = createLoadMessage(pluginFolder);
+        const loadJsonMsg = createLoadMessage(pluginFolder, this.params.breakOnStart);
         console.log(`Sending "Load Plugin" command to apps ${JSON.stringify(applicableAppsForLoading)}`);
         const loadReqProm = this.sendMessageToAppsWithReply(applicableAppsForLoading, loadJsonMsg);
         return loadReqProm.then((results) => {
@@ -98,8 +99,7 @@ class PluginLoadCommand extends PluginBaseCommand {
                 }
                 throw new Error("Plugin Load command failed. Failed to load in any of the connected apps");
             }
-            this._handlePluginLoadSuccess(successfulLoads);
-            return true;
+            return this._handlePluginLoadSuccess(successfulLoads);
         });
     }
 
@@ -108,6 +108,14 @@ class PluginLoadCommand extends PluginBaseCommand {
         // to a uxprc file so as to persist the state for later commands ( like plugin debug/log et al)
         this.pm._createPluginSession(pluginLoadResults);
         this.pm._saveCurrentPluginSession();
+        if (this.params.breakOnStart) {
+            console.log('The loading of the plugin is blocked. Waiting for a debugger to be launched.');
+            return this.pm.debugPlugin(this.params).then((res) => {
+                console.log("Launched standalone Chrome Developer Tools window.");
+                return res;
+            });
+        }
+        return true;
     }
 }
 

packages/uxp-cli/src/core/client/plugin/actions/PluginReloadCommand.js

@@ -42,7 +42,26 @@ class PluginReloadCommand extends PluginBaseCommand {
     }
 
     executeCommand() {
-        return this.runCommandOnAllApplicableApps(createReloadMessage);
+        const resultsCallback = this._handlePluginReloadResult.bind(this);
+        return this.runCommandOnAllApplicableApps(createReloadMessage, resultsCallback);
+    }
+
+    breakOnStartEnabled(result) {
+        const { data } = result;
+        return data && data.breakOnStart;
+    }
+
+    _handlePluginReloadResult(results) {
+        if (results.length > 0) {
+            if (this.breakOnStartEnabled(results[0])) {
+                console.log('The loading of the plugin is blocked. Waiting for a debugger to be launched.');
+                return this.pm.debugPlugin(this.params).then((res) => {
+                    console.log("Launched standalone Chrome Developer Tools window.");
+                    return { "breakOnStart" : true, res };
+                });
+            }
+        }
+        return true;
     }
 }
 

packages/uxp-cli/src/uxp.js

@@ -38,7 +38,9 @@ class UxpDevTools {
 
     setMode(mode) {
         const isServer = mode === "service";
-        this._devToolsMgr = new DevToolsMgr(isServer);
+        if (!this._devToolsMgr) {
+            this._devToolsMgr = new DevToolsMgr(isServer);
+        }
     }
 
     get devToolsMgr() {