html-validate 7.15.3 → 7.17.0

package/dist/schema/config.json

@@ -40,7 +40,7 @@
     "plugins": {
       "type": "array",
       "items": {
-        "type": "string"
+        "anyOf": [{ "type": "string" }, { "type": "object" }]
       },
       "title": "Plugins to load",
       "description": "Array of plugins load. Use <rootDir> to refer to the folder with the package.json file.",

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.7"
+      "packageVersion": "7.34.8"
     }
   ]
 }

package/dist/types/browser.d.ts

@@ -273,7 +273,7 @@ export declare interface ConfigData {
      *
      * Each plugin must be resolvable be require and export the plugin interface.
      */
-    plugins?: string[];
+    plugins?: Array<string | Plugin_2>;
     /**
      * List of source file transformations. A transformer takes a filename and
      * returns Source instances with extracted HTML-templates.
@@ -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.
      *
@@ -1291,13 +1294,6 @@ export declare class MetaTable {
      * @param filename - Optional filename used when presenting validation error
      */
     loadFromObject(obj: unknown, filename?: string | null): void;
-    /**
-     * Load metadata table from filename
-     *
-     * @public
-     * @param filename - Filename to load
-     */
-    loadFromFile(filename: string): void;
     /**
      * Get [[MetaElement]] for the given tag. If no specific metadata is present
      * the global metadata is returned or null if no global is present.
@@ -1647,7 +1643,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]>;
@@ -2030,13 +2033,13 @@ export declare interface SourceReadyEvent extends Event_2 {
  * The static configuration loader does not do any per-handle lookup. Only the
  * global or per-call configuration is used.
  *
- * In practice this means no configuration is fetch by traversing the
+ * In practice this means no configuration is fetched by traversing the
  * filesystem.
  *
  * @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

@@ -368,7 +368,7 @@ export declare interface ConfigData {
      *
      * Each plugin must be resolvable be require and export the plugin interface.
      */
-    plugins?: string[];
+    plugins?: Array<string | Plugin_2>;
     /**
      * List of source file transformations. A transformer takes a filename and
      * returns Source instances with extracted HTML-templates.
@@ -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.
      *
@@ -1484,13 +1487,6 @@ export declare class MetaTable {
      * @param filename - Optional filename used when presenting validation error
      */
     loadFromObject(obj: unknown, filename?: string | null): void;
-    /**
-     * Load metadata table from filename
-     *
-     * @public
-     * @param filename - Filename to load
-     */
-    loadFromFile(filename: string): void;
     /**
      * Get [[MetaElement]] for the given tag. If no specific metadata is present
      * the global metadata is returned or null if no global is present.
@@ -1840,7 +1836,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]>;
@@ -2223,13 +2226,13 @@ export declare interface SourceReadyEvent extends Event_2 {
  * The static configuration loader does not do any per-handle lookup. Only the
  * global or per-call configuration is used.
  *
- * In practice this means no configuration is fetch by traversing the
+ * In practice this means no configuration is fetched by traversing the
  * filesystem.
  *
  * @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.17.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",
@@ -171,15 +171,15 @@
     "semver": "^7.0.0"
   },
   "devDependencies": {
-    "@html-validate/commitlint-config": "3.0.14",
-    "@html-validate/eslint-config": "5.9.2",
+    "@html-validate/commitlint-config": "3.0.15",
+    "@html-validate/eslint-config": "5.9.4",
     "@html-validate/eslint-config-jest": "5.9.0",
-    "@html-validate/eslint-config-typescript": "5.9.3",
+    "@html-validate/eslint-config-typescript": "5.9.4",
     "@html-validate/eslint-config-typescript-typeinfo": "5.9.0",
     "@html-validate/jest-config": "3.7.5",
     "@html-validate/prettier-config": "2.3.10",
     "@html-validate/release-scripts": "4.0.6",
-    "@microsoft/api-extractor": "7.34.7",
+    "@microsoft/api-extractor": "7.34.8",
     "@rollup/plugin-json": "6.0.0",
     "@rollup/plugin-node-resolve": "15.0.2",
     "@rollup/plugin-replace": "5.0.2",
@@ -190,9 +190,9 @@
     "@types/estree": "1.0.1",
     "@types/jest": "29.5.1",
     "@types/minimist": "1.2.2",
-    "@types/node": "14.18.43",
+    "@types/node": "14.18.46",
     "@types/prompts": "2.4.4",
-    "@types/semver": "7.3.13",
+    "@types/semver": "7.5.0",
     "@types/stream-buffers": "3.0.4",
     "babar": "0.2.3",
     "husky": "8.0.3",
@@ -202,9 +202,9 @@
     "jest-environment-jsdom": "29.5.0",
     "jest-snapshot": "29.5.0",
     "memfs": "3.5.1",
-    "npm-pkg-lint": "1.14.0",
+    "npm-pkg-lint": "1.14.1",
     "npm-run-all": "4.1.5",
-    "rollup": "3.21.3",
+    "rollup": "3.21.6",
     "stream-buffers": "3.0.2",
     "ts-jest": "29.1.0",
     "typescript": "5.0.4"