html-validate 11.3.0 → 11.5.0

package/dist/esm/html-validate.js

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { parseArgs } from 'node:util';
 import kleur from 'kleur';
-import { Q as name, a3 as version, S as SchemaValidationError, K as isUserError, q as bugs } from './core.js';
+import { $ as name, aa as version, S as SchemaValidationError, Y as isUserError, q as bugs } from './core.js';
 import { M as Mode, m as modeToFlag, C as CLI, a as haveImportMetaResolve, I as ImportResolveMissingError, d as dump, p as printConfig, i as init, l as lint, h as handleSchemaValidationError } from './cli.js';
 import 'ajv';
 import './elements.js';

package/dist/esm/index.js

@@ -1,5 +1,5 @@
-export { F as FileSystemConfigLoader, H as HtmlValidate, c as cjsResolver, a as compatibilityCheck, e as esmResolver } from './core-nodejs.js';
-export { A as Attribute, C as Config, a as ConfigError, b as ConfigLoader, D as DOMNode, c as DOMTokenList, d as DOMTree, e as DynamicValue, f as EventHandler, H as HtmlElement, M as MetaCopyableProperty, g as MetaTable, N as NestedError, h as Node, P as Parser, i as PerformanceTracker, R as Reporter, j as ResolvedConfig, k as Rule, S as SchemaValidationError, l as Severity, m as StaticConfigLoader, T as TextClassification, n as TextContent, o as TextNode, U as UserError, W as WrappedError, p as ariaNaming, r as classifyNodeText, X as configPresets, w as defineConfig, x as definePlugin, F as formatterFactory, K as isUserError, O as keywordPatternMatcher, Y as ruleExists, Z as sliceLocation, _ as staticResolver, a3 as version, a5 as walk } from './core.js';
+export { F as FileSystemConfigLoader, a as FlatConfigLoader, H as HtmlValidate, c as cjsResolver, b as compatibilityCheck, d as defineFlatConfig, e as esmResolver } from './core-nodejs.js';
+export { A as Attribute, C as Config, a as ConfigError, b as ConfigLoader, D as DOMNode, c as DOMTokenList, d as DOMTree, e as DynamicValue, f as EventHandler, H as HtmlElement, M as MetaCopyableProperty, g as MetaTable, N as NestedError, h as Node, P as Parser, i as PerformanceTracker, R as Reporter, j as ResolvedConfig, k as Rule, S as SchemaValidationError, l as Severity, m as StaticConfigLoader, T as TextClassification, n as TextContent, o as TextNode, U as UserError, W as WrappedError, p as ariaNaming, r as classifyNodeText, a2 as configPresets, G as defineConfig, I as definePlugin, O as formatterFactory, Y as isUserError, _ as keywordPatternMatcher, a3 as ruleExists, a4 as sliceLocation, a5 as staticResolver, aa as version, ac as walk } from './core.js';
 export { C as CLI } from './cli.js';
 export { d as defineMetadata, m as metadataHelper } from './meta-helper.js';
 import 'node:fs';

package/dist/esm/jest-matchers.js

@@ -1,5 +1,5 @@
 import { d as diverge, a as createSyncFn, c as codeframe, i as isThenable } from './jest-utils.js';
-import { v as deepmerge, L as jestWorkerPath } from './core.js';
+import { F as deepmerge, Z as jestWorkerPath } from './core.js';
 import { toMatchSnapshot, toMatchInlineSnapshot } from 'jest-snapshot';
 
 function createMatcher$6() {

package/dist/esm/jest-utils.js

@@ -1,4 +1,4 @@
-import { s as codeFrameColumns, B as getEndLocation, G as getStartLocation } from './core.js';
+import { s as codeFrameColumns, L as getEndLocation, Q as getStartLocation } from './core.js';
 import { MessageChannel, Worker, receiveMessageOnPort } from 'node:worker_threads';
 import { l as legacyRequire } from './core-nodejs.js';
 

package/dist/esm/presets.d.ts

@@ -0,0 +1 @@
+export * from "../types/presets";

package/dist/esm/presets.js

@@ -0,0 +1,11 @@
+export { u as a11y, v as browser, w as document, x as prettier, y as recommended, z as standard } from './core.js';
+import 'ajv';
+import './elements.js';
+import './meta-helper.js';
+import './utils/natural-join.js';
+import './utils/parse-image-candidate-string.js';
+import '@sidvind/better-ajv-errors';
+import 'kleur';
+import '@html-validate/stylish';
+import 'semver';
+//# sourceMappingURL=presets.js.map

package/dist/esm/presets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presets.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}

package/dist/esm/vitest-matchers.js

@@ -1,5 +1,5 @@
 import { d as diverge, a as createSyncFn, c as codeframe } from './vitest-utils.js';
