html-validate 7.7.1 → 7.9.0

package/dist/es/core.d.ts

@@ -944,6 +944,23 @@ interface Location {
      */
     readonly size: number;
 }
+/**
+ * Calculate a new location by offsetting this location.
+ *
+ * If the references text with newlines the wrap parameter must be set to
+ * properly calculate line and column information. If not given the text is
+ * assumed to contain no newlines.
+ *
+ * @public
+ * @param location - Source location
+ * @param begin - Start location. Default is 0.
+ * @param end - End location. Default is size of location. Negative values are
+ * counted from end, e.g. `-2` means `size - 2`.
+ * @param wrap - If given, line/column is wrapped for each newline occuring
+ * before location end.
+ */
+declare function sliceLocation(location: Location, begin: number, end?: number, wrap?: string): Location;
+declare function sliceLocation(location: Location | null | undefined, begin: number, end?: number, wrap?: string): Location | null;
 
 /**
  * @public
@@ -1171,6 +1188,13 @@ interface Plugin {
     elementSchema?: SchemaValidationPatch | null;
 }
 
+/**
+ * Helper function to assist IDE with completion and type-checking.
+ *
+ * @public
+ */
+declare function definePlugin(plugin: Plugin): Plugin;
+
 /**
  * @public
  */
@@ -1745,30 +1769,6 @@ interface ElementTable {
     [tagName: string]: MetaElement;
 }
 
-/**
- * Helper function to assist IDE with completion and type-checking.
- *
- * @public
- */
-declare function defineMetadata(metatable: MetaDataTable): MetaDataTable;
-
-/**
- * Helpers when writing element metadata.
- *
- * @public
- */
-interface MetadataHelper {
-    /** Returns an error if another attribute is omitted, i.e. it requires another attribute to be present to pass. */
-    allowedIfAttributeIsPresent(...attr: string[]): MetaAttributeAllowedCallback;
-    /** Returns an error if another attribute is present, i.e. it requires another attribute to be omitted to pass. */
-    allowedIfAttributeIsAbsent(...attr: string[]): MetaAttributeAllowedCallback;
-    /** Returns an error if another attribute does not have one of the listed values */
-    allowedIfAttributeHasValue(attr: string, value: string[], options?: {
-        defaultValue?: string | null;
-    }): MetaAttributeAllowedCallback;
-}
-declare const metadataHelper: MetadataHelper;
-
 /**
  * @public
  */
