html-validate 8.1.0 → 8.3.0

package/dist/types/browser.d.ts

@@ -44,9 +44,7 @@ export declare class Attribute {
      * it never matches.
      * @returns `true` if attribute value matches pattern.
      */
-    valueMatches(pattern: RegExp, dynamicMatches?: boolean): boolean;
-    valueMatches(pattern: string, dynamicMatches?: boolean): boolean;
-    valueMatches(pattern: string[], dynamicMatches?: boolean): boolean;
+    valueMatches(pattern: RegExp | string | string[], dynamicMatches?: boolean): boolean;
 }
 
 /**
@@ -718,6 +716,7 @@ export declare class HtmlElement extends DOMNode {
     protected readonly attr: Record<string, Attribute[]>;
     private metaElement;
     private annotation;
+    /* Excluded from this release type: _adapter */
     constructor(tagName: string | undefined, parent: HtmlElement | null, closed: NodeClosed, meta: MetaElement | null, location: Location_2);
     /* Excluded from this release type: rootNode */
     /* Excluded from this release type: fromTokens */
@@ -883,6 +882,23 @@ export declare class HtmlElement extends DOMNode {
     /* Excluded from this release type: find */
 }
 
+/**
+ * HTML5 interface for HTMLElement. Contains all the needed methods the
+ * HTML-Validate metadata requires to determine if usage is valid.
+ *
+ * While not officially supported, changes to this interface should be verified
+ * against browsers and/or jsdom, i.e. it should be possible to pass in either
+ * implementation and the element metadata should still work.
+ *
+ * @public
+ * @since 8.2.0
+ */
+export declare interface HtmlElementLike {
+    closest(selectors: string): HtmlElementLike | null | undefined;
+    getAttribute(name: string): string | DynamicValue | null | undefined;
+    hasAttribute(name: string): boolean;
+}
+
 /**
  * Primary API for using HTML-validate.
  *
@@ -1028,28 +1044,6 @@ export declare class HtmlValidate {
      * configuration. As a rule-of-thumb, set it to the elements json file.
      */
     getElementsSchemaSync(filename?: string): SchemaObject;
-    /**
-     * Get contextual documentation for the given rule. The default configuration
-     * will be used.
-     *
-     * @example
-     *
-     * ```js
-     * const report = await htmlvalidate.validateFile("my-file.html");
-     * for (const result of report.results){
-     *   for (const message of result.messages){
-     *     const documentation = await htmlvalidate.getRuleDocumentation(message, result.filePath);
-     *     // do something with documentation
-     *   }
-     * }
-     * ```
-     *
-     * @public
-     * @since 8.0.0
-     * @param message - Message reported during validation
-     * @returns Contextual documentation or `null` if the rule does not exist.
-     */
-    getContextualDocumentation(message: Pick<Message, "ruleId" | "context">): Promise<RuleDocumentation | null>;
     /**
      * Get contextual documentation for the given rule. Configuration will be
      * resolved for given filename.
@@ -1060,7 +1054,7 @@ export declare class HtmlValidate {
      * const report = await htmlvalidate.validateFile("my-file.html");
      * for (const result of report.results){
      *   for (const message of result.messages){
-     *     const documentation = await htmlvalidate.getRuleDocumentation(message, result.filePath);
+     *     const documentation = await htmlvalidate.getContextualDocumentation(message, result.filePath);
      *     // do something with documentation
      *   }
      * }
@@ -1072,7 +1066,7 @@ export declare class HtmlValidate {
      * @param filename - Filename used to resolve configuration.
      * @returns Contextual documentation or `null` if the rule does not exist.
      */
