Added HtmlSpecialCharsCodeHints as default extension #3237

WebsiteDeveloper · 2013-03-24T16:12:20Z

I added CodeCompletition for HtmlSpecialChars as requested in https://trello.com/card/code-completion-for-special-characters/4f90a6d98f77505d7940ce88/826

TomMalbran · 2013-03-26T00:31:44Z

This looks great. I have a few suggestions:

It would be nice if this worked for other languages besides HTML like PHP and JavaScript and others, even in CSS it might be useful for the pseudo elements.
You might want to use a case insensitive compare function in the sort.

redmunds · 2013-03-26T00:51:52Z

@TomMalbran Character entity references are case-sensitive. For example, &dagger and &Dagger are different characters.

redmunds · 2013-03-26T00:56:33Z

src/extensions/default/HtmlSpecialCharsCodeHints/SpecialChars.json

@@ -0,0 +1,104 @@
+[
+    "&lsquo", "&rsquo", "&sbquo", "&ldquo", "&rdquo", "&bdquo",


I think it will be easier to manage this list if it's a single column sorted alphabetically

TomMalbran · 2013-03-26T01:00:43Z

I know, what I mean is that it would be better if for example á = á would comes after Á = Á. Right now it shows all the capital letter special chars first and then all the lower letter special chars. The sort could compare first in lower case, and then in upper case for equal cases.

[Randy] Sorry, I read you comment wrong.

redmunds · 2013-03-26T01:05:56Z

src/extensions/default/HtmlSpecialCharsCodeHints/main.js

+        // Register code hint providers
+        var specialCharHints = new SpecialCharHints();
+
+        CodeHintManager.registerHintProvider(specialCharHints, ["html"], 0);


I'm seeing a weird problem in this case:

Start with a paragraph: <p></p>

Place cursor between the open and closing tags and type "&"

The entity hint list is displayed as expected

Press Esc to dismiss list

Press Ctrl-space to re-invoke the hints list

Results:
Hints list is displayed, but it's a list of HTML Tags!

It might have something to do with using a priority of 0 to register these hints, which is the default priority. On the other hand, there should be no conflicts with the HTML hints, so not really sure.

actually it the problem is, that the HTML tags hint provider can also provide hints for those and gets called before the specialCharHints, but when i changed the priority to one plus a few other tweaks in the has hints function it worked.
So fixed.

That problem is fixed, but I'm seeing another problem I think it related. Code hints work correctly inside of a tag, but if I type a "raw" & I don't get the hints. For example:

<body> & </body>

redmunds · 2013-03-26T01:11:10Z

I'm seeing the entity hints displayed if I type an ampersand inside an attribute value string. For example: <a href="results.html?id=3&lang=en">click me</a>.

redmunds · 2013-03-26T01:24:32Z

src/extensions/default/HtmlSpecialCharsCodeHints/main.js

+            this.currentQuery = query = this._getQuery();
+            result = $.map(specialChars, function (value, index) {
+                if (value.indexOf(query) === 0) {
+                    return value + " <span style=\"float: right;\">" + value + ";</span>";


Create a class and apply class to span tag, instead of inline css.

Also, the code looks cleaner if you nest single-quotes inside of double-quotes:

return value + " <span class='entity-display-char'>" + value + ";</span>";

fixed.
should i add the style to the brackets.less file?

No, you should create a CSS file in your extension directory and load it with ExtensionUtils.loadStyleSheet(module, "styles.css"); on AppInit.htmlReady.

i added that.

redmunds · 2013-03-26T01:39:55Z

Done with initial review.

redmunds · 2013-03-26T02:55:56Z

I found some more entities listed here: http://www.w3.org/TR/html4/sgml/entities.html

WebsiteDeveloper · 2013-03-26T11:21:55Z

@redmunds i adressed the issues you remarked.
So ready for re-review

redmunds · 2013-03-27T02:12:28Z

The trailing ; char should be displayed in list so user sees what they will get. For example, display   instead of &nbsp .

redmunds · 2013-03-27T02:18:21Z

The numerical entities should be ordered by numerical value, not string value. For example, I see (skipping some values fro brevity):

&#125;
&#33;
&#8226;
&#91;

But it should be:

&#33;
&#91;
&#125;
&#8226;

redmunds · 2013-03-27T02:22:41Z

Thanks for adding he other entities I found. There are typos: &asyp; should be ≈, and &exists; should be ∃

redmunds · 2013-03-27T02:29:00Z

I think the name of this extension is too long. Please rename to: HtmlEntityCodeHints

redmunds · 2013-03-27T02:34:02Z

src/extensions/default/HtmlSpecialCharsCodeHints/main.js

+            return query !== null;
+        } else {
+            return implicitChar === "&" || query !== null;
+        }


You don't need else, and removing it makes it easier to see that something is returned in all cases:

if (implicitChar === null) { return query !== null; } return implicitChar === "&" || query !== null;

redmunds · 2013-03-27T02:48:16Z

Done with second code review.

WebsiteDeveloper · 2013-03-27T18:02:12Z

@redmunds all issues adressed, ready for another review.

redmunds · 2013-03-27T18:10:32Z

src/extensions/default/HtmlEntityCodeHints/SpecialChars.json

+    "&ang",
+    "&aring",
+    "&Aring",
+    "&asymp",


I guess you didn't see the edit to my previous comment, but ≈ is missing (was a typo).

@redmunds already readded both

redmunds · 2013-03-27T18:51:43Z

src/extensions/default/HtmlEntityCodeHints/main.js

+                }
+
+                return a.localeCompare(b);
+            });


