Skip to content

feat: add lorem support in emmet-html #2152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abose merged 3 commits into from
Mar 1, 2025
Merged

feat: add lorem support in emmet-html #2152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00d87fd
feat: add lorem support in emmet-html
devvaannsh Feb 26, 2025
b5752bf
chore: write tests for lorem emmet
devvaannsh Feb 26, 2025
93a9199
fix: style overlapping issues in emmet hints
devvaannsh Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/extensions/default/HTMLCodeHints/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,13 +482,15 @@ define(function (require, exports, module) {
return null;
}

// the word must be either in markupSnippetsList, htmlList or it must have a positive symbol
// the word must be either in markupSnippetsList, htmlList or it must have a positive symbol or lorem text
// convert to lowercase only for `htmlTags` because HTML tag names are case-insensitive,
// but `markupSnippetsList` expands abbreviations in a non-tag manner,
// where the expanded abbreviation is already in lowercase.
if (markupSnippetsList.includes(word) ||
htmlTags.includes(word.toLowerCase()) ||
positiveSymbols.some(symbol => word.includes(symbol))) {
positiveSymbols.some(symbol => word.includes(symbol)) ||
word.toLowerCase().includes('lorem')
) {

try {
return expandAbbr(word, { syntax: "html", type: "markup" }); // expanded
Expand Down
92 changes: 63 additions & 29 deletions src/extensions/default/HTMLCodeHints/unittests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,25 @@ define(function (require, exports, module) {

// Modules from the SpecRunner window
const SpecRunnerUtils = brackets.getModule("spec/SpecRunnerUtils"),
Editor = brackets.getModule("editor/Editor").Editor,
HTMLCodeHints = require("main");
Editor = brackets.getModule("editor/Editor").Editor,
HTMLCodeHints = require("main");

require("integ-tests");

describe("unit: HTML Code Hinting", function () {

var defaultContent = "<!doctype html>\n" +
"<html>\n" +
"<style type=\"text/css\">\n" +
"</style>\n" +
"<body>\n" +
" <h1 id='foo'>Heading</h1>\n" + // tag without whitespace
" <h3 id = 'bar' >Subheading</h3>\n" + // tag with whitespace
" <p></p>\n" + // tag without attributes
" <h5 id='aaa' class='bbb'></h5>\n" + // tag with two attributes
" <div \n" + // incomplete tag
"</body>\n" +
"</html>\n";
"<html>\n" +
"<style type=\"text/css\">\n" +
"</style>\n" +
"<body>\n" +
" <h1 id='foo'>Heading</h1>\n" + // tag without whitespace
" <h3 id = 'bar' >Subheading</h3>\n" + // tag with whitespace
" <p></p>\n" + // tag without attributes
" <h5 id='aaa' class='bbb'></h5>\n" + // tag with two attributes
" <div \n" + // incomplete tag
"</body>\n" +
"</html>\n";

var testDocument, testEditor;

Expand Down Expand Up @@ -108,14 +108,14 @@ define(function (require, exports, module) {
it("should not hint within <style> block", function () { // (bug #1277)
// Replace default test content with code containing a <style> block
testDocument.setText("<!doctype html>\n" +
"<html>\n" +
"<head>\n" +
" <style>\n" +
" </style>\n" +
"</head>\n" +
"<body>\n" +
"</body>\n" +
"</html>\n");
"<html>\n" +
"<head>\n" +
" <style>\n" +
" </style>\n" +
"</head>\n" +
"<body>\n" +
"</body>\n" +
"</html>\n");

testEditor.setCursorPos({ line: 3, ch: 9 }); // cursor after the > in "<style>"
expectNoHints(HTMLCodeHints.tagHintProvider);
Expand Down Expand Up @@ -722,12 +722,12 @@ define(function (require, exports, module) {
// also test after inserting the hint
HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);

for(let i = 0; i <= 10; i++) {
for (let i = 0; i <= 10; i++) {
expect(testDocument.getLine(i)).toBe(emmetBoilerPlate[i]);
}

// make sure the cursor is between the body tag
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({line: 8, ch: 1}));
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({ line: 8, ch: 1 }));
});


Expand All @@ -745,7 +745,7 @@ define(function (require, exports, module) {
HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);
expect(testDocument.getLine(0)).toBe(emmetBoilerPlate);

expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({line: 0, ch: 15}));
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({ line: 0, ch: 15 }));
});

it("should not display hints when two or more than three exclamation marks are present", function () {
Expand Down Expand Up @@ -776,26 +776,26 @@ define(function (require, exports, module) {
HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);
expect(testDocument.getLine(0)).toBe("<div class=\"hello\" id=\"world\"></div>");

expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({line: 0, ch: 30}));
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({ line: 0, ch: 30 }));
});

it("./# should expand to a div with empty class/id name and set cursor in between quotes", function() {
it("./# should expand to a div with empty class/id name and set cursor in between quotes", function () {
testDocument.setText(".");
testEditor.setCursorPos({ line: 0, ch: 1 });
let hints = expectHints(HTMLCodeHints.emmetHintProvider);

HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({line: 0, ch: 12}));
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({ line: 0, ch: 12 }));

testDocument.setText("#");
testEditor.setCursorPos({ line: 0, ch: 1 });
hints = expectHints(HTMLCodeHints.emmetHintProvider);

HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({line: 0, ch: 9}));
expect(fixPos(testEditor.getCursorPos())).toEql(fixPos({ line: 0, ch: 9 }));
});

it("should expand emmet snippet with * and {}", function() {
it("should expand emmet snippet with * and {}", function () {
const emmetSnippetResult = "<ul>\n" +
" <li>hello world</li>\n" +
" <li>hello world</li>\n" +
Expand All @@ -812,6 +812,40 @@ define(function (require, exports, module) {
HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);
expect(testDocument.getText()).toBe(emmetSnippetResult);
});

it("should show emmet hint when lorem is typed and expand to lorem text", function () {
testDocument.setText("lorem");
testEditor.setCursorPos({ line: 0, ch: 5 });
const hints = expectHints(HTMLCodeHints.emmetHintProvider);

const hintText = hints[0][0].textContent;
expect(hintText).toBe("loremEmmet");

HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);

let text = testDocument.getText().toLowerCase();
text = text.split(" ")[0];
// add an extra space at the end to make sure that content after that is also present
// we cannot check with exact text because it generates randomly
text += ' ';
expect(text).toBe("lorem ");
});

it("should show emmet hint when lorem is typed along with some number and expand it", function () {
testDocument.setText("lorem1");
testEditor.setCursorPos({ line: 0, ch: 6 });
const hints = expectHints(HTMLCodeHints.emmetHintProvider);

const hintText = hints[0][0].textContent;
expect(hintText).toBe("lorem1Emmet");

HTMLCodeHints.emmetHintProvider.insertHint(hints[0]);

let text = testDocument.getText().toLowerCase();
// lorem1 expands to lorem.
// 1 here refers to the number of words
expect(text).toBe("lorem.");
});
});


Expand Down
4 changes: 4 additions & 0 deletions src/styles/brackets_patterns_override.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,10 @@ a:focus {
}
}

.emmet-hint {
margin-right: 48px !important;
}

.emmet-code-hint {
position: absolute;
font-size: 0.85em;
Expand Down
Loading