-    getContextualDocumentation(message: Pick<Message, "ruleId" | "context">, filename: string): Promise<RuleDocumentation | null>;
+    getContextualDocumentation(message: Pick<Message, "ruleId" | "context">, filename?: string): Promise<RuleDocumentation | null>;
     /**
      * Get contextual documentation for the given rule using provided
      * configuration.
@@ -1096,28 +1090,6 @@ export declare class HtmlValidate {
      * @returns Contextual documentation or `null` if the rule does not exist.
      */
     getContextualDocumentation(message: Pick<Message, "ruleId" | "context">, config: ResolvedConfig | Promise<ResolvedConfig>): Promise<RuleDocumentation | null>;
-    /**
-     * Get contextual documentation for the given rule. The default configuration
-     * will be used.
-     *
-     * @example
-     *
-     * ```js
-     * const report = htmlvalidate.validateFileSync("my-file.html");
-     * for (const result of report.results){
-     *   for (const message of result.messages){
-     *     const documentation = htmlvalidate.getRuleDocumentationSync(message, result.filePath);
-     *     // do something with documentation
-     *   }
-     * }
-     * ```
-     *
-     * @public
-     * @since 8.0.0
-     * @param message - Message reported during validation
-     * @returns Contextual documentation or `null` if the rule does not exist.
-     */
-    getContextualDocumentationSync(message: Pick<Message, "ruleId" | "context">): RuleDocumentation | null;
     /**
      * Get contextual documentation for the given rule. Configuration will be
      * resolved for given filename.
@@ -1140,7 +1112,7 @@ export declare class HtmlValidate {
      * @param filename - Filename used to resolve configuration.
      * @returns Contextual documentation or `null` if the rule does not exist.
      */
-    getContextualDocumentationSync(message: Pick<Message, "ruleId" | "context">, filename: string): RuleDocumentation | null;
+    getContextualDocumentationSync(message: Pick<Message, "ruleId" | "context">, filename?: string): RuleDocumentation | null;
     /**
      * Get contextual documentation for the given rule using provided
      * configuration.
@@ -1365,9 +1337,9 @@ export declare interface MetaAttribute {
  *
  * @public
  * @param node - The node the attribute belongs to.
- * @param attr - The current attribute being validated.
+ * @param attr - The current attribute value being validated.
  */
-export declare type MetaAttributeAllowedCallback = (node: HtmlElement, attr: Attribute) => string | null | undefined;
+export declare type MetaAttributeAllowedCallback = (node: HtmlElementLike, attr: string | DynamicValue | null | undefined) => string | null | undefined;
 
 /**
  * Properties listed here can be copied (loaded) onto another element using
@@ -1425,6 +1397,12 @@ export declare interface MetadataHelper {
     allowedIfAttributeHasValue(this: void, attr: string, value: string[], options?: {
         defaultValue?: string | null;
     }): MetaAttributeAllowedCallback;
+    /**
+     * Returns an error if the node doesn't have any of the given elements as parent
+     *
+     * @since 8.2.0
+     **/
+    allowedIfParentIsPresent(this: void, ...tags: string[]): MetaAttributeAllowedCallback;
 }
 
 /**
@@ -1939,8 +1917,8 @@ export declare abstract class Rule<ContextType = void, OptionsType = void> {
      */
     readonly options: OptionsType;
     constructor(options: OptionsType);
-    getSeverity(): number;
-    setServerity(severity: number): void;
+    getSeverity(): Severity;
+    setServerity(severity: Severity): void;
     /* Excluded from this release type: block */
     /* Excluded from this release type: unblock */
     setEnabled(enabled: boolean): void;
