X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=test%2Flint-html.js;h=57f8241200a8d7beee76e491a3e02cb54129d54d;hb=refs%2Fheads%2Fmaster;hp=1f2b437c302effc58cc4de8a80d8254822bbe0d3;hpb=c7fb39b664bc0a7eaf310c2ae7666e3cf26824bf;p=squeep-html-template-helper

diff --git a/test/lint-html.js b/test/lint-html.js
index 1f2b437..57f8241 100644
--- a/test/lint-html.js
+++ b/test/lint-html.js
@@ -6,13 +6,27 @@
 
 const assert = require('node:assert');
 
+/**
+ * @typedef {object} ConsoleLike
+ * @property {Function} debug debug
+ */
+
+/**
+ * @typedef {import('html-validate')} HtmlValidateModule
+ */
+
 /**
  * Given an instance of html-validate, returns a function which asserts validity of some HTML.
- * @param {ConsoleLike} logger
- * @param {HtmlValidate} htmlValidate
- * @returns {(html: String) => Promise<void>}
+ * @param {ConsoleLike} logger logger
+ * @param {HtmlValidateModule.HtmlValidate} htmlValidate html-validate instance
+ * @returns {(html: string) => Promise<void>} function which lints html
  */
 function makeHtmlLint(logger, htmlValidate) {
+  /**
+   * 
+   * @param {any[]} violations array of violations to add to
+   * @param {any} message violation to add
+   */
   function note(violations, message) {
     violations.push(message.ruleId);
     logger.debug('HtmlLint', message);