Move this code to a named function that you can pass to the sort() method.

redmunds · 2013-03-27T18:52:44Z

This looks great. One last comment!

WebsiteDeveloper · 2013-03-27T19:41:16Z

@redmunds calling for another review (hopefully the last)

redmunds · 2013-03-27T20:23:43Z

Looks good. Merging.

Added HtmlSpecialCharsCodeHints as default extension

Added HtmlSpecialCharsCodeHints as default extension

32f8988

ghost assigned redmunds Mar 26, 2013

redmunds reviewed Mar 26, 2013
View reviewed changes

WebsiteDeveloper added 4 commits March 26, 2013 09:41

A few fixes after review

36241a5

A bit cleanup

41816aa

Workaround for a display bug

f938314

Included a few missing special chars

de474ba

redmunds reviewed Mar 27, 2013
View reviewed changes

WebsiteDeveloper added 2 commits March 27, 2013 18:52

Adressed issues after second review

603fecb

Addressed issues after second review

8a8d29c

Fixed two typos

b2fa0b8

redmunds reviewed Mar 27, 2013
View reviewed changes

Fixed an error while committing

8f914fb

redmunds reviewed Mar 27, 2013
View reviewed changes

Fixed issues after third review

a9e89cf

redmunds added a commit that referenced this pull request Mar 27, 2013

Merge pull request #3237 from WebsiteDeveloper/HtmlSpecialCharsCodeHints

cb738dd

Added HtmlSpecialCharsCodeHints as default extension

redmunds merged commit cb738dd into adobe:master Mar 27, 2013

peterflynn mentioned this pull request Apr 4, 2013

Code hints broken for rest of line after HTML entity #3339

Closed

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

[CLOSED] Added HtmlSpecialCharsCodeHints as default extension brackets-archive/bracketsIssues#3042

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added HtmlSpecialCharsCodeHints as default extension #3237

Added HtmlSpecialCharsCodeHints as default extension #3237

WebsiteDeveloper commented Mar 24, 2013

TomMalbran commented Mar 26, 2013

redmunds commented Mar 26, 2013

redmunds Mar 26, 2013

TomMalbran commented Mar 26, 2013

redmunds Mar 26, 2013

WebsiteDeveloper Mar 26, 2013

redmunds Mar 27, 2013

redmunds commented Mar 26, 2013

redmunds Mar 26, 2013

WebsiteDeveloper Mar 26, 2013

TomMalbran Mar 26, 2013

WebsiteDeveloper Mar 26, 2013

redmunds commented Mar 26, 2013

redmunds commented Mar 26, 2013

WebsiteDeveloper commented Mar 26, 2013

redmunds commented Mar 27, 2013

redmunds commented Mar 27, 2013

redmunds commented Mar 27, 2013

redmunds commented Mar 27, 2013

redmunds Mar 27, 2013

redmunds commented Mar 27, 2013

WebsiteDeveloper commented Mar 27, 2013

redmunds Mar 27, 2013

WebsiteDeveloper Mar 27, 2013

redmunds Mar 27, 2013

redmunds commented Mar 27, 2013

WebsiteDeveloper commented Mar 27, 2013

redmunds commented Mar 27, 2013

		@@ -0,0 +1,104 @@
		[
		"&lsquo", "&rsquo", "&sbquo", "&ldquo", "&rdquo", "&bdquo",

Added HtmlSpecialCharsCodeHints as default extension #3237

Added HtmlSpecialCharsCodeHints as default extension #3237

Conversation

WebsiteDeveloper commented Mar 24, 2013

TomMalbran commented Mar 26, 2013

redmunds commented Mar 26, 2013

Choose a reason for hiding this comment

TomMalbran commented Mar 26, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redmunds commented Mar 26, 2013

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

redmunds commented Mar 26, 2013

redmunds commented Mar 26, 2013

WebsiteDeveloper commented Mar 26, 2013

redmunds commented Mar 27, 2013

redmunds commented Mar 27, 2013

redmunds commented Mar 27, 2013

redmunds commented Mar 27, 2013

Choose a reason for hiding this comment

redmunds commented Mar 27, 2013

WebsiteDeveloper commented Mar 27, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

redmunds commented Mar 27, 2013

WebsiteDeveloper commented Mar 27, 2013

redmunds commented Mar 27, 2013