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);