@@ -2012,8 +1990,7 @@ export declare abstract class Rule<ContextType = void, OptionsType = void> {
      * have any effect.
      */
     report(error: ErrorDescriptor<ContextType>): void;
-    report(node: DOMNode | null, message: string): void;
-    report(node: DOMNode | null, message: string, location: Location_2 | null | undefined): void;
+    report(node: DOMNode | null, message: string, location?: Location_2 | null | undefined): void;
     report(node: DOMNode | null, message: string, location: Location_2 | null | undefined, context: ContextType): void;
     private findLocation;
     /**

package/dist/types/index.d.ts

@@ -44,9 +44,7 @@ export declare class Attribute {
      * it never matches.
      * @returns `true` if attribute value matches pattern.
      */
-    valueMatches(pattern: RegExp, dynamicMatches?: boolean): boolean;
-    valueMatches(pattern: string, dynamicMatches?: boolean): boolean;
-    valueMatches(pattern: string[], dynamicMatches?: boolean): boolean;
+    valueMatches(pattern: RegExp | string | string[], dynamicMatches?: boolean): boolean;
 }
 
 /**
@@ -913,6 +911,7 @@ export declare class HtmlElement extends DOMNode {
     protected readonly attr: Record<string, Attribute[]>;
     private metaElement;
     private annotation;
+    /* Excluded from this release type: _adapter */
     constructor(tagName: string | undefined, parent: HtmlElement | null, closed: NodeClosed, meta: MetaElement | null, location: Location_2);
     /* Excluded from this release type: rootNode */
     /* Excluded from this release type: fromTokens */
@@ -1078,6 +1077,23 @@ export declare class HtmlElement extends DOMNode {
     /* Excluded from this release type: find */
 }
 
+/**
+ * HTML5 interface for HTMLElement. Contains all the needed methods the
+ * HTML-Validate metadata requires to determine if usage is valid.
+ *
+ * While not officially supported, changes to this interface should be verified
+ * against browsers and/or jsdom, i.e. it should be possible to pass in either
+ * implementation and the element metadata should still work.
+ *
+ * @public
+ * @since 8.2.0
+ */
+export declare interface HtmlElementLike {
+    closest(selectors: string): HtmlElementLike | null | undefined;
+    getAttribute(name: string): string | DynamicValue | null | undefined;
+    hasAttribute(name: string): boolean;
+}
+
 /**
  * Primary API for using HTML-validate.
  *
@@ -1223,28 +1239,6 @@ export declare class HtmlValidate {
      * configuration. As a rule-of-thumb, set it to the elements json file.
      */
     getElementsSchemaSync(filename?: string): SchemaObject;
-    /**
-     * Get contextual documentation for the given rule. The default configuration
-     * will be used.
-     *
-     * @example
-     *
-     * ```js
-     * const report = await htmlvalidate.validateFile("my-file.html");
-     * for (const result of report.results){
-     *   for (const message of result.messages){
-     *     const documentation = await htmlvalidate.getRuleDocumentation(message, result.filePath);
-     *     // do something with documentation
-     *   }
-     * }
-     * ```
-     *
-     * @public
-     * @since 8.0.0
-     * @param message - Message reported during validation
-     * @returns Contextual documentation or `null` if the rule does not exist.
-     */
-    getContextualDocumentation(message: Pick<Message, "ruleId" | "context">): Promise<RuleDocumentation | null>;
     /**
      * Get contextual documentation for the given rule. Configuration will be
      * resolved for given filename.
@@ -1255,7 +1249,7 @@ export declare class HtmlValidate {
      * const report = await htmlvalidate.validateFile("my-file.html");
      * for (const result of report.results){
      *   for (const message of result.messages){
-     *     const documentation = await htmlvalidate.getRuleDocumentation(message, result.filePath);
+     *     const documentation = await htmlvalidate.getContextualDocumentation(message, result.filePath);
      *     // do something with documentation
      *   }
      * }
@@ -1267,7 +1261,7 @@ export declare class HtmlValidate {
      * @param filename - Filename used to resolve configuration.
      * @returns Contextual documentation or `null` if the rule does not exist.
      */
-    getContextualDocumentation(message: Pick<Message, "ruleId" | "context">, filename: string): Promise<RuleDocumentation | null>;
+    getContextualDocumentation(message: Pick<Message, "ruleId" | "context">, filename?: string): Promise<RuleDocumentation | null>;
     /**
      * Get contextual documentation for the given rule using provided
      * configuration.
@@ -1291,28 +1285,6 @@ export declare class HtmlValidate {
      * @returns Contextual documentation or `null` if the rule does not exist.
      */
     getContextualDocumentation(message: Pick<Message, "ruleId" | "context">, config: ResolvedConfig | Promise<ResolvedConfig>): Promise<RuleDocumentation | null>;
