feat(rules): add empty-tag-not-self-closed rule (#696)

Fixes #311.
htmlhint · Oct 29, 2021 · ec171ac · ec171ac
1 parent 28069e5
commit ec171ac
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 2 deletions.
diff --git a/src/core/rules/empty-tag-not-self-closed.ts b/src/core/rules/empty-tag-not-self-closed.ts
@@ -0,0 +1,26 @@
+import { Rule } from '../types'
+
+export default {
+  id: 'empty-tag-not-self-closed',
+  description: 'Empty tags must not use self closed syntax.',
+  init(parser, reporter) {
+    const mapEmptyTags = parser.makeMap(
+      'area,base,basefont,bgsound,br,col,frame,hr,img,input,isindex,link,meta,param,embed,track,command,source,keygen,wbr'
+    ) //HTML 4.01 + HTML 5
+
+    parser.addListener('tagstart', (event) => {
+      const tagName = event.tagName.toLowerCase()
+      if (mapEmptyTags[tagName] !== undefined) {
+        if (event.close) {
+          reporter.error(
+            `The empty tag : [ ${tagName} ] must not use self closed syntax.`,
+            event.line,
+            event.col,
+            this,
+            event.raw
+          )
+        }
+      }
+    })
+  },
+} as Rule
diff --git a/src/core/rules/index.ts b/src/core/rules/index.ts
@@ -25,6 +25,7 @@ export { default as srcNotEmpty } from './src-not-empty'
 export { default as styleDisabled } from './style-disabled'
 export { default as tagPair } from './tag-pair'
 export { default as tagSelfClose } from './tag-self-close'
+export { default as emptyTagNotSelfClosed } from './empty-tag-not-self-closed'
 export { default as tagnameLowercase } from './tagname-lowercase'
 export { default as tagnameSpecialChars } from './tagname-specialchars'
 export { default as titleRequire } from './title-require'

diff --git a/src/core/rules/tag-self-close.ts b/src/core/rules/tag-self-close.ts
@@ -5,7 +5,7 @@ export default {
   description: 'Empty tags must be self closed.',
   init(parser, reporter) {
     const mapEmptyTags = parser.makeMap(
-      'area,base,basefont,br,col,frame,hr,img,input,isindex,link,meta,param,embed,track,command,source,keygen,wbr'
+      'area,base,basefont,bgsound,br,col,frame,hr,img,input,isindex,link,meta,param,embed,track,command,source,keygen,wbr'
     ) //HTML 4.01 + HTML 5
 
     parser.addListener('tagstart', (event) => {

diff --git a/src/core/types.ts b/src/core/types.ts
@@ -20,6 +20,7 @@ export interface Ruleset {
   'attr-whitespace'?: boolean
   'doctype-first'?: boolean
   'doctype-html5'?: boolean
+  'empty-tag-not-self-closed'?: boolean
   'head-script-disabled'?: boolean
   'href-abs-or-rel'?: 'abs' | 'rel'
   'id-class-ad-disabled'?: boolean

diff --git a/test/rules/empty-tag-not-self-closed.spec.js b/test/rules/empty-tag-not-self-closed.spec.js
@@ -0,0 +1,30 @@
+const expect = require('expect.js')
+
+const HTMLHint = require('../../dist/htmlhint.js').HTMLHint
+
+const ruldId = 'empty-tag-not-self-closed'
+const ruleOptions = {}
+
+ruleOptions[ruldId] = true
+
+describe(`Rules: ${ruldId}`, () => {
+  it('The empty tag no closed should not result in an error', () => {
+    const code = '<br><img src="test.jpg">'
+    const messages = HTMLHint.verify(code, ruleOptions)
+    expect(messages.length).to.be(0)
+  })
+
+  it('Closed empty tag should result in an error', () => {
+    const code = '<br /><img src="a.jpg"/>'
+    const messages = HTMLHint.verify(code, ruleOptions)
+    expect(messages.length).to.be(2)
+    expect(messages[0].rule.id).to.be(ruldId)
+    expect(messages[0].line).to.be(1)
+    expect(messages[0].col).to.be(1)
+    expect(messages[0].type).to.be('error')
+    expect(messages[1].rule.id).to.be(ruldId)
+    expect(messages[1].line).to.be(1)
+    expect(messages[1].col).to.be(7)
+    expect(messages[1].type).to.be('error')
+  })
+})
diff --git a/test/rules/tag-self-close.spec.js b/test/rules/tag-self-close.spec.js
@@ -15,7 +15,6 @@ describe(`Rules: ${ruldId}`, () => {
     expect(messages[0].rule.id).to.be(ruldId)
     expect(messages[0].line).to.be(1)
     expect(messages[0].col).to.be(1)
-    console.log('lll', messages[0].type)
     expect(messages[0].type).to.be('warning')
     expect(messages[1].rule.id).to.be(ruldId)
     expect(messages[1].line).to.be(1)