-import { v as deepmerge, a4 as vitestWorkerPath } from './core.js';
+import { F as deepmerge, ab as vitestWorkerPath } from './core.js';
 import * as vitest from 'vitest';
 import { H as HtmlValidate } from './core-nodejs.js';
 

package/dist/esm/vitest-utils.js

@@ -1,4 +1,4 @@
-import { s as codeFrameColumns, B as getEndLocation, G as getStartLocation } from './core.js';
+import { s as codeFrameColumns, L as getEndLocation, Q as getStartLocation } from './core.js';
 import { MessageChannel, Worker, receiveMessageOnPort } from 'node:worker_threads';
 import { l as legacyRequire } from './core-nodejs.js';
 

package/dist/schema/elements.json

@@ -344,13 +344,31 @@
                   "title": "Exhaustive list of values (string or regex) this attribute accepts",
                   "uniqueItems": true,
                   "items": {
-                    "anyOf": [{ "type": "string" }, { "regexp": true }]
+                    "anyOf": [
+                      { "type": "string" },
+                      { "regexp": true },
+                      {
+                        "type": "object",
+                        "title": "Named regular expression",
+                        "required": ["name", "pattern"],
+                        "additionalProperties": false,
+                        "properties": {
+                          "name": { "type": "string", "minLength": 1 },
+                          "pattern": { "anyOf": [{ "type": "string" }, { "regexp": true }] }
+                        }
+                      }
+                    ]
                   }
                 },
                 "omit": {
                   "type": "boolean",
                   "title": "Set to true if this attribute can optionally omit its value"
                 },
