chore: add html menu item support in CommandManager.register and 'Get Phoenix pro' in help

Author: abose

src/command/CommandManager.js

@@ -148,6 +148,15 @@ define(function (require, exports, module) {
         return this._enabled;
     };
 
+    /**
+     * get the command options
+     *
+     * @return {object}
+     */
+    Command.prototype.getOptions = function () {
+        return this._options || {};
+    };
+
     /**
      * Sets enabled state of Command and dispatches "enabledStateChange"
      * when the enabled state changes.
@@ -196,11 +205,17 @@ define(function (require, exports, module) {
      * use \uXXXX instead of an HTML entity.
      *
      * @param {string} name
+     * @param {string} htmlName If set, this will be displayed in ui menus instead of the name given.
+     *     Eg. "Phoenix menu<i class='fa fa-car' style='margin-left: 4px;'></i>"
      */
-    Command.prototype.setName = function (name) {
-        var changed = this._name !== name;
+    Command.prototype.setName = function (name, htmlName) {
+        let changed = this._name !== name;
         this._name = name;
 
+        if (htmlName && this._options.htmlName !== htmlName) {
+            changed = true;
+            this._options.htmlName = htmlName;
+        }
         if (changed) {
             this.trigger("nameChange");
         }
@@ -233,6 +248,8 @@ define(function (require, exports, module) {
      * @param {boolean} options.eventSource If set to true, the commandFn will be called with the first argument `event`
      * with details about the source(invoker) as event.eventSource(one of the `CommandManager.SOURCE_*`) and
      * event.sourceType(Eg. Ctrl-K) parameter.
+     * @param {string} options.htmlName If set, this will be displayed in ui menus instead of the name given.
+     *     Eg. "Phoenix menu<i class='fa fa-car' style='margin-left: 4px;'></i>"
      * @return {?Command}
      */
     function register(name, id, commandFn, options={}) {

src/command/Commands.js

@@ -405,6 +405,9 @@ define(function (require, exports, module) {
     /** Opens support resources */
     exports.HELP_SUPPORT                = "help.support";               // HelpCommandHandlers.js       _handleLinkMenuItem()
 
+    /** Opens Phoenix Pro page */
+    exports.HELP_GET_PRO                = "help.getPro";                // HelpCommandHandlers.js       _handleLinkMenuItem()
+
     /** Opens feature suggestion page */
     exports.HELP_SUGGEST                = "help.suggest";               // HelpCommandHandlers.js       _handleLinkMenuItem()
 

src/command/DefaultMenus.js

@@ -268,6 +268,8 @@ define(function (require, exports, module) {
         menu.addMenuItem(Commands.HELP_DOCS);
         menu.addMenuItem(Commands.HELP_SUPPORT);
         menu.addMenuDivider();
+        menu.addMenuItem(Commands.HELP_GET_PRO);
+        menu.addMenuDivider();
         if (brackets.config.suggest_feature_url) {
             menu.addMenuItem(Commands.HELP_SUGGEST);
         }

src/command/Menus.js

@@ -1108,6 +1108,11 @@ define(function (require, exports, module) {
                 }
             });
         } else {
+            const htmlName = this._command.getOptions().htmlName;
+            if(htmlName) {
+                $(_getHTMLMenuItem(this.id)).find(".menu-name").html(htmlName);
+                return;
+            }
             $(_getHTMLMenuItem(this.id)).find(".menu-name").text(this._command.getName());
         }
     };

src/help/HelpCommandHandlers.js

@@ -160,9 +160,14 @@ define(function (require, exports, module) {
         });
     });
 
+    const getProString = `${Strings.CMD_GET_PRO}<i class='fa fa-feather' style='margin-left: 4px;'></i>`;
+
     CommandManager.register(Strings.CMD_HOW_TO_USE_BRACKETS,    Commands.HELP_HOW_TO_USE_BRACKETS,  _handleLinkMenuItem(brackets.config.how_to_use_url));
     CommandManager.register(Strings.CMD_DOCS,                   Commands.HELP_DOCS,                 _handleLinkMenuItem(brackets.config.docs_url));
     CommandManager.register(Strings.CMD_SUPPORT,                Commands.HELP_SUPPORT,              _handleLinkMenuItem(brackets.config.support_url));
+    CommandManager.register(Strings.CMD_GET_PRO,                Commands.HELP_GET_PRO,              _handleLinkMenuItem(brackets.config.purchase_url), {
+        htmlName: getProString
+    });
     CommandManager.register(Strings.CMD_SUGGEST,                Commands.HELP_SUGGEST,              _handleLinkMenuItem(brackets.config.suggest_feature_url));
     CommandManager.register(Strings.CMD_REPORT_ISSUE,           Commands.HELP_REPORT_ISSUE,         _handleLinkMenuItem(brackets.config.report_issue_url));
     CommandManager.register(Strings.CMD_RELEASE_NOTES,          Commands.HELP_RELEASE_NOTES,        _handleLinkMenuItem(brackets.config.release_notes_url));

src/nls/root/strings.js

@@ -649,6 +649,7 @@ define({
     "CMD_AUTO_UPDATE": "Auto Update",
     "CMD_HOW_TO_USE_BRACKETS": "How to Use {APP_NAME}",
     "CMD_SUPPORT": "{APP_NAME} Support",
+    "CMD_GET_PRO": "Get Phoenix Pro",
     "CMD_USER_PROFILE": "{APP_NAME} Account",
     "CMD_DOCS": "Help, Getting Started",
     "CMD_SUGGEST": "Suggest a Feature",