html-validate 7.15.3 → 7.16.0

package/dist/types/browser.d.ts

@@ -329,10 +329,13 @@ export declare abstract class ConfigLoader {
      *
      * If [[configOverride]] is set it is merged with the final result.
      *
+     * Returning a [[Config]] instance is deprecated and support will be removed
+     * in the next major release.
+     *
      * @param handle - Unique handle to get configuration for.
      * @param configOverride - Optional configuration to merge final results with.
      */
-    abstract getConfigFor(handle: string, configOverride?: ConfigData): Config;
+    abstract getConfigFor(handle: string, configOverride?: ConfigData): Config | ResolvedConfig;
     /**
      * Flush configuration cache.
      *
@@ -1035,7 +1038,7 @@ export declare class HtmlValidate {
      * @param context - If set to `Message.context` some rules can provide
      * contextual details and suggestions.
      */
-    getRuleDocumentation(ruleId: string, config?: Config | null, context?: any | null): RuleDocumentation | null;
+    getRuleDocumentation(ruleId: string, config?: ResolvedConfig | null, context?: any | null): RuleDocumentation | null;
     /* Excluded from this release type: getParserFor */
     /**
      * Get configuration for given filename.
@@ -1046,7 +1049,7 @@ export declare class HtmlValidate {
      * @param filename - Filename to get configuration for.
      * @param configOverride - Configuration to apply last.
      */
-    getConfigFor(filename: string, configOverride?: ConfigData): Config;
+    getConfigFor(filename: string, configOverride?: ConfigData): ResolvedConfig;
     /**
      * Flush configuration cache. Clears full cache unless a filename is given.
      *
@@ -1647,7 +1650,14 @@ export declare class ResolvedConfig {
     private plugins;
     private rules;
     private transformers;
-    constructor({ metaTable, plugins, rules, transformers }: ResolvedConfigData);
+    /** The original data this resolved configuration was created from */
+    private original;
+    /* Excluded from this release type: __constructor */
+    /**
+     * Returns the (merged) configuration data used to create this resolved
+     * configuration.
+     */
+    getConfigData(): ConfigData;
     getMetaTable(): MetaTable;
     getPlugins(): Plugin_2[];
     getRules(): Map<string, [Severity, RuleOptions]>;
@@ -2036,7 +2046,7 @@ export declare interface SourceReadyEvent extends Event_2 {
  * @public
  */
 export declare class StaticConfigLoader extends ConfigLoader {
-    getConfigFor(handle: string, configOverride?: ConfigData): Config;
+    getConfigFor(handle: string, configOverride?: ConfigData): ResolvedConfig;
     flushCache(): void;
     protected defaultConfig(): Config;
 }

package/dist/types/index.d.ts

@@ -424,10 +424,13 @@ export declare abstract class ConfigLoader {
      *
      * If [[configOverride]] is set it is merged with the final result.
      *
+     * Returning a [[Config]] instance is deprecated and support will be removed
+     * in the next major release.
+     *
      * @param handle - Unique handle to get configuration for.
      * @param configOverride - Optional configuration to merge final results with.
      */
-    abstract getConfigFor(handle: string, configOverride?: ConfigData): Config;
+    abstract getConfigFor(handle: string, configOverride?: ConfigData): Config | ResolvedConfig;
     /**
      * Flush configuration cache.
      *
@@ -858,7 +861,7 @@ export declare class FileSystemConfigLoader extends ConfigLoader {
      * @param filename - Filename to get configuration for.
      * @param configOverride - Configuration to merge final result with.
      */
-    getConfigFor(filename: string, configOverride?: ConfigData): Config;
+    getConfigFor(filename: string, configOverride?: ConfigData): ResolvedConfig;
     /**
      * Flush configuration cache.
      *
@@ -1221,7 +1224,7 @@ export declare class HtmlValidate {
      * @param context - If set to `Message.context` some rules can provide
      * contextual details and suggestions.
      */
-    getRuleDocumentation(ruleId: string, config?: Config | null, context?: any | null): RuleDocumentation | null;
+    getRuleDocumentation(ruleId: string, config?: ResolvedConfig | null, context?: any | null): RuleDocumentation | null;
     /* Excluded from this release type: getParserFor */
     /**
      * Get configuration for given filename.
@@ -1232,7 +1235,7 @@ export declare class HtmlValidate {
      * @param filename - Filename to get configuration for.
      * @param configOverride - Configuration to apply last.
      */
-    getConfigFor(filename: string, configOverride?: ConfigData): Config;
+    getConfigFor(filename: string, configOverride?: ConfigData): ResolvedConfig;
     /**
      * Flush configuration cache. Clears full cache unless a filename is given.
      *
@@ -1840,7 +1843,14 @@ export declare class ResolvedConfig {
     private plugins;
     private rules;
     private transformers;
-    constructor({ metaTable, plugins, rules, transformers }: ResolvedConfigData);
+    /** The original data this resolved configuration was created from */
+    private original;
+    /* Excluded from this release type: __constructor */
+    /**
+     * Returns the (merged) configuration data used to create this resolved
+     * configuration.
+     */
+    getConfigData(): ConfigData;
     getMetaTable(): MetaTable;
     getPlugins(): Plugin_2[];
     getRules(): Map<string, [Severity, RuleOptions]>;
@@ -2229,7 +2239,7 @@ export declare interface SourceReadyEvent extends Event_2 {
  * @public
  */
 export declare class StaticConfigLoader extends ConfigLoader {
-    getConfigFor(handle: string, configOverride?: ConfigData): Config;
+    getConfigFor(handle: string, configOverride?: ConfigData): ResolvedConfig;
     flushCache(): void;
     protected defaultConfig(): Config;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-validate",
-  "version": "7.15.3",
+  "version": "7.16.0",
   "description": "Offline html5 validator",
   "keywords": [
     "html",
@@ -157,7 +157,7 @@
   },
   "dependencies": {
     "@babel/code-frame": "^7.10.0",
-    "@html-validate/stylish": "^3.0.0",
+    "@html-validate/stylish": "^4.0.1",
     "@sidvind/better-ajv-errors": "^2.0.0",
     "acorn-walk": "^8.0.0",
     "ajv": "^8.0.0",