html-validate 11.4.0 → 11.5.1

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.
@@ -1745,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`.
  *
@@ -2464,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.4.0",
+  "version": "11.5.1",
   "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"
   }
 }