Closes #1317: Add filepath to the start event

Author: commodis

dist/cli/htmlhint.js

@@ -505,7 +505,7 @@ function hintFile(filepath: string, ruleset?: Ruleset) {
     // ignore
   }
 
-  return HTMLHint.verify(content, ruleset)
+  return HTMLHint.verify(content, ruleset, filepath)
 }
 
 // hint stdin

dist/core/core.js

@@ -27,7 +27,11 @@ class HTMLHintCore {
     this.rules[rule.id] = rule
   }
 
-  public verify(html: string, ruleset: Ruleset = this.defaultRuleset) {
+  public verify(
+    html: string,
+    ruleset: Ruleset = this.defaultRuleset,
+    filepath: string = ''
+  ) {
     if (Object.keys(ruleset).length === 0) {
       ruleset = this.defaultRuleset
     }
@@ -74,7 +78,7 @@ class HTMLHintCore {
       }
     }
 
-    parser.parse(html)
+    parser.parse(html, filepath)
 
     return reporter.messages
   }

dist/core/htmlparser.js

@@ -18,6 +18,7 @@ export interface Block {
   long: boolean
   close: string
   lastEvent?: Partial<Block>
+  filepath?: string
 }
 
 export type Listener = (event: Block) => void
@@ -49,7 +50,7 @@ export default class HTMLParser {
     return obj
   }
 
-  public parse(html: string): void {
+  public parse(html: string, filepath: string = ''): void {
     const mapCdataTags = this._mapCdataTags
 
     const regTag =
@@ -78,6 +79,7 @@ export default class HTMLParser {
       pos: 0,
       line: 1,
       col: 1,
+      filepath: filepath,
     })
 
     // Do not ignore validation inside <script type="ng/template"> template

src/cli/htmlhint.ts

@@ -655,3 +655,31 @@ describe('HTMLParser: Case parse', () => {
     parser.parse('<img src="aaa" alt= />')
   })
 })
+
+describe('HTMLParser: Filepath', () => {
+  it('should include filepath in start event when provided to parse', (done) => {
+    const parser = new HTMLParser()
+    const arrEvents = []
+    getAllEvents(parser, arrEvents, () => {
+      // The start event must be the first event (index 0)
+      expect(arrEvents[0]).toEvent('start', {
+        filepath: '/some/example.txt',
+      })
+      done()
+    })
+    parser.parse('', '/some/example.txt')
+  })
+
+  it('should include empty string filepath in start event when not provided', (done) => {
+    const parser = new HTMLParser()
+    const arrEvents = []
+    getAllEvents(parser, arrEvents, () => {
+      // The start event must be the first event (index 0)
+      expect(arrEvents[0]).toEvent('start', {
+        filepath: '',
+      })
+      done()
+    })
+    parser.parse('')
+  })
+})