html-validate 7.14.0 → 7.15.1

package/dist/types/jest.d.ts

@@ -0,0 +1,44 @@
+export { }
+
+
+
+import { type ConfigData } from "./index"
+import { type Message } from "./index"
+declare global {
+    namespace jest {
+        interface Matchers<R, T = {}> {
+            toBeValid(): R;
+            toBeInvalid(): R;
+            toHaveError(error: Partial<Message>): R;
+            toHaveError(ruleId: string, message: string, context?: any): R;
+            toHaveErrors(errors: Array<[string, string] | Record<string, unknown>>): R;
+            /**
+             * Validate string or HTMLElement.
+             *
+             * Test passes if result is valid.
+             *
+             * @param config - Optional HTML-Validate configuration object.
+             * @param filename - Optional filename used when matching transformer and
+             * loading configuration.
+             */
+            toHTMLValidate(): R;
+            toHTMLValidate(filename: string): R;
+            toHTMLValidate(config: ConfigData): R;
+            toHTMLValidate(config: ConfigData, filename: string): R;
+            toHTMLValidate(error: Partial<Message>): R;
+            toHTMLValidate(error: Partial<Message>, filename: string): R;
+            toHTMLValidate(error: Partial<Message>, config: ConfigData): R;
+            toHTMLValidate(error: Partial<Message>, config: ConfigData, filename: string): R;
+            /**
+             * Writes out the given [[Report]] using codeframe formatter and compares
+             * with snapshot.
+             */
+            toMatchCodeframe(snapshot?: string): R;
+            /**
+             * Writes out the given [[Report]] using codeframe formatter and compares
+             * with inline snapshot.
+             */
+            toMatchInlineCodeframe(snapshot?: string): R;
+        }
+    }
+}

package/dist/types/test-utils.d.ts

@@ -0,0 +1,40 @@
+import { Source } from 'html-validate';
+import { TransformContext } from 'html-validate';
+
+/**
+ * @public
+ */
+declare type Transformer_2 = (this: TransformContext, source: Source) => Iterable<Source>;
+export { Transformer_2 as Transformer }
+
+/**
+ * Helper function to call a transformer function in test-cases.
+ *
+ * @public
+ * @param fn - Transformer function to call.
+ * @param filename - Filename to read data from. Must be readable.
+ * @param chain - If set this function is called when chaining transformers. Default is pass-thru.
+ */
+export declare function transformFile(fn: Transformer_2, filename: string, chain?: (source: Source, filename: string) => Iterable<Source>): Source[];
+
+/**
+ * Helper function to call a transformer function in test-cases.
+ *
+ * @public
+ * @param fn - Transformer function to call.
+ * @param data - Source to transform.
+ * @param chain - If set this function is called when chaining transformers. Default is pass-thru.
+ */
+export declare function transformSource(fn: Transformer_2, source: Source, chain?: (source: Source, filename: string) => Iterable<Source>): Source[];
+
+/**
+ * Helper function to call a transformer function in test-cases.
+ *
+ * @public
+ * @param fn - Transformer function to call.
+ * @param data - String to transform.
+ * @param chain - If set this function is called when chaining transformers. Default is pass-thru.
+ */
+export declare function transformString(fn: Transformer_2, data: string, chain?: (source: Source, filename: string) => Iterable<Source>): Source[];
+
+export { }

package/jest.d.ts

@@ -1,2 +1 @@
-/* eslint-disable-next-line import/export, import/no-unresolved */
-export * from "./dist/cjs/jest";
+export * from "./dist/types/jest";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-validate",
-  "version": "7.14.0",
+  "version": "7.15.1",
   "description": "Offline html5 validator",
   "keywords": [
     "html",
@@ -25,19 +25,29 @@
   "exports": {
     ".": {
       "require": "./dist/cjs/index.js",
-      "import": "./dist/es/index.js"
+      "import": "./dist/es/index.js",
+      "types": "./dist/types/index.d.ts"
     },
     "./browser": {
       "require": "./dist/cjs/browser.js",
-      "import": "./dist/es/browser.js"
+      "import": "./dist/es/browser.js",
+      "types": "./dist/types/browser.d.ts"
     },
     "./dist/cjs/*": "./dist/cjs/*",
     "./dist/es/*": "./dist/es/*",
     "./dist/schema/*": "./dist/schema/*",
     "./elements/*": "./elements/*",
-    "./jest": "./jest.js",
+    "./jest": {
+      "require": "./dist/cjs/jest.js",
+      "import": "./dist/es/jest.js",
+      "types": "./dist/types/jest.d.ts"
+    },
     "./package.json": "./package.json",
-    "./test-utils": "./test-utils.js"
+    "./test-utils": {
+      "require": "./dist/cjs/test-utils.js",
+      "import": "./dist/es/test-utils.js",
+      "types": "./dist/types/test-utils.d.ts"
+    }
   },
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
@@ -51,23 +61,19 @@
     "elements",
     "browser.{js,d.ts}",
     "jest.{js,d.ts}",
-    "test-utils.{js,d.ts}",
-    "!dist/types/**",
-    "!tsconfig.json",
-    "!**/*.snap",
-    "!**/*.spec.{js,ts,d.ts}"
+    "test-utils.{js,d.ts}"
   ],
   "workspaces": [
     "docs"
   ],
   "scripts": {
     "prebuild": "run-s codegen prebuild:*",
-    "build": "run-s build:*",
+    "build": "run-s build:cjs build:esm build:script",
     "postbuild": "bash scripts/pkg",
     "prebuild:tsc": "tsc",
     "build:cjs": "rollup --config rollup.cjs.config.mjs",
-    "build:dts": "rollup --config rollup.dts.config.mjs",
     "build:esm": "rollup --config rollup.esm.config.mjs",
+    "build:script": "node build.mjs",
     "clean": "rm -rf dist public",
     "codegen": "node scripts/codegen",
     "compatibility": "scripts/compatibility.sh",
@@ -165,43 +171,43 @@
     "semver": "^7.0.0"
   },
   "devDependencies": {
-    "@html-validate/commitlint-config": "3.0.12",
-    "@html-validate/eslint-config": "5.6.0",
-    "@html-validate/eslint-config-jest": "5.6.0",
-    "@html-validate/eslint-config-typescript": "5.6.0",
-    "@html-validate/eslint-config-typescript-typeinfo": "5.6.0",
+    "@html-validate/commitlint-config": "3.0.13",
+    "@html-validate/eslint-config": "5.7.3",
+    "@html-validate/eslint-config-jest": "5.7.0",
+    "@html-validate/eslint-config-typescript": "5.7.3",
+    "@html-validate/eslint-config-typescript-typeinfo": "5.7.0",
     "@html-validate/jest-config": "3.6.3",
-    "@html-validate/prettier-config": "2.3.8",
+    "@html-validate/prettier-config": "2.3.9",
     "@html-validate/release-scripts": "4.0.6",
+    "@microsoft/api-extractor": "7.34.4",
     "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.0.1",
+    "@rollup/plugin-node-resolve": "15.0.2",
     "@rollup/plugin-replace": "5.0.2",
-    "@rollup/plugin-typescript": "11.0.0",
+    "@rollup/plugin-typescript": "11.1.0",
     "@rollup/plugin-virtual": "3.0.1",
     "@types/babar": "0.2.1",
     "@types/babel__code-frame": "7.0.3",
     "@types/estree": "1.0.0",
     "@types/jest": "29.5.0",
     "@types/minimist": "1.2.2",
-    "@types/node": "14.18.40",
-    "@types/prompts": "2.4.3",
+    "@types/node": "14.18.42",
+    "@types/prompts": "2.4.4",
     "@types/semver": "7.3.13",
     "@types/stream-buffers": "3.0.4",
     "babar": "0.2.3",
     "husky": "8.0.3",
+    "is-ci": "3.0.1",
     "jest": "29.5.0",
     "jest-diff": "29.5.0",
     "jest-environment-jsdom": "29.5.0",
     "jest-snapshot": "29.5.0",
-    "memfs": "3.4.13",
+    "memfs": "3.5.0",
     "npm-pkg-lint": "1.11.2",
     "npm-run-all": "4.1.5",
     "rollup": "3.20.2",
-    "rollup-plugin-copy": "3.4.0",
-    "rollup-plugin-dts": "5.3.0",
     "stream-buffers": "3.0.2",
-    "ts-jest": "29.0.5",
-    "typescript": "5.0.2"
+    "ts-jest": "29.1.0",
+    "typescript": "5.0.4"
   },
   "peerDependencies": {
     "jest": "^25.1 || ^26 || ^27.1 || ^28.1.3 || ^29.0.3",

package/test-utils.d.ts

@@ -1,2 +1 @@
-/* eslint-disable-next-line import/export, import/no-unresolved */
-export * from "./dist/cjs/test-utils";
+export * from "./dist/types/test-utils";

package/dist/cjs/meta-helper.d.ts

@@ -1,28 +0,0 @@
-import { k as MetaDataTable, n as MetaAttributeAllowedCallback } from './core.js';
-import './rules-helper.js';
-
-/**
- * Helper function to assist IDE with completion and type-checking.
- *
- * @public
- */
-declare function defineMetadata(metatable: MetaDataTable): MetaDataTable;
-
-/**
- * Helpers when writing element metadata.
- *
- * @public
- */
-interface MetadataHelper {
-    /** Returns an error if another attribute is omitted, i.e. it requires another attribute to be present to pass. */
-    allowedIfAttributeIsPresent(this: void, ...attr: string[]): MetaAttributeAllowedCallback;
-    /** Returns an error if another attribute is present, i.e. it requires another attribute to be omitted to pass. */
-    allowedIfAttributeIsAbsent(this: void, ...attr: string[]): MetaAttributeAllowedCallback;
-    /** Returns an error if another attribute does not have one of the listed values */
-    allowedIfAttributeHasValue(this: void, attr: string, value: string[], options?: {
-        defaultValue?: string | null;
-    }): MetaAttributeAllowedCallback;
-}
-declare const metadataHelper: MetadataHelper;
-
-export { defineMetadata as d, metadataHelper as m };

package/dist/cjs/rules-helper.d.ts

@@ -1,54 +0,0 @@
-import { f as HtmlElement } from './core.js';
-
-interface IncludeExcludeOptions {
-    include: string[] | null;
-    exclude: string[] | null;
-}
-/**
- * @public
- */
-declare function keywordPatternMatcher(list: string[], keyword: string): boolean;
-
-declare const HTML_CACHE_KEY: unique symbol;
-declare const A11Y_CACHE_KEY: unique symbol;
-declare const IGNORE_HIDDEN_ROOT_HTML_CACHE_KEY: unique symbol;
-declare const IGNORE_HIDDEN_ROOT_A11Y_CACHE_KEY: unique symbol;
-/**
- * @public
- */
-declare enum TextClassification {
-    EMPTY_TEXT = 0,
-    DYNAMIC_TEXT = 1,
-    STATIC_TEXT = 2
-}
-/**
- * @public
- */
-interface TextClassificationOptions {
-    /** If `true` only accessible text is considered (default false) */
-    accessible?: boolean;
-    /** If `true` the `hidden` and `aria-hidden` attribute is ignored on the root
-     * (and parents) elements (default false) */
-    ignoreHiddenRoot?: boolean;
-}
-declare module "../../dom/cache" {
-    interface DOMNodeCache {
-        [HTML_CACHE_KEY]: TextClassification;
-        [A11Y_CACHE_KEY]: TextClassification;
-        [IGNORE_HIDDEN_ROOT_HTML_CACHE_KEY]: TextClassification;
-        [IGNORE_HIDDEN_ROOT_A11Y_CACHE_KEY]: TextClassification;
-    }
-}
-/**
- * Checks text content of an element.
- *
- * Any text is considered including text from descendant elements. Whitespace is
- * ignored.
- *
- * If any text is dynamic `TextClassification.DYNAMIC_TEXT` is returned.
- *
- * @public
- */
-declare function classifyNodeText(node: HtmlElement, options?: TextClassificationOptions): TextClassification;
-
-export { IncludeExcludeOptions as I, TextClassification as T, classifyNodeText as c, keywordPatternMatcher as k };

package/dist/es/meta-helper.d.ts

@@ -1,28 +0,0 @@
-import { k as MetaDataTable, n as MetaAttributeAllowedCallback } from './core.js';
-import './rules-helper.js';
-
-/**
- * Helper function to assist IDE with completion and type-checking.
- *
- * @public
- */
-declare function defineMetadata(metatable: MetaDataTable): MetaDataTable;
-
-/**
- * Helpers when writing element metadata.
- *
- * @public
- */
-interface MetadataHelper {
-    /** Returns an error if another attribute is omitted, i.e. it requires another attribute to be present to pass. */
-    allowedIfAttributeIsPresent(this: void, ...attr: string[]): MetaAttributeAllowedCallback;
-    /** Returns an error if another attribute is present, i.e. it requires another attribute to be omitted to pass. */
-    allowedIfAttributeIsAbsent(this: void, ...attr: string[]): MetaAttributeAllowedCallback;
-    /** Returns an error if another attribute does not have one of the listed values */
-    allowedIfAttributeHasValue(this: void, attr: string, value: string[], options?: {
-        defaultValue?: string | null;
-    }): MetaAttributeAllowedCallback;
-}
-declare const metadataHelper: MetadataHelper;
-
-export { defineMetadata as d, metadataHelper as m };

package/dist/es/rules-helper.d.ts

@@ -1,54 +0,0 @@
-import { f as HtmlElement } from './core.js';
-
-interface IncludeExcludeOptions {
-    include: string[] | null;
-    exclude: string[] | null;
-}
-/**
- * @public
- */
-declare function keywordPatternMatcher(list: string[], keyword: string): boolean;
-
-declare const HTML_CACHE_KEY: unique symbol;
-declare const A11Y_CACHE_KEY: unique symbol;
-declare const IGNORE_HIDDEN_ROOT_HTML_CACHE_KEY: unique symbol;
-declare const IGNORE_HIDDEN_ROOT_A11Y_CACHE_KEY: unique symbol;
-/**
- * @public
- */
-declare enum TextClassification {
-    EMPTY_TEXT = 0,
-    DYNAMIC_TEXT = 1,
-    STATIC_TEXT = 2
-}
-/**
- * @public
- */
-interface TextClassificationOptions {
-    /** If `true` only accessible text is considered (default false) */
-    accessible?: boolean;
-    /** If `true` the `hidden` and `aria-hidden` attribute is ignored on the root
-     * (and parents) elements (default false) */
-    ignoreHiddenRoot?: boolean;
-}
-declare module "../../dom/cache" {
-    interface DOMNodeCache {
-        [HTML_CACHE_KEY]: TextClassification;
-        [A11Y_CACHE_KEY]: TextClassification;
-        [IGNORE_HIDDEN_ROOT_HTML_CACHE_KEY]: TextClassification;
-        [IGNORE_HIDDEN_ROOT_A11Y_CACHE_KEY]: TextClassification;
-    }
-}
-/**
- * Checks text content of an element.
- *
- * Any text is considered including text from descendant elements. Whitespace is
- * ignored.
- *
- * If any text is dynamic `TextClassification.DYNAMIC_TEXT` is returned.
- *
- * @public
- */
-declare function classifyNodeText(node: HtmlElement, options?: TextClassificationOptions): TextClassification;
-
-export { IncludeExcludeOptions as I, TextClassification as T, classifyNodeText as c, keywordPatternMatcher as k };