@@ -2282,48 +2282,6 @@ declare class StaticConfigLoader extends ConfigLoader {
 /** @public */
 declare const version: string;
 
-declare const HTML_CACHE_KEY: unique symbol;
-declare const A11Y_CACHE_KEY: unique symbol;
-declare const IGNORE_HIDDEN_ROOT_HTML_CACHE_KEY: unique symbol;
-declare const IGNORE_HIDDEN_ROOT_A11Y_CACHE_KEY: unique symbol;
-/**
- * @public
- */
-declare enum TextClassification {
-    EMPTY_TEXT = 0,
-    DYNAMIC_TEXT = 1,
-    STATIC_TEXT = 2
-}
-/**
- * @public
- */
-interface TextClassificationOptions {
-    /** If `true` only accessible text is considered (default false) */
-    accessible?: boolean;
-    /** If `true` the `hidden` and `aria-hidden` attribute is ignored on the root
-     * (and parents) elements (default false) */
-    ignoreHiddenRoot?: boolean;
-}
-declare module "../../dom/cache" {
-    interface DOMNodeCache {
-        [HTML_CACHE_KEY]: TextClassification;
-        [A11Y_CACHE_KEY]: TextClassification;
-        [IGNORE_HIDDEN_ROOT_HTML_CACHE_KEY]: TextClassification;
-        [IGNORE_HIDDEN_ROOT_A11Y_CACHE_KEY]: TextClassification;
-    }
-}
-/**
- * Checks text content of an element.
- *
- * Any text is considered including text from descendant elements. Whitespace is
- * ignored.
- *
- * If any text is dynamic `TextClassification.DYNAMIC_TEXT` is returned.
- *
- * @public
- */
-declare function classifyNodeText(node: HtmlElement, options?: TextClassificationOptions): TextClassification;
-
 /**
  * @public
  */
@@ -2421,6 +2379,13 @@ declare class FileSystemConfigLoader extends ConfigLoader {
  */
 declare type Formatter = (results: Result[]) => string;
 
+interface AvailableFormatters {
+    checkstyle: Formatter;
+    codeframe: Formatter;
+    json: Formatter;
+    stylish: Formatter;
+    text: Formatter;
+}
 /**
  * Get formatter function by name.
  *
@@ -2428,6 +2393,7 @@ declare type Formatter = (results: Result[]) => string;
  * @param name - Name of formatter.
  * @returns Formatter function or null if it doesn't exist.
  */
+declare function getFormatter(name: keyof AvailableFormatters): Formatter;
 declare function getFormatter(name: string): Formatter | null;
 
-export { TokenEvent as $, AttributeData as A, Result as B, Config as C, DynamicValue as D, EventDump as E, DeferredMessage as F, TransformContext as G, HtmlValidate as H, Transformer as I, TemplateExtractor as J, Plugin as K, Location as L, MetaData as M, NodeClosed as N, Parser as O, ProcessElementContext as P, ruleExists as Q, Rule as R, Severity as S, TextNode as T, UserError as U, EventHandler as V, WrappedError as W, EventCallback as X, Event as Y, ConfigReadyEvent as Z, SourceReadyEvent as _, ConfigData as a, TagStartEvent as a0, TagOpenEvent as a1, TagEndEvent as a2, TagCloseEvent as a3, TagReadyEvent as a4, ElementReadyEvent as a5, AttributeEvent as a6, WhitespaceEvent as a7, ConditionalEvent as a8, DirectiveEvent as a9, DoctypeEvent as aa, DOMLoadEvent as ab, DOMReadyEvent as ac, TriggerEventMap as ad, ListenEventMap as ae, FileSystemConfigLoader as af, Formatter as ag, getFormatter as ah, compatibilityCheck as ai, CompatibilityOptions as aj, ConfigError as b, ConfigLoader as c, StaticConfigLoader as d, HtmlElement as e, CSSStyleDeclaration as f, TokenDump as g, SchemaValidationError as h, NestedError as i, MetaDataTable as j, MetaElement as k, MetaAttribute as l, MetaAttributeAllowedCallback as m, MetaTable as n, MetaCopyableProperty as o, presets as p, defineMetadata as q, metadataHelper as r, RuleDocumentation as s, classifyNodeText as t, TextClassification as u, version as v, Source as w, Report as x, Reporter as y, Message as z };
+export { Event as $, AttributeData as A, Message as B, Config as C, DynamicValue as D, EventDump as E, Result as F, DeferredMessage as G, HtmlValidate as H, TransformContext as I, Transformer as J, TemplateExtractor as K, Location as L, MetaData as M, NodeClosed as N, Plugin as O, ProcessAttributeCallback as P, SchemaValidationPatch as Q, Rule as R, Severity as S, TextNode as T, UserError as U, definePlugin as V, WrappedError as W, Parser as X, ruleExists as Y, EventHandler as Z, EventCallback as _, ConfigData as a, ConfigReadyEvent as a0, SourceReadyEvent as a1, TokenEvent as a2, TagStartEvent as a3, TagOpenEvent as a4, TagEndEvent as a5, TagCloseEvent as a6, TagReadyEvent as a7, ElementReadyEvent as a8, AttributeEvent as a9, WhitespaceEvent as aa, ConditionalEvent as ab, DirectiveEvent as ac, DoctypeEvent as ad, DOMLoadEvent as ae, DOMReadyEvent as af, TriggerEventMap as ag, ListenEventMap as ah, FileSystemConfigLoader as ai, Formatter as aj, getFormatter as ak, compatibilityCheck as al, CompatibilityOptions as am, ConfigError as b, ConfigLoader as c, StaticConfigLoader as d, HtmlElement as e, CSSStyleDeclaration as f, TokenDump as g, SchemaValidationError as h, NestedError as i, MetaDataTable as j, MetaElement as k, MetaAttribute as l, MetaAttributeAllowedCallback as m, MetaTable as n, MetaCopyableProperty as o, presets as p, RuleConstructor as q, RuleDocumentation as r, Source as s, SourceHooks as t, ProcessElementCallback as u, version as v, ProcessElementContext as w, sliceLocation as x, Report as y, Reporter as z };