-    /**
-     * Get contextual documentation for the given rule. The default configuration
-     * will be used.
-     *
-     * @example
-     *
-     * ```js
-     * const report = htmlvalidate.validateFileSync("my-file.html");
-     * for (const result of report.results){
-     *   for (const message of result.messages){
-     *     const documentation = htmlvalidate.getRuleDocumentationSync(message, result.filePath);
-     *     // do something with documentation
-     *   }
-     * }
-     * ```
-     *
-     * @public
-     * @since 8.0.0
-     * @param message - Message reported during validation
-     * @returns Contextual documentation or `null` if the rule does not exist.
-     */
-    getContextualDocumentationSync(message: Pick<Message, "ruleId" | "context">): RuleDocumentation | null;
     /**
      * Get contextual documentation for the given rule. Configuration will be
      * resolved for given filename.
@@ -1335,7 +1307,7 @@ export declare class HtmlValidate {
      * @param filename - Filename used to resolve configuration.
      * @returns Contextual documentation or `null` if the rule does not exist.
      */
-    getContextualDocumentationSync(message: Pick<Message, "ruleId" | "context">, filename: string): RuleDocumentation | null;
+    getContextualDocumentationSync(message: Pick<Message, "ruleId" | "context">, filename?: string): RuleDocumentation | null;
     /**
      * Get contextual documentation for the given rule using provided
      * configuration.
@@ -1567,9 +1539,9 @@ export declare interface MetaAttribute {
  *
  * @public
  * @param node - The node the attribute belongs to.
- * @param attr - The current attribute being validated.
+ * @param attr - The current attribute value being validated.
  */
-export declare type MetaAttributeAllowedCallback = (node: HtmlElement, attr: Attribute) => string | null | undefined;
+export declare type MetaAttributeAllowedCallback = (node: HtmlElementLike, attr: string | DynamicValue | null | undefined) => string | null | undefined;
 
 /**
  * Properties listed here can be copied (loaded) onto another element using
@@ -1627,6 +1599,12 @@ export declare interface MetadataHelper {
     allowedIfAttributeHasValue(this: void, attr: string, value: string[], options?: {
         defaultValue?: string | null;
     }): MetaAttributeAllowedCallback;
+    /**
+     * Returns an error if the node doesn't have any of the given elements as parent
+     *
+     * @since 8.2.0
+     **/
+    allowedIfParentIsPresent(this: void, ...tags: string[]): MetaAttributeAllowedCallback;
 }
 
 /**
@@ -2164,8 +2142,8 @@ export declare abstract class Rule<ContextType = void, OptionsType = void> {
      */
     readonly options: OptionsType;
     constructor(options: OptionsType);
-    getSeverity(): number;
-    setServerity(severity: number): void;
+    getSeverity(): Severity;
+    setServerity(severity: Severity): void;
     /* Excluded from this release type: block */
     /* Excluded from this release type: unblock */
     setEnabled(enabled: boolean): void;