+                "reference": {
+                  "type": "string",
+                  "enum": ["id"],
+                  "title": "Set when the attribute references another element."
+                },
                 "required": {
                   "title": "Set to true or a function to evaluate if this attribute is required",
                   "oneOf": [{ "type": "boolean" }, { "function": true }]

package/dist/types/browser.d.ts

@@ -341,6 +341,10 @@ export declare abstract class ConfigLoader {
      *
      * If [[configOverride]] is set it is merged with the final result.
      *
+     * Do note that if `configOverride` is changed between calls the cache must be
+     * flushed in-between or the final results may vary. Loaders may cache the
+     * merged result.
+     *
      * @param handle - Unique handle to get configuration for.
      * @param configOverride - Optional configuration to merge final results with.
      */
@@ -744,6 +748,64 @@ export declare class EventHandler {
 
 /* Excluded from this release type: EventPerformanceEntry */
 
+/**
+ * @public
+ * @since 11.5.0
+ */
+export declare type FlatConfig = FlatConfigObject[];
+
+/**
+ * A single object in a flat configuration file.
+ *
+ * @public
+ * @since 11.5.0
+ */
+export declare interface FlatConfigObject {
+    /**
+     * Optional name of this configuration object.
+     *
+     * Used for troubleshooting and error messages.
+     */
+    name?: string;
+    /**
+     * An array of glob patterns indicating the files that the configuration
+     * object should apply to.
+     *
+     * If not specified, the configuration object applies to all files matched by
+     * any other configuration object.
+     */
+    files?: string[];
+    /**
+     * An array of glob patterns indicating the files that the configuration object should not apply to.
+     *
+     * If not specified, the configuration object applies to all files matches by `files`.
+     *
+     * If `ignores` is used without any other keys in the configuration object,
+     * then the patterns act as a global ignores and gets applied to every
+     * configuration object.
+     */
+    ignores?: string[];
+    /**
+     * Element metadata sources.
+     */
+    elements?: MetaDataTable[];
+    /**
+     * Plugins
+     */
+    plugins?: Plugin_2[];
+    /**
+     * Source file transformations.
+     *
+     * Maps a regular-expression pattern (matched against the filename) to a
+     * transformer function.
+     */
+    transform?: Record<string, Transformer_2>;
+    /**
+     * Rule configuration.
+     */
+    rules?: RuleConfig;
+}
+
 /**
  * @public
  */
@@ -1462,10 +1524,19 @@ export declare interface MetaAttribute {
      */
     deprecated?: boolean | string;
     /**
-     * If set it is an exhaustive list of all possible values (as `string` or
-     * `RegExp`) this attribute can have (each token if list is set)
+     * If set it is an exhaustive list of all possible values this attribute can
+     * have (each token if list is set).
+     *
+     * Each entry can either be:
+     *
+     * - A keyword (as string).
+     * - A regular expression.
+     * - An object with `name` and `pattern` (regular expression).
+     *
+     * When using an object the name is presented in error messages and contextual
+     * documentation.
      */
-    enum?: Array<string | RegExp>;
+    enum?: Array<string | RegExp | MetaAttributeNamedRegex>;
     /**
      * If `true` this attribute contains space-separated tokens and each token must
      * be valid by itself.
@@ -1475,6 +1546,16 @@ export declare interface MetaAttribute {
      * If `true` this attribute can omit the value.
      */
     omit?: boolean;
+    /**
+     * When set, this attribute references another element by the given type. If
+     * `list` is also set, each individual token in the attribute value references another
+     * element.
+     *
+     * - `id`: the attribute value references the id of another element in the document.
+     *
+     * @since 11.4.0
+     */
+    reference?: "id";
     /**
      * If set this attribute is required to be present on the element.
      */
@@ -1492,6 +1573,19 @@ export declare interface MetaAttribute {
  */
 export declare type MetaAttributeAllowedCallback = (node: HtmlElementLike, attr: string | DynamicValue | null | undefined) => string | null | undefined;
 
+/**
+ * A named regular expression for use in attribute value validation.
+ *
+ * @public
+ * @since 11.5.0
+ */
+export declare interface MetaAttributeNamedRegex {
+    /** Human-readable label shown in error documentation. */
+    name: string;
+    /** Regular expression used for validation. */
+    pattern: RegExp | string;
+}
+
 /**
  * Callback for the `required` property of `MetaAttribute`.
  *
@@ -2211,7 +2305,7 @@ export declare class ResolvedConfig {
      * Returns the (merged) configuration data used to create this resolved
      * configuration.
      */
-    getConfigData(): ConfigData;
+    getConfigData(): ConfigData | FlatConfig;
     getMetaTable(): MetaTable;
     getPlugins(): Plugin_2[];
     getRules(): Map<string, [Severity, RuleOptions]>;

package/dist/types/index.d.ts

@@ -439,6 +439,10 @@ export declare abstract class ConfigLoader {
      *
      * If [[configOverride]] is set it is merged with the final result.
      *
+     * Do note that if `configOverride` is changed between calls the cache must be
+     * flushed in-between or the final results may vary. Loaders may cache the
+     * merged result.
+     *
      * @param handle - Unique handle to get configuration for.
      * @param configOverride - Optional configuration to merge final results with.
      */
@@ -501,6 +505,27 @@ export declare interface DeferredMessage extends Omit<Message, "selector"> {
  */
 export declare function defineConfig(config: ConfigData): ConfigData;
 
+/**
+ * Helper function to assist IDE with completion and type-checking.
+ *
+ * @example
+ *
+ * ```ts
+ * import { defineFlatConfig } from "html-validate";
+ *
+ * export default defineFlatConfig([
+ *   {
+ *     files: ["*.html"],
+ *     rules: { "void-style": "error" },
+ *   }
+ * ]);
+ * ```
+ *
+ * @public
+ * @since 11.5.0
+ */
+export declare function defineFlatConfig(config: FlatConfig): FlatConfig;
+
 /**
  * Helper function to assist IDE with completion and type-checking.
  *
@@ -954,6 +979,109 @@ export declare interface FileSystemConfigLoaderOptions {
     fs: FSLike;
 }
 
+/**
+ * @public
+ * @since 11.5.0
+ */
+export declare type FlatConfig = FlatConfigObject[];
+
+/**
+ * Configuration loader for the flat config format.
+ *
+ * Loads configuration from a `html-validate.config.*` file and applies
+ * per-file glob filtering.
+ *
+ * @public
+ * @since 11.5.0
+ */
+export declare class FlatConfigLoader extends ConfigLoader {
+    private readonly configFilePath;
+    private configCache;
+    private fileCache;
+    /**
+     * @param configFilePath - Absolute path to the flat config file.
+     * @param resolvers - Resolvers to use.
+     */
+    constructor(configFilePath: string, resolvers?: Resolver[]);
+    /**
+     * Search `dir` and its ancestors for a flat config file and, if found,
+     * return a new `FlatConfigLoader` pointed at it.  Returns `null` when no
+     * config file can be found.
+     *
+     * @param dir - Directory to start searching from.
+     * @param resolvers - Resolvers to use.
+     */
+    static fromDirectory(dir: string, resolvers?: Resolver[]): FlatConfigLoader | null;
+    /**
+     * Get configuration for the given filename.
+     *
+     * Do note that if `configOverride` is changed between calls the cache must be
+     * flushed in-between. This loader caches the final merged result.
+     *
+     * @param filename - Absolute or relative path to the file being validated.
+     * @param configOverride - Optional configuration to merge into the result.
+     */
+    getConfigFor(filename: string, configOverride?: ConfigData): Promise<ResolvedConfig>;
+    /**
+     * Flush the cached flat config, forcing a reload on the next call.
+     */
+    flushCache(handle?: string): void;
+    protected defaultConfig(): Config;
+    private loadConfig;
+}
+
+/**
+ * A single object in a flat configuration file.
+ *
+ * @public
+ * @since 11.5.0
+ */
+export declare interface FlatConfigObject {
+    /**
+     * Optional name of this configuration object.
+     *
+     * Used for troubleshooting and error messages.
+     */
+    name?: string;
+    /**
+     * An array of glob patterns indicating the files that the configuration
+     * object should apply to.
+     *
+     * If not specified, the configuration object applies to all files matched by
+     * any other configuration object.
+     */
+    files?: string[];
+    /**
+     * An array of glob patterns indicating the files that the configuration object should not apply to.
+     *
+     * If not specified, the configuration object applies to all files matches by `files`.
+     *
+     * If `ignores` is used without any other keys in the configuration object,
+     * then the patterns act as a global ignores and gets applied to every
+     * configuration object.
+     */
+    ignores?: string[];
+    /**
+     * Element metadata sources.
+     */
+    elements?: MetaDataTable[];
+    /**
+     * Plugins
+     */
+    plugins?: Plugin_2[];
+    /**
+     * Source file transformations.
+     *
+     * Maps a regular-expression pattern (matched against the filename) to a
+     * transformer function.
+     */
+    transform?: Record<string, Transformer_2>;
+    /**
+     * Rule configuration.
+     */
+    rules?: RuleConfig;
+}
+
 /**
  * @public
  */
@@ -1705,10 +1833,19 @@ export declare interface MetaAttribute {
      */
     deprecated?: boolean | string;
     /**
-     * If set it is an exhaustive list of all possible values (as `string` or
-     * `RegExp`) this attribute can have (each token if list is set)
+     * If set it is an exhaustive list of all possible values this attribute can
+     * have (each token if list is set).
+     *
+     * Each entry can either be:
+     *
+     * - A keyword (as string).
+     * - A regular expression.
+     * - An object with `name` and `pattern` (regular expression).
+     *
+     * When using an object the name is presented in error messages and contextual
+     * documentation.
      */
-    enum?: Array<string | RegExp>;
+    enum?: Array<string | RegExp | MetaAttributeNamedRegex>;
     /**
      * If `true` this attribute contains space-separated tokens and each token must
      * be valid by itself.
@@ -1718,6 +1855,16 @@ export declare interface MetaAttribute {
      * If `true` this attribute can omit the value.
      */
     omit?: boolean;
+    /**
+     * When set, this attribute references another element by the given type. If
+     * `list` is also set, each individual token in the attribute value references another
+     * element.
+     *
+     * - `id`: the attribute value references the id of another element in the document.
+     *
+     * @since 11.4.0
+     */
+    reference?: "id";
     /**
      * If set this attribute is required to be present on the element.
      */
@@ -1735,6 +1882,19 @@ export declare interface MetaAttribute {
  */
 export declare type MetaAttributeAllowedCallback = (node: HtmlElementLike, attr: string | DynamicValue | null | undefined) => string | null | undefined;
 
+/**
+ * A named regular expression for use in attribute value validation.
+ *
+ * @public
+ * @since 11.5.0
+ */
+export declare interface MetaAttributeNamedRegex {
+    /** Human-readable label shown in error documentation. */
+    name: string;
+    /** Regular expression used for validation. */
+    pattern: RegExp | string;
+}
+
 /**
  * Callback for the `required` property of `MetaAttribute`.
  *
@@ -2454,7 +2614,7 @@ export declare class ResolvedConfig {
      * Returns the (merged) configuration data used to create this resolved
      * configuration.
      */
-    getConfigData(): ConfigData;
+    getConfigData(): ConfigData | FlatConfig;
     getMetaTable(): MetaTable;
     getPlugins(): Plugin_2[];
     getRules(): Map<string, [Severity, RuleOptions]>;

package/dist/types/presets.d.ts

@@ -0,0 +1,8 @@
+import { FlatConfigObject } from "html-validate";
+
+export declare const a11y: FlatConfigObject;
+export declare const browser: FlatConfigObject;
+export declare const document: FlatConfigObject;
+export declare const prettier: FlatConfigObject;
+export declare const recommended: FlatConfigObject;
+export declare const standard: FlatConfigObject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-validate",
-  "version": "11.3.0",
+  "version": "11.5.0",
   "description": "Offline HTML5 validator and linter",
   "keywords": [
     "html",
@@ -62,6 +62,11 @@
       "import": "./dist/esm/html5.js",
       "require": "./dist/cjs/html5.js"
     },
+    "./presets": {
+      "types": "./dist/types/presets.d.ts",
+      "import": "./dist/esm/presets.js",
+      "require": "./dist/cjs/presets.js"
+    },
     "./jest": {
       "types": "./dist/types/jest.d.ts",
       "import": "./dist/esm/jest.js",
@@ -121,6 +126,6 @@
     }
   },
   "engines": {
-    "node": "^22.17.0 || >= 24.0.0"
+    "node": "^22.22.0 || >= 24.8.0"
   }
 }