html-validate 8.7.3 → 8.8.0

package/dist/types/index.d.ts

@@ -113,6 +113,21 @@ export declare interface AvailableFormatters {
  */
 export declare type CategoryOrTag = string;
 
+/**
+ * Create a new resolver for NodeJS packages using `require(..)`.
+ *
+ * If the module name contains `<rootDir>` (e.g. `<rootDir/foo`) it will be
+ * expanded relative to the root directory either explicitly set by the
+ * `rootDir` parameter or determined automatically by the closest `package.json`
+ * file (starting at the current working directory).
+ *
+ * @public
+ * @since 8.8.0
+ */
+export declare function cjsResolver(options?: {
+    rootDir?: string;
+}): CommonJSResolver;
+
 /**
  * Checks text content of an element.
  *
@@ -147,7 +162,7 @@ export declare class CLI {
      * @public
      */
     expandFiles(patterns: string[], options?: ExpandOptions): string[];
-    getFormatter(formatters: string): (report: Report) => string;
+    getFormatter(formatters: string): (report: Report_2) => string;
     /**
      * Initialize project with a new configuration.
      *
@@ -189,6 +204,14 @@ export declare interface CLIOptions {
 
 /* Excluded from this release type: CommentToken */
 
+/**
+ * CommonJS resolver.
+ *
+ * @public
+ * @since 8.8.0
+ */
+export declare type CommonJSResolver = Required<Resolver>;
+
 /**
  * Tests if plugin is compatible with html-validate library. Unless the `silent`
  * option is used a warning is displayed on the console.
@@ -260,6 +283,7 @@ export declare class Config {
      * Load a default configuration object.
      */
     static defaultConfig(): Config;
+    /* Excluded from this release type: create */
     /* Excluded from this release type: __constructor */
     /**
      * Initialize plugins, transforms etc.
@@ -336,6 +360,16 @@ export declare interface ConfigData {
      * If set to true no new configurations will be searched.
      */
     root?: boolean;
+    /**
+     * List of configuration presets to extend.
+     *
+     * The following sources are allowed:
+     *
+     * - One of the [predefined presets](http://html-validate.org/rules/presets.html).
+     * - Node module exporting a preset.
+     * - Plugin exporting a named preset.
+     * - Local path to a json or js file exporting a preset.
+     */
     extends?: string[];
     /**
      * List of sources for element metadata.
@@ -448,6 +482,14 @@ export declare interface DeferredMessage extends Omit<Message, "selector"> {
     selector: () => string | null;
 }
 
+/**
+ * Helper function to assist IDE with completion and type-checking.
+ *
+ * @public
+ * @since
+ */
+export declare function defineConfig(config: ConfigData): ConfigData;
+
 /**
  * Helper function to assist IDE with completion and type-checking.
  *
@@ -1124,13 +1166,13 @@ export declare class HtmlValidate {
      * @param hooks - Optional hooks (see [[Source]]) for definition.
      * @returns Report output.
      */
-    validateString(str: string): Promise<Report>;
-    validateString(str: string, filename: string): Promise<Report>;
-    validateString(str: string, hooks: SourceHooks): Promise<Report>;
-    validateString(str: string, options: ConfigData): Promise<Report>;
-    validateString(str: string, filename: string, hooks: SourceHooks): Promise<Report>;
-    validateString(str: string, filename: string, options: ConfigData): Promise<Report>;
-    validateString(str: string, filename: string, options: ConfigData, hooks: SourceHooks): Promise<Report>;
+    validateString(str: string): Promise<Report_2>;
+    validateString(str: string, filename: string): Promise<Report_2>;
+    validateString(str: string, hooks: SourceHooks): Promise<Report_2>;
+    validateString(str: string, options: ConfigData): Promise<Report_2>;
+    validateString(str: string, filename: string, hooks: SourceHooks): Promise<Report_2>;
+    validateString(str: string, filename: string, options: ConfigData): Promise<Report_2>;
+    validateString(str: string, filename: string, options: ConfigData, hooks: SourceHooks): Promise<Report_2>;
     /**
      * Parse and validate HTML from string.
      *
@@ -1140,13 +1182,13 @@ export declare class HtmlValidate {
      * @param hooks - Optional hooks (see [[Source]]) for definition.
      * @returns Report output.
      */
-    validateStringSync(str: string): Report;
-    validateStringSync(str: string, filename: string): Report;
-    validateStringSync(str: string, hooks: SourceHooks): Report;
-    validateStringSync(str: string, options: ConfigData): Report;
-    validateStringSync(str: string, filename: string, hooks: SourceHooks): Report;
-    validateStringSync(str: string, filename: string, options: ConfigData): Report;
-    validateStringSync(str: string, filename: string, options: ConfigData, hooks: SourceHooks): Report;
+    validateStringSync(str: string): Report_2;
+    validateStringSync(str: string, filename: string): Report_2;
+    validateStringSync(str: string, hooks: SourceHooks): Report_2;
+    validateStringSync(str: string, options: ConfigData): Report_2;
+    validateStringSync(str: string, filename: string, hooks: SourceHooks): Report_2;
+    validateStringSync(str: string, filename: string, options: ConfigData): Report_2;
+    validateStringSync(str: string, filename: string, options: ConfigData, hooks: SourceHooks): Report_2;
     /**
      * Parse and validate HTML from [[Source]].
      *
@@ -1154,7 +1196,7 @@ export declare class HtmlValidate {
      * @param input - Source to parse.
      * @returns Report output.
      */
-    validateSource(input: Source, configOverride?: ConfigData): Promise<Report>;
+    validateSource(input: Source, configOverride?: ConfigData): Promise<Report_2>;
     /**
      * Parse and validate HTML from [[Source]].
      *
@@ -1162,7 +1204,7 @@ export declare class HtmlValidate {
      * @param input - Source to parse.
      * @returns Report output.
      */
-    validateSourceSync(input: Source, configOverride?: ConfigData): Report;
+    validateSourceSync(input: Source, configOverride?: ConfigData): Report_2;
     /**
      * Parse and validate HTML from file.
      *
@@ -1170,7 +1212,7 @@ export declare class HtmlValidate {
      * @param filename - Filename to read and parse.
      * @returns Report output.
      */
-    validateFile(filename: string): Promise<Report>;
+    validateFile(filename: string): Promise<Report_2>;
     /**
      * Parse and validate HTML from file.
      *
@@ -1178,7 +1220,7 @@ export declare class HtmlValidate {
      * @param filename - Filename to read and parse.
      * @returns Report output.
      */
-    validateFileSync(filename: string): Report;
+    validateFileSync(filename: string): Report_2;
     /**
      * Parse and validate HTML from multiple files. Result is merged together to a
      * single report.
@@ -1186,7 +1228,7 @@ export declare class HtmlValidate {
      * @param filenames - Filenames to read and parse.
      * @returns Report output.
      */
-    validateMultipleFiles(filenames: string[]): Promise<Report>;
+    validateMultipleFiles(filenames: string[]): Promise<Report_2>;
     /**
      * Parse and validate HTML from multiple files. Result is merged together to a
      * single report.
@@ -1194,7 +1236,7 @@ export declare class HtmlValidate {
      * @param filenames - Filenames to read and parse.
      * @returns Report output.
      */
-    validateMultipleFilesSync(filenames: string[]): Report;
+    validateMultipleFilesSync(filenames: string[]): Report_2;
     /**
      * Returns true if the given filename can be validated.
      *
@@ -1755,9 +1797,10 @@ export declare enum NodeClosed {
 }
 
 /**
- * NodeJS resolver.
+ * CommonJS resolver.
  *
  * @public
+ * @deprecated Deprecated alias for [[CommonJSResolver]].
  * @since 8.0.0
  */
 export declare type NodeJSResolver = Required<Resolver>;
@@ -1771,6 +1814,7 @@ export declare type NodeJSResolver = Required<Resolver>;
  * file (starting at the current working directory).
  *
  * @public
+ * @deprecated Deprecated alias for [[commonjsResolver]].
  * @since 8.0.0
  */
 export declare function nodejsResolver(options?: {
@@ -2022,7 +2066,7 @@ export declare type PropertyExpression = string | [string, any];
  *
  * @public
  */
-export declare interface Report {
+declare interface Report_2 {
     /** `true` if validation was successful */
     valid: boolean;
     /** Detailed results per validated source */
@@ -2032,6 +2076,7 @@ export declare interface Report {
     /** Total warnings of errors across all sources */
     warningCount: number;
 }
+export { Report_2 as Report }
 
 /**
  * @public
@@ -2041,11 +2086,21 @@ export declare class Reporter {
     constructor();
     /**
      * Merge two or more reports into a single one.
+     *
+     * @param reports- Reports to merge.
+     * @returns A merged report.
+     */
+    static merge(reports: Report_2[]): Report_2;
+    /**
+     * Merge two or more reports into a single one.
+     *
+     * @param reports- Reports to merge.
+     * @returns A promise resolved with the merged report.
      */
-    static merge(reports: Report[]): Report;
+    static merge(reports: Promise<Report_2[]> | Array<Promise<Report_2>>): Promise<Report_2>;
     add<ContextType, OptionsType>(rule: Rule<ContextType, OptionsType>, message: string, severity: number, node: DOMNode | null, location: Location_2, context: ContextType): void;
     addManual(filename: string, message: DeferredMessage): void;
-    save(sources?: Source[]): Report;
+    save(sources?: Source[]): Report_2;
     protected isValid(): boolean;
 }
 
@@ -2128,7 +2183,7 @@ export declare interface Resolver {
     /**
      * Resolve table of element metadata.
      */
-    resolveElements?(id: string, options: ResolverOptions): unknown | null;
+    resolveElements?(id: string, options: ResolverOptions): MetaDataTable | null;
     /**
      * Resolve a configuration to extend.
      */
@@ -2353,13 +2408,15 @@ export { SchemaObject }
  * @public
  */
 export declare class SchemaValidationError extends UserError {
-    filename: string | null;
-    private obj;
-    private schema;
-    private errors;
+    /** Configuration filename the error originates from */
+    readonly filename: string | null;
+    /** Configuration object the error originates from */
+    readonly obj: unknown;
+    /** JSON schema used when validating the configuration */
+    readonly schema: SchemaObject;
+    /** List of schema validation errors */
+    readonly errors: ErrorObject[];
     constructor(filename: string | null, message: string, obj: unknown, schema: SchemaObject, errors: ErrorObject[]);
-    prettyError(): string;
-    private getRawJSON;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-validate",
-  "version": "8.7.3",
+  "version": "8.8.0",
   "description": "Offline html5 validator",
   "keywords": [
     "html",
@@ -190,7 +190,7 @@
   "dependencies": {
     "@babel/code-frame": "^7.10.0",
     "@html-validate/stylish": "^4.1.0",
-    "@sidvind/better-ajv-errors": "^2.0.0",
+    "@sidvind/better-ajv-errors": "2.1.3",
     "ajv": "^8.0.0",
     "deepmerge": "4.3.1",
     "glob": "^10.0.0",
@@ -201,26 +201,25 @@
     "semver": "^7.0.0"
   },
   "devDependencies": {
-    "@html-validate/commitlint-config": "3.0.26",
-    "@html-validate/eslint-config": "5.11.12",
-    "@html-validate/eslint-config-jest": "5.11.12",
-    "@html-validate/eslint-config-typescript": "5.11.12",
-    "@html-validate/eslint-config-typescript-typeinfo": "5.11.12",
+    "@html-validate/commitlint-config": "3.0.27",
+    "@html-validate/eslint-config": "5.12.4",
+    "@html-validate/eslint-config-jest": "5.12.0",
+    "@html-validate/eslint-config-typescript": "5.12.4",
+    "@html-validate/eslint-config-typescript-typeinfo": "5.12.4",
     "@html-validate/jest-config": "3.7.7",
-    "@html-validate/prettier-config": "2.4.9",
-    "@html-validate/release-scripts": "5.0.2",
-    "@microsoft/api-extractor": "7.38.3",
+    "@html-validate/prettier-config": "2.4.10",
+    "@html-validate/release-scripts": "5.0.4",
+    "@microsoft/api-extractor": "7.39.0",
     "@rollup/plugin-commonjs": "25.0.7",
-    "@rollup/plugin-json": "6.0.1",
+    "@rollup/plugin-json": "6.1.0",
     "@rollup/plugin-node-resolve": "15.2.3",
     "@rollup/plugin-replace": "5.0.5",
-    "@rollup/plugin-typescript": "11.1.5",
     "@rollup/plugin-virtual": "3.0.2",
     "@types/babar": "0.2.4",
     "@types/babel__code-frame": "7.0.6",
-    "@types/jest": "29.5.10",
+    "@types/jest": "29.5.11",
     "@types/minimist": "1.2.5",
-    "@types/node": "16.18.64",
+    "@types/node": "16.18.68",
     "@types/prompts": "2.4.9",
     "@types/semver": "7.5.6",
     "@types/stream-buffers": "3.0.7",
@@ -231,19 +230,21 @@
     "jest-diff": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
     "jest-snapshot": "29.7.0",
+    "marked": "11.1.0",
     "memfs": "4.6.0",
     "npm-pkg-lint": "2.1.0",
     "npm-run-all": "4.1.5",
-    "rollup": "4.5.1",
+    "rollup": "4.9.1",
+    "rollup-plugin-esbuild": "6.1.0",
     "stream-buffers": "3.0.2",
     "ts-jest": "29.1.1",
-    "typescript": "5.3.2"
+    "typescript": "5.3.3"
   },
   "peerDependencies": {
     "jest": "^27.1 || ^28.1.3 || ^29.0.3",
     "jest-diff": "^27.1 || ^28.1.3 || ^29.0.3",
     "jest-snapshot": "^27.1 || ^28.1.3 || ^29.0.3",
-    "vitest": "^0.34"
+    "vitest": "^0.34 || ^1"
   },
   "peerDependenciesMeta": {
     "jest": {
@@ -260,7 +261,7 @@
     }
   },
   "engines": {
-    "node": ">= 16.0"
+    "node": ">= 16.14"
   },
   "externalDependencies": [
     "@babel/code-frame",
@@ -273,6 +274,9 @@
     "prompts",
     "semver"
   ],
+  "overrides": {
+    "marked": "11.1.0"
+  },
   "renovate": {
     "extends": [
       "gitlab>html-validate/renovate-config"