Move descriptions to their preferences #11201

sprintr · 2015-06-02T15:41:58Z

All the descriptions of the preferences have been moved to their preferences and we no longer have data.json 😄

marcelgerber · 2015-06-02T16:18:05Z

src/extensions/default/PrefsCodeHints/main.js

@@ -39,7 +39,16 @@ define(function (require, exports, module) {
        Strings             = brackets.getModule("strings"),
        ThemeManager        = brackets.getModule("view/ThemeManager"),
        _                   = brackets.getModule("thirdparty/lodash"),
-        data                = JSON.parse(require("text!data.json")),
+        data                = {


Maybe also add a comment stating what this data is used for.

abose · 2015-06-02T17:06:50Z

Fixes part of #11200

busykai · 2015-06-02T17:09:28Z

src/language/CodeInspection.js

-    prefs.definePreference(PREF_PREFER_PROVIDERS, "array", []);
+    prefs.definePreference(PREF_PREFER_PROVIDERS, "array", [], {
+        description: Strings.DESCRIPTION_LINTING_PREFER,
+        values: ["JSLint", "JSHint"],


This should not specify value.

Maybe it could autocomplete with the registered linters? That would be cool.

Yes, it could be done, I guess. My point, though, it should not have default in the property definition (there's no default for this pref).

Ok, I will add that.

Just to be clear: what I am asking you to do is to remove line 617. Hinting on registered plugins is not necessarily needed for this PR.

If you could just go ahead and remove this line (and also squash commits if you like), I could merge this PR in.

sprintr · 2015-06-05T20:27:09Z

@abose @marcelgerber I think it is ready for merging in.

TomMalbran · 2015-06-06T03:22:20Z

src/language/CodeInspection.js

+     * Returns an array of the IDs of providers registered for a specific language
+     *
+     * @param {!string} languageId
+     * @return {Array.<string>} Names of registered providers.


This should be {?Array.<string>}.
Or maybe it should return an empty array on the null case.

abose · 2015-06-06T08:54:09Z

src/extensions/default/HTMLCodeHints/main.js


-    PreferencesManager.definePreference("codehint.TagHints", "boolean", true);


why is codehint.TagHints is removed?

It is still there, I added description to it.

marcelgerber · 2015-06-07T13:50:22Z

src/extensions/default/PrefsCodeHints/main.js

        _                   = brackets.getModule("thirdparty/lodash"),
-        data                = JSON.parse(require("text!data.json")),
+        languages           = LanguageManager.getLanguages(),


We should also listen to the LanguageManager events languageAdded and languageModified (?).

You could do the same for the list of themes by listening to ExtensionManagers' statusChange event.

statusChange gets fired every time an extension gets loaded. We would need an event that is fired only when an extension gets installed/uninstalled, so we can update our preferences data.

Does it makes a big difference to have this once instead of calling it when getting the list of hints?

You are already doing it for the code hint providers. So I think we can do something similar for both languages and themes.

We can check if the AppInit.appReady has been called, after that we can update our preferences, theme data on each statusChange event.

AFAIK, all extensions are loaded after appReady has been called.

Not the ones you install after that, we need another event for that.

@marcelgerber I gave this a shot but since statusChange event is fired before the theme gets registered, ThemeManager.getAllThemes() still provides the old list of themes. But it works for getting code hints from newly installed extensions.

@marcelgerber @TomMalbran Theme hints are not cached anymore, that should fix the issue of themes. Languages will still use languageAdded event.

@sprintr I still don't see the point of having a cache of something that could be grabbed at the point of getting the hints like it is done with the code hint providers. getLanguages copies the object, but since you will have to iterate through the list eventually to create the ui, should be fine to get them on getHints when you actually need them. And the same goes for the themes, and maybe even the preferences. Seems easier than keeping a copy that needs to be synched.

sprintr · 2015-06-10T06:46:33Z

src/language/CodeInspection.js

+    function getProviderIDsForLanguage(languageId) {
+        if (!_providers[languageId]) {
+            return [];
+        }


@marcelgerber It now returns empty array.

marcelgerber · 2015-06-12T14:01:24Z

Merging. Thanks @sprintr.

Move descriptions to their preferences

abose · 2015-06-15T14:04:15Z

@sprintr the jasmine unit tests suite is failing after this PR merge commit. with the following error
Uncaught Error: Module name "language/CodeInspection" has not been loaded yet for context: _
Usually its a good idea to run the unit tests suite to catch errors like this :)

sprintr · 2015-06-15T15:34:34Z

@abose Debugging this right now. Seems a tricky one.

abose · 2015-06-16T07:10:17Z

Thanks @sprintr for the fix.
@marcelgerber Usually we go through a pass of unit tests, integration and extension tests as baseline(+additional test cases) before merging any pull requests. 🚕

marcelgerber · 2015-06-16T15:50:20Z

@abose I'm sorry. I've looked through all the changes and, well, I didn't expect unit test failures as all this PR changed is the added descriptions and one newly added function.
I'll be more careful the next time.

abose · 2015-06-16T17:42:44Z

@marcelgerber No probs :) We also used to do the same thing until we noticed that in some cases even minor changes could sometimes cause a ripple. So just stuck to doing the basic smokes just before merge.

marcelgerber reviewed Jun 2, 2015
View reviewed changes

abose added this to the Release 1.4 milestone Jun 2, 2015

busykai reviewed Jun 2, 2015
View reviewed changes

marcelgerber self-assigned this Jun 3, 2015

sprintr force-pushed the move-prefs-description branch from 48ebb5c to c7fd590 Compare June 5, 2015 20:15

sprintr force-pushed the move-prefs-description branch 2 times, most recently from ae95113 to 79e0895 Compare June 5, 2015 21:02

TomMalbran reviewed Jun 6, 2015
View reviewed changes

sprintr force-pushed the move-prefs-description branch from 79e0895 to 9eed7fe Compare June 6, 2015 08:47

abose reviewed Jun 6, 2015
View reviewed changes

sprintr force-pushed the move-prefs-description branch 2 times, most recently from d382851 to 52d1ed2 Compare June 6, 2015 08:59

marcelgerber reviewed Jun 7, 2015
View reviewed changes

sprintr force-pushed the move-prefs-description branch from 9443b60 to e105c29 Compare June 7, 2015 19:10

sprintr reviewed Jun 10, 2015
View reviewed changes

Move descriptions to their preferences

2917141

sprintr force-pushed the move-prefs-description branch from 147a1e8 to 2917141 Compare June 10, 2015 19:35

marcelgerber added a commit that referenced this pull request Jun 12, 2015

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

cc0bb85

Move descriptions to their preferences

marcelgerber merged commit cc0bb85 into adobe:master Jun 12, 2015

sprintr deleted the move-prefs-description branch June 12, 2015 19:34

sprintr mentioned this pull request Jun 15, 2015

Fix unittests #11275

Merged

marcelgerber mentioned this pull request Jun 23, 2015

Docs for Prefs code hints #11200

Closed

6 tasks

core-ai-bot mentioned this pull request Aug 30, 2021

[CLOSED] Move descriptions to their preferences brackets-archive/bracketsIssues#9791

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move descriptions to their preferences #11201

Move descriptions to their preferences #11201

sprintr commented Jun 2, 2015

marcelgerber Jun 2, 2015

abose commented Jun 2, 2015

busykai Jun 2, 2015

TomMalbran Jun 2, 2015

busykai Jun 2, 2015

sprintr Jun 2, 2015

busykai Jun 2, 2015

marcelgerber Jun 3, 2015

sprintr commented Jun 5, 2015

TomMalbran Jun 6, 2015

abose Jun 6, 2015

sprintr Jun 6, 2015

marcelgerber Jun 7, 2015

marcelgerber Jun 7, 2015

sprintr Jun 7, 2015

TomMalbran Jun 7, 2015

sprintr Jun 7, 2015

marcelgerber Jun 7, 2015

sprintr Jun 7, 2015

sprintr Jun 7, 2015

sprintr Jun 7, 2015

TomMalbran Jun 7, 2015

sprintr Jun 10, 2015

marcelgerber commented Jun 12, 2015

abose commented Jun 15, 2015

sprintr commented Jun 15, 2015

abose commented Jun 16, 2015

marcelgerber commented Jun 16, 2015

abose commented Jun 16, 2015


		PreferencesManager.definePreference("codehint.TagHints", "boolean", true);

Move descriptions to their preferences #11201

Move descriptions to their preferences #11201

Conversation

sprintr commented Jun 2, 2015

Choose a reason for hiding this comment

abose commented Jun 2, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sprintr commented Jun 5, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcelgerber commented Jun 12, 2015

abose commented Jun 15, 2015

sprintr commented Jun 15, 2015

abose commented Jun 16, 2015

marcelgerber commented Jun 16, 2015

abose commented Jun 16, 2015