Merge pull request #11201 from sprintr/move-prefs-description

marcelgerber · marcelgerber · commit cc0bb8527e0f · 2015-06-12T16:01:27.000+02:00
Move descriptions to their preferences
diff --git a/src/extensions/default/CSSCodeHints/main.js b/src/extensions/default/CSSCodeHints/main.js
@@ -37,11 +37,14 @@ define(function (require, exports, module) {
         TokenUtils          = brackets.getModule("utils/TokenUtils"),
         StringMatch         = brackets.getModule("utils/StringMatch"),
         ColorUtils          = brackets.getModule("utils/ColorUtils"),
+        Strings             = brackets.getModule("strings"),
         CSSProperties       = require("text!CSSProperties.json"),
         properties          = JSON.parse(CSSProperties);
 
 
-    PreferencesManager.definePreference("codehint.CssPropHints", "boolean", true);
+    PreferencesManager.definePreference("codehint.CssPropHints", "boolean", true, {
+        description: Strings.DESCRIPTION_CSS_PROP_HINTS
+    });
     
     // Context of the last request for hints: either CSSUtils.PROP_NAME,
     // CSSUtils.PROP_VALUE or null.
diff --git a/src/extensions/default/HTMLCodeHints/main.js b/src/extensions/default/HTMLCodeHints/main.js
@@ -33,15 +33,19 @@ define(function (require, exports, module) {
         CodeHintManager     = brackets.getModule("editor/CodeHintManager"),
         HTMLUtils           = brackets.getModule("language/HTMLUtils"),
         PreferencesManager  = brackets.getModule("preferences/PreferencesManager"),
+        Strings             = brackets.getModule("strings"),
         HTMLTags            = require("text!HtmlTags.json"),
         HTMLAttributes      = require("text!HtmlAttributes.json"),
         tags,
         attributes;
 
+    PreferencesManager.definePreference("codehint.TagHints", "boolean", true, {
+        description: Strings.DESCRIPTION_HTML_TAG_HINTS
+    });
 
-    PreferencesManager.definePreference("codehint.TagHints", "boolean", true);
-
-    PreferencesManager.definePreference("codehint.AttrHints", "boolean", true);
+    PreferencesManager.definePreference("codehint.AttrHints", "boolean", true, {
+        description: Strings.DESCRIPTION_ATTR_HINTS
+    });
 
     /**
      * @constructor
diff --git a/src/extensions/default/HtmlEntityCodeHints/main.js b/src/extensions/default/HtmlEntityCodeHints/main.js
@@ -34,11 +34,14 @@ define(function (require, exports, module) {
         ExtensionUtils      = brackets.getModule("utils/ExtensionUtils"),
         HTMLUtils           = brackets.getModule("language/HTMLUtils"),
         PreferencesManager  = brackets.getModule("preferences/PreferencesManager"),
+        Strings             = brackets.getModule("strings"),
         HtmlSpecialChars    = require("text!SpecialChars.json"),
         specialChars;
 
 
-    PreferencesManager.definePreference("codehint.SpecialCharHints", "boolean", true);
+    PreferencesManager.definePreference("codehint.SpecialCharHints", "boolean", true, {
+        description: Strings.DESCRIPTION_SPECIAL_CHAR_HINTS
+    });
 
     /**
      * Encodes the special Char value given. 
diff --git a/src/extensions/default/PrefsCodeHints/data.json b/src/extensions/default/PrefsCodeHints/data.json
diff --git a/src/extensions/default/PrefsCodeHints/main.js b/src/extensions/default/PrefsCodeHints/main.js
@@ -38,11 +38,24 @@ define(function (require, exports, module) {
         JSONUtils           = brackets.getModule("language/JSONUtils"),
         Strings             = brackets.getModule("strings"),
         ThemeManager        = brackets.getModule("view/ThemeManager"),
+        CodeInspection      = brackets.getModule("language/CodeInspection"),
         _                   = brackets.getModule("thirdparty/lodash"),
-        data                = JSON.parse(require("text!data.json")),
+        languages           = LanguageManager.getLanguages(),
         isPrefDocument      = false,
         isPrefHintsEnabled  = false;
     
+    // Stores data of preferences used by Brackets and its core/thirdparty extensions.
+    var data = {
+        language: {
+            type: "object",
+            description: Strings.DESCRIPTION_LANGUAGE
+        },
+        path: {
+            type: "object",
+            description: Strings.DESCRIPTION_PATH
+        }
+    };
+    
     var stringMatcherOptions = {
         preferPrefixMatches: true
     };
@@ -85,7 +98,7 @@ define(function (require, exports, module) {
         return (/^\.?brackets\.json$/).test(document.file._name);
     }
     
-    // Set listeners on preference and editor changes.
+    // Set listeners on preference, editor and language changes.
     PreferencesManager.on("change", "showCodeHints", function () {
         isPrefHintsEnabled = _isPrefHintsEnabled();
     });
@@ -98,6 +111,9 @@ define(function (require, exports, module) {
         }
         isPrefHintsEnabled = _isPrefHintsEnabled();
     });
+    LanguageManager.on("languageAdded", function () {
+        languages = LanguageManager.getLanguages();
+    });
     
     /*
      * Returns a sorted and formatted list of hints with the query substring
@@ -169,11 +185,6 @@ define(function (require, exports, module) {
                 data[pref].keys = _.clone(preference.keys);
             }
         });
-        
-        // Add installed themes to code hints.
-        data["themes.theme"].values = ThemeManager.getAllThemes().map(function (theme) {
-            return theme.name;
-        });
     }
     
     /**
@@ -224,7 +235,7 @@ define(function (require, exports, module) {
                 if (data[ctxInfo.parentKeyName] && data[ctxInfo.parentKeyName].keys) {
                     keys = data[ctxInfo.parentKeyName].keys;
                 } else if (ctxInfo.parentKeyName === "language") {
-                    keys = LanguageManager.getLanguages();
+                    keys = languages;
                     option.type = "object";
                 } else {
                     keys = data;
@@ -235,7 +246,7 @@ define(function (require, exports, module) {
                         var match = StringMatch.stringMatch(key, query, stringMatcherOptions);
                         if (match) {
                             match.type = keys[key].type || option.type;
-                            match.description = keys[key].description || Strings[keys[key].string] || null;
+                            match.description = keys[key].description || null;
                             return match;
                         }
                     }
@@ -257,9 +268,15 @@ define(function (require, exports, module) {
                 } else if (option && option.values && (["number", "string"].indexOf(option.type) !== -1 ||
                                                        (option.type === "array" && ctxInfo.isArray))) {
                     values = option.values;
+                } else if (ctxInfo.isArray && ctxInfo.keyName === "linting.prefer" && languages[ctxInfo.parentKeyName]) {
+                    values = CodeInspection.getProviderIDsForLanguage(ctxInfo.parentKeyName);
+                } else if (ctxInfo.keyName === "themes.theme") {
+                    values = ThemeManager.getAllThemes().map(function (theme) {
+                        return theme.name;
+                    });
                 } else if (ctxInfo.parentKeyName === "language.fileExtensions" ||
                            ctxInfo.parentKeyName === "language.fileNames") {
-                    values = Object.keys(LanguageManager.getLanguages());
+                    values = Object.keys(languages);
                 } else {
                     return null;
                 }
@@ -269,7 +286,7 @@ define(function (require, exports, module) {
                     var match = StringMatch.stringMatch(value, query, stringMatcherOptions);
                     if (match) {
                         match.type = option.valueType || option.type;
-                        match.description = Strings[option.string] || option.description || null;
+                        match.description = option.description || null;
                         return match;
                     }
                 });
diff --git a/src/extensions/default/StaticServer/StaticServer.js b/src/extensions/default/StaticServer/StaticServer.js
@@ -31,7 +31,8 @@ define(function (require, exports, module) {
 
     var BaseServer           = brackets.getModule("LiveDevelopment/Servers/BaseServer").BaseServer,
         LiveDevelopmentUtils = brackets.getModule("LiveDevelopment/LiveDevelopmentUtils"),
-        PreferencesManager   = brackets.getModule("preferences/PreferencesManager");
+        PreferencesManager   = brackets.getModule("preferences/PreferencesManager"),
+        Strings              = brackets.getModule("strings");
 
     
     /**
@@ -41,7 +42,9 @@ define(function (require, exports, module) {
      */
     var _prefs = PreferencesManager.getExtensionPrefs("staticserver");
 
-    _prefs.definePreference("port", "number", 0);
+    _prefs.definePreference("port", "number", 0, {
+        description: Strings.DESCRIPTION_STATIC_SERVER_PORT
+    });
 
     /**
      * @constructor
diff --git a/src/extensions/default/UrlCodeHints/main.js b/src/extensions/default/UrlCodeHints/main.js
@@ -37,16 +37,18 @@ define(function (require, exports, module) {
         PreferencesManager  = brackets.getModule("preferences/PreferencesManager"),
         ProjectManager      = brackets.getModule("project/ProjectManager"),
         StringUtils         = brackets.getModule("utils/StringUtils"),
-
-        Data            = require("text!data.json"),
+        Strings             = brackets.getModule("strings"),
+        Data                = require("text!data.json"),
 
         urlHints,
         data,
         htmlAttrs,
         styleModes      = ["css", "text/x-less", "text/x-scss"];
 
 
-    PreferencesManager.definePreference("codehint.UrlCodeHints", "boolean", true);
+    PreferencesManager.definePreference("codehint.UrlCodeHints", "boolean", true, {
+        description: Strings.DESCRIPTION_URL_CODE_HINTS
+    });
 
     /**
      * @constructor
diff --git a/src/language/CodeInspection.js b/src/language/CodeInspection.js
@@ -198,6 +198,21 @@ define(function (require, exports, module) {
         return providers;
     }
 
+    /**
+     * Returns an array of the IDs of providers registered for a specific language
+     *
+     * @param {!string} languageId
+     * @return {Array.<string>} Names of registered providers.
+     */
+    function getProviderIDsForLanguage(languageId) {
+        if (!_providers[languageId]) {
+            return [];
+        }
+        return _providers[languageId].map(function (provider) {
+            return provider.name;
+        });
+    }
+
     /**
      * Runs a file inspection over passed file. Uses the given list of providers if specified, otherwise uses
      * the set of providers that are registered for the file's language.
@@ -608,11 +623,18 @@ define(function (require, exports, module) {
             toggleCollapsed(prefs.get(PREF_COLLAPSED), true);
         });
     
-    prefs.definePreference(PREF_ASYNC_TIMEOUT, "number", 10000);
+    prefs.definePreference(PREF_ASYNC_TIMEOUT, "number", 10000, {
+        description: Strings.DESCRIPTION_ASYNC_TIMEOUT
+    });
 
-    prefs.definePreference(PREF_PREFER_PROVIDERS, "array", []);
+    prefs.definePreference(PREF_PREFER_PROVIDERS, "array", [], {
+        description: Strings.DESCRIPTION_LINTING_PREFER,
+        valueType: "string"
+    });
 
-    prefs.definePreference(PREF_PREFERRED_ONLY, "boolean", false);
+    prefs.definePreference(PREF_PREFERRED_ONLY, "boolean", false, {
+        description: Strings.DESCRIPTION_USE_PREFERED_ONLY
+    });
 
     // Initialize items dependent on HTML DOM
     AppInit.htmlReady(function () {
@@ -681,10 +703,11 @@ define(function (require, exports, module) {
     exports._PREF_PREFERRED_ONLY    = PREF_PREFERRED_ONLY;
 
     // Public API
-    exports.register            = register;
-    exports.Type                = Type;
-    exports.toggleEnabled       = toggleEnabled;
-    exports.inspectFile         = inspectFile;
-    exports.requestRun          = run;
-    exports.getProvidersForPath = getProvidersForPath;
+    exports.register                    = register;
+    exports.Type                        = Type;
+    exports.toggleEnabled               = toggleEnabled;
+    exports.inspectFile                 = inspectFile;
+    exports.requestRun                  = run;
+    exports.getProvidersForPath         = getProvidersForPath;
+    exports.getProviderIDsForLanguage   = getProviderIDsForLanguage;
 });
diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js
@@ -714,6 +714,7 @@ define({
     "DESCRIPTION_LANGUAGE_FILE_EXTENSIONS"           : "Additional mappings from file extension to language name",
     "DESCRIPTION_LANGUAGE_FILE_NAMES"                : "Additional mappings from file name to language name",
     "DESCRIPTION_LINTING_ENABLED"                    : "True to enable Code Inspection",
+    "DESCRIPTION_ASYNC_TIMEOUT"                      : "The time in milliseconds after which asynchronous linters time out",
     "DESCRIPTION_LINTING_PREFER"                     : "Array of linters to run first",
     "DESCRIPTION_LIVE_DEV_MULTIBROWSER"              : "True to enable experimental Live Preview",
     "DESCRIPTION_USE_PREFERED_ONLY"                  : "True to run providers specified in linting.prefer only",