@@ -2237,8 +2215,7 @@ export declare abstract class Rule<ContextType = void, OptionsType = void> {
      * have any effect.
      */
     report(error: ErrorDescriptor<ContextType>): void;
-    report(node: DOMNode | null, message: string): void;
-    report(node: DOMNode | null, message: string, location: Location_2 | null | undefined): void;
+    report(node: DOMNode | null, message: string, location?: Location_2 | null | undefined): void;
     report(node: DOMNode | null, message: string, location: Location_2 | null | undefined, context: ContextType): void;
     private findLocation;
     /**

package/dist/types/jest.d.ts

@@ -21,14 +21,10 @@ declare global {
              * @param filename - Optional filename used when matching transformer and
              * loading configuration.
              */
-            toHTMLValidate(): R;
-            toHTMLValidate(filename: string): R;
-            toHTMLValidate(config: ConfigData): R;
-            toHTMLValidate(config: ConfigData, filename: string): R;
-            toHTMLValidate(error: Partial<Message>): R;
-            toHTMLValidate(error: Partial<Message>, filename: string): R;
-            toHTMLValidate(error: Partial<Message>, config: ConfigData): R;
-            toHTMLValidate(error: Partial<Message>, config: ConfigData, filename: string): R;
+            toHTMLValidate(filename?: string): R;
+            toHTMLValidate(config: ConfigData, filename?: string): R;
+            toHTMLValidate(error: Partial<Message>, filename?: string): R;
+            toHTMLValidate(error: Partial<Message>, config: ConfigData, filename?: string): R;
             /**
              * Writes out the given [[Report]] using codeframe formatter and compares
              * with snapshot.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-validate",
-  "version": "8.1.0",
+  "version": "8.3.0",
   "description": "Offline html5 validator",
   "keywords": [
     "html",
@@ -187,17 +187,17 @@
     "semver": "^7.0.0"
   },
   "devDependencies": {
-    "@html-validate/commitlint-config": "3.0.17",
-    "@html-validate/eslint-config": "5.9.12",
-    "@html-validate/eslint-config-jest": "5.9.11",
-    "@html-validate/eslint-config-typescript": "5.9.13",
-    "@html-validate/eslint-config-typescript-typeinfo": "5.9.0",
-    "@html-validate/jest-config": "3.7.6",
-    "@html-validate/prettier-config": "2.3.11",
-    "@html-validate/release-scripts": "4.1.0",
-    "@microsoft/api-extractor": "7.36.3",
+    "@html-validate/commitlint-config": "3.0.20",
+    "@html-validate/eslint-config": "5.10.7",
+    "@html-validate/eslint-config-jest": "5.10.0",
+    "@html-validate/eslint-config-typescript": "5.10.7",
+    "@html-validate/eslint-config-typescript-typeinfo": "5.10.7",
+    "@html-validate/jest-config": "3.7.7",
+    "@html-validate/prettier-config": "2.4.5",
+    "@html-validate/release-scripts": "4.1.6",
+    "@microsoft/api-extractor": "7.36.4",
     "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.1.0",
+    "@rollup/plugin-node-resolve": "15.2.0",
     "@rollup/plugin-replace": "5.0.2",
     "@rollup/plugin-typescript": "11.1.2",
     "@rollup/plugin-virtual": "3.0.1",
@@ -205,21 +205,21 @@
     "@types/babel__code-frame": "7.0.3",
     "@types/jest": "29.5.3",
     "@types/minimist": "1.2.2",
-    "@types/node": "16.18.38",
+    "@types/node": "16.18.41",
     "@types/prompts": "2.4.4",
     "@types/semver": "7.5.0",
     "@types/stream-buffers": "3.0.4",
     "babar": "0.2.3",
     "husky": "8.0.3",
     "is-ci": "3.0.1",
-    "jest": "29.6.1",
-    "jest-diff": "29.6.1",
-    "jest-environment-jsdom": "29.6.1",
-    "jest-snapshot": "29.6.1",
-    "memfs": "4.2.0",
-    "npm-pkg-lint": "1.14.1",
+    "jest": "29.6.2",
+    "jest-diff": "29.6.2",
+    "jest-environment-jsdom": "29.6.2",
+    "jest-snapshot": "29.6.2",
+    "memfs": "4.2.1",
+    "npm-pkg-lint": "2.0.1",
     "npm-run-all": "4.1.5",
-    "rollup": "3.26.3",
+    "rollup": "3.28.0",
     "stream-buffers": "3.0.2",
     "ts-jest": "29.1.1",
     "typescript": "5.1.6"