testea/test-repo
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Handlebars: Improve HTML void element check (#14110)

Browse Source
This commit is contained in:
fisker Cheung authored and GitHub committed 2023-01-22 21:50:42 +08:00
1 parent 62195dd1f2
commit 310a5b1ba5
13 files changed
+523 -62
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

cspell.json
+1
View File
@@ -33,6 +33,7 @@
"Bekkelund",
"Bento",
"bfnrt",
"bgsound",
"binaryish",
"bindon",
"bitshift",
package.json
-1
View File
@@ -57,7 +57,6 @@
"html-element-attributes": "3.1.0",
"html-styles": "1.0.0",
"html-tag-names": "2.0.1",
"html-void-elements": "2.0.1",
"ignore": "5.2.0",
"jest-docblock": "28.1.1",
"json5": "2.2.2",
scripts/vendors/vendor-meta.json
Vendored
-24
View File
@@ -6,7 +6,6 @@
"execa": "execa.js",
"html-element-attributes": "html-element-attributes.json",
"html-tag-names": "html-tag-names.json",
"html-void-elements": "html-void-elements.json",
"leven": "leven.js",
"mem": "mem.js",
"sdbm": "sdbm.js",
@@ -396,29 +395,6 @@
}
]
},
{
"name": "html-void-elements",
"maintainers": [],
"version": "2.0.1",
"description": "List of HTML void tag names",
"repository": "wooorm/html-void-elements",
"homepage": null,
"private": false,
"license": "MIT",
"licenseText": "(The MIT License)\n\nCopyright (c) 2016 Titus Wormer <tituswormer@gmail.com>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n",
"author": {
"name": "Titus Wormer",
"email": "tituswormer@gmail.com",
"url": "https://wooorm.com"
},
"contributors": [
{
"name": "Titus Wormer",
"email": "tituswormer@gmail.com",
"url": "https://wooorm.com"
}
]
},
{
"name": "leven",
"maintainers": [],
scripts/vendors/vendors.mjs
Vendored
-1
View File
@@ -5,7 +5,6 @@ const vendors = [
"execa",
"html-element-attributes",
"html-tag-names",
"html-void-elements",
"leven",
"mem",
"sdbm",
src/language-handlebars/html-void-elements.evaluate.js
+7
View File
@@ -0,0 +1,7 @@
"use strict";
const {
voidMap,
} = require("@glimmer/syntax/dist/commonjs/es2017/lib/generation/printer.js");
module.exports = Object.keys(voidMap);
src/language-handlebars/utils.js
+7 -2
View File
@@ -1,7 +1,7 @@
"use strict";
const { htmlVoidElements } = require("../../vendors/html-void-elements.json");
const getLast = require("../utils/get-last.js");
const htmlVoidElements = require("./html-void-elements.evaluate.js");
function isLastNodeOfSiblings(path) {
const node = path.getValue();
@@ -38,10 +38,15 @@ function isGlimmerComponent(node) {
}
const voidTags = new Set(htmlVoidElements);
// https://github.com/glimmerjs/glimmer-vm/blob/ec5648f3895b9ab8d085523be001553746221449/packages/%40glimmer/syntax/lib/generation/printer.ts#L44-L46
function isVoidTag(tag) {
return voidTags.has(tag.toLowerCase()) && !isUppercase(tag[0]);
}
function isVoid(node) {
return (
voidTags.has(node.tag) ||
node.selfClosing === true ||
isVoidTag(node.tag) ||
(isGlimmerComponent(node) &&
node.children.every((node) => isWhitespaceNode(node)))
);
tests/format/handlebars/element-node/__snapshots__/jsfmt.spec.js.snap
+99
View File
@@ -111,3 +111,102 @@ printWidth: 80
<Component />
================================================================================
`;
exports[`snippet: basefont format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<basefont> text </basefont>
=====================================output=====================================
<basefont> text </basefont>
================================================================================
`;
exports[`snippet: bgsound format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<bgsound> text </bgsound>
=====================================output=====================================
<bgsound> text </bgsound>
================================================================================
`;
exports[`snippet: frame format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<frame> text </frame>
=====================================output=====================================
<frame> text </frame>
================================================================================
`;
exports[`snippet: image format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<image> text </image>
=====================================output=====================================
<image> text </image>
================================================================================
`;
exports[`snippet: isindex format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<isindex> text </isindex>
=====================================output=====================================
<isindex> text </isindex>
================================================================================
`;
exports[`snippet: menuitem format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<menuitem> text </menuitem>
=====================================output=====================================
<menuitem> text </menuitem>
================================================================================
`;
exports[`snippet: nextid format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<nextid> text </nextid>
=====================================output=====================================
<nextid> text </nextid>
================================================================================
`;
exports[`void-elements.hbs format 1`] = `
====================================options=====================================
parsers: ["glimmer"]
printWidth: 80
| printWidth
=====================================input======================================
<img>
<input>
=====================================output=====================================
<img />
<input />
================================================================================
`;
tests/format/handlebars/element-node/jsfmt.spec.js
+22 -1
View File
@@ -1 +1,22 @@
run_spec(__dirname, ["glimmer"]);
run_spec(
{
dirname: __dirname,
/*
Missed HTML void tags in glimmer parser
https://github.com/glimmerjs/glimmer-vm/blob/ec5648f3895b9ab8d085523be001553746221449/packages/%40glimmer/syntax/lib/parser/tokenizer-event-handlers.ts#LL7C13-L7C13
https://github.com/glimmerjs/glimmer-vm/blob/ec5648f3895b9ab8d085523be001553746221449/packages/%40glimmer/syntax/lib/generation/printer.ts#L8-L9
Please move tags to `tests/format/misc/errors/handlebars/jsfmt.spec.js`
when removing from this list
*/
snippets: [
"basefont",
"bgsound",
"frame",
"image",
"isindex",
"menuitem",
"nextid",
].map((tag) => ({ name: tag, code: `<${tag}> text </${tag}>` })),
},
["glimmer"]
);
tests/format/handlebars/element-node/void-elements.hbs
+2
View File
@@ -0,0 +1,2 @@
<img>
<input>
tests/format/misc/errors/handlebars/__snapshots__/jsfmt.spec.js.snap
+336
View File
@@ -38,6 +38,342 @@ Expecting 'OPEN_SEXPR', 'ID', 'STRING', 'NUMBER', 'BOOLEAN', 'UNDEFINED', 'NULL'
4 |"
`;
exports[`snippet: IMG [glimmer] format 1`] = `
"Unclosed element \`IMG\`:
|
| <IMG>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <IMG>
| ^^^^^"
`;
exports[`snippet: INPUT [glimmer] format 1`] = `
"Unclosed element \`INPUT\`:
|
| <INPUT>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <INPUT>
| ^^^^^^^"
`;
exports[`snippet: area [glimmer] format 1`] = `
"<area> elements do not need end tags. You should remove it:
|
| </area>
|
(error occurred in 'an unknown module' @ line 1 : column 6) (1:6)
> 1 | <area></area>
| ^^^^^^^"
`;
exports[`snippet: base [glimmer] format 1`] = `
"<base> elements do not need end tags. You should remove it:
|
| </base>
|
(error occurred in 'an unknown module' @ line 1 : column 6) (1:6)
> 1 | <base></base>
| ^^^^^^^"
`;
exports[`snippet: basefont [glimmer] format 1`] = `
"Unclosed element \`basefont\`:
|
| <basefont>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <basefont>
| ^^^^^^^^^^"
`;
exports[`snippet: bgsound [glimmer] format 1`] = `
"Unclosed element \`bgsound\`:
|
| <bgsound>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <bgsound>
| ^^^^^^^^^"
`;
exports[`snippet: br [glimmer] format 1`] = `
"<br> elements do not need end tags. You should remove it:
|
| </br>
|
(error occurred in 'an unknown module' @ line 1 : column 4) (1:4)
> 1 | <br></br>
| ^^^^^"
`;
exports[`snippet: col [glimmer] format 1`] = `
"<col> elements do not need end tags. You should remove it:
|
| </col>
|
(error occurred in 'an unknown module' @ line 1 : column 5) (1:5)
> 1 | <col></col>
| ^^^^^^"
`;
exports[`snippet: command [glimmer] format 1`] = `
"<command> elements do not need end tags. You should remove it:
|
| </command>
|
(error occurred in 'an unknown module' @ line 1 : column 9) (1:9)
> 1 | <command></command>
| ^^^^^^^^^^"
`;
exports[`snippet: div [glimmer] format 1`] = `
"Unclosed element \`div\`:
|
| <div>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <div>
| ^^^^^"
`;
exports[`snippet: embed [glimmer] format 1`] = `
"<embed> elements do not need end tags. You should remove it:
|
| </embed>
|
(error occurred in 'an unknown module' @ line 1 : column 7) (1:7)
> 1 | <embed></embed>
| ^^^^^^^^"
`;
exports[`snippet: frame [glimmer] format 1`] = `
"Unclosed element \`frame\`:
|
| <frame>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <frame>
| ^^^^^^^"
`;
exports[`snippet: hr [glimmer] format 1`] = `
"<hr> elements do not need end tags. You should remove it:
|
| </hr>
|
(error occurred in 'an unknown module' @ line 1 : column 4) (1:4)
> 1 | <hr></hr>
| ^^^^^"
`;
exports[`snippet: imG [glimmer] format 1`] = `
"Unclosed element \`imG\`:
|
| <imG>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <imG>
| ^^^^^"
`;
exports[`snippet: image [glimmer] format 1`] = `
"Unclosed element \`image\`:
|
| <image>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <image>
| ^^^^^^^"
`;
exports[`snippet: img [glimmer] format 1`] = `
"<img> elements do not need end tags. You should remove it:
|
| </img>
|
(error occurred in 'an unknown module' @ line 1 : column 5) (1:5)
> 1 | <img></img>
| ^^^^^^"
`;
exports[`snippet: input [glimmer] format 1`] = `
"<input> elements do not need end tags. You should remove it:
|
| </input>
|
(error occurred in 'an unknown module' @ line 1 : column 7) (1:7)
> 1 | <input></input>
| ^^^^^^^^"
`;
exports[`snippet: isindex [glimmer] format 1`] = `
"Unclosed element \`isindex\`:
|
| <isindex>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <isindex>
| ^^^^^^^^^"
`;
exports[`snippet: keygen [glimmer] format 1`] = `
"<keygen> elements do not need end tags. You should remove it:
|
| </keygen>
|
(error occurred in 'an unknown module' @ line 1 : column 8) (1:8)
> 1 | <keygen></keygen>
| ^^^^^^^^^"
`;
exports[`snippet: lINk [glimmer] format 1`] = `
"Unclosed element \`lINk\`:
|
| <lINk>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <lINk>
| ^^^^^^"
`;
exports[`snippet: link [glimmer] format 1`] = `
"<link> elements do not need end tags. You should remove it:
|
| </link>
|
(error occurred in 'an unknown module' @ line 1 : column 6) (1:6)
> 1 | <link></link>
| ^^^^^^^"
`;
exports[`snippet: menuitem [glimmer] format 1`] = `
"Unclosed element \`menuitem\`:
|
| <menuitem>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <menuitem>
| ^^^^^^^^^^"
`;
exports[`snippet: meta [glimmer] format 1`] = `
"<meta> elements do not need end tags. You should remove it:
|
| </meta>
|
(error occurred in 'an unknown module' @ line 1 : column 6) (1:6)
> 1 | <meta></meta>
| ^^^^^^^"
`;
exports[`snippet: nextid [glimmer] format 1`] = `
"Unclosed element \`nextid\`:
|
| <nextid>
|
(error occurred in 'an unknown module' @ line 1 : column 0) (1:0)
> 1 | <nextid>
| ^^^^^^^^"
`;
exports[`snippet: param [glimmer] format 1`] = `
"<param> elements do not need end tags. You should remove it:
|
| </param>
|
(error occurred in 'an unknown module' @ line 1 : column 7) (1:7)
> 1 | <param></param>
| ^^^^^^^^"
`;
exports[`snippet: source [glimmer] format 1`] = `
"<source> elements do not need end tags. You should remove it:
|
| </source>
|
(error occurred in 'an unknown module' @ line 1 : column 8) (1:8)
> 1 | <source></source>
| ^^^^^^^^^"
`;
exports[`snippet: track [glimmer] format 1`] = `
"<track> elements do not need end tags. You should remove it:
|
| </track>
|
(error occurred in 'an unknown module' @ line 1 : column 7) (1:7)
> 1 | <track></track>
| ^^^^^^^^"
`;
exports[`snippet: wbr [glimmer] format 1`] = `
"<wbr> elements do not need end tags. You should remove it:
|
| </wbr>
|
(error occurred in 'an unknown module' @ line 1 : column 5) (1:5)
> 1 | <wbr></wbr>
| ^^^^^^"
`;
exports[`tilde-comments-1.hbs [glimmer] format 1`] = `
"Parse error on line 1:
{{~}}
tests/format/misc/errors/handlebars/jsfmt.spec.js
+49 -1
View File
@@ -1 +1,49 @@
run_spec(__dirname, ["glimmer"]);
run_spec(
{
dirname: __dirname,
snippets: [
...[
"area",
"base",
// "basefont",
// "bgsound",
"br",
"col",
"command",
"embed",
// "frame",
"hr",
// "image",
"img",
"input",
// "isindex",
"keygen",
"link",
// "menuitem",
"meta",
// "nextid",
"param",
"source",
"track",
"wbr",
].map((tag) => ({ name: tag, code: `<${tag}></${tag}>` })),
...[
"div",
// Missed HTML void tags
"basefont",
"bgsound",
"frame",
"image",
"isindex",
"menuitem",
"nextid",
// Upper case
"IMG",
"INPUT",
"imG",
"lINk",
].map((tag) => ({ name: tag, code: `<${tag}>` })),
],
},
["glimmer"]
);
vendors/html-void-elements.json
Vendored
-27
View File
@@ -1,27 +0,0 @@
{
"htmlVoidElements": [
"area",
"base",
"basefont",
"bgsound",
"br",
"col",
"command",
"embed",
"frame",
"hr",
"image",
"img",
"input",
"isindex",
"keygen",
"link",
"menuitem",
"meta",
"nextid",
"param",
"source",
"track",
"wbr"
]
}
yarn.lock
-5
View File
@@ -3802,11 +3802,6 @@ html-tag-names@2.0.1:
resolved "https://registry.yarnpkg.com/html-tag-names/-/html-tag-names-2.0.1.tgz#5626263e7d7b15789fa35a9f816234156901adc6"
integrity sha512-PX8KyLG7dwsjis3NPj1u+/EJf2CgH2d+qzekQpnlCOPQ6Uu6T8+F2ZqQg+wtsP+WKhxK3QMN9Garcwr7fCRhxA==
html-void-elements@2.0.1:
version "2.0.1"
resolved "https://registry.yarnpkg.com/html-void-elements/-/html-void-elements-2.0.1.tgz#29459b8b05c200b6c5ee98743c41b979d577549f"
integrity sha512-0quDb7s97CfemeJAnW9wC0hw78MtW7NU3hqtCD75g2vFlDLt36llsYD7uB7SUzojLMP24N5IatXf7ylGXiGG9A==
http-proxy-agent@^4.0.1:
version "4.0.1"
resolved "https://registry.yarnpkg.com/http-proxy-agent/-/http-proxy-agent-4.0.1.tgz#8a8c8ef7f5932ccf953c296ca8291b95aa74aa3a"