@markuplint/ml-core 4.13.2 → 4.13.3

package/lib/test/index.js

@@ -2,6 +2,15 @@ import { parser } from '@markuplint/html-parser';
 import spec from '@markuplint/html-spec';
 import { convertRuleset } from '../convert-ruleset.js';
 import { MLDocument } from '../ml-dom/node/document.js';
+/**
+ * Parses markup source code and returns a test document for use in rule tests.
+ *
+ * @template T - The rule config value type
+ * @template O - The rule options type
+ * @param sourceCode - The markup source code to parse
+ * @param options - Options for parser, config, specs, and pretenders
+ * @returns A parsed MLDocument instance
+ */
 export function createTestDocument(sourceCode, options) {
     const ast = options?.parser
         ? 'parser' in options.parser
@@ -12,14 +21,37 @@ export function createTestDocument(sourceCode, options) {
     const document = new MLDocument(ast, ruleset, [options?.specs ?? {}, {}]);
     return document;
 }
+/**
+ * Parses markup source code and returns the flat list of AST nodes.
+ *
+ * @param sourceCode - The markup source code to parse
+ * @param options - Options for parser, config, specs, and pretenders
+ * @returns A readonly array of all nodes in the parsed document
+ */
 export function createTestNodeList(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     return document.nodeList;
 }
+/**
+ * Parses markup source code and returns the flat list of tokens.
+ *
+ * @param sourceCode - The markup source code to parse
+ * @param options - Options for parser, config, specs, and pretenders
+ * @returns A readonly array of all tokens in the parsed document
+ */
 export function createTestTokenList(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     return document.getTokenList();
 }
+/**
+ * Parses markup source code and returns the first element node.
+ * Throws if the source does not produce an element as its first node.
+ *
+ * @param sourceCode - The markup source code containing an element
+ * @param options - Options for parser, config, specs, and pretenders
+ * @returns The first element in the parsed document
+ * @throws {TypeError} If the first node is not an element
+ */
 export function createTestElement(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     const el = document.nodeList[0];
@@ -29,7 +61,9 @@ export function createTestElement(sourceCode, options) {
     throw new TypeError(`Could not parse it to be an element from: ${sourceCode}`);
 }
 /**
- * for test suite
+ * Returns the default HTML spec as a schema tuple for use in test suites.
+ *
+ * @returns A single-element tuple containing the HTML specification
  */
 export function dummySchemas() {
     return [spec];

package/lib/types.d.ts

@@ -4,7 +4,15 @@ import type { LocaleSet } from '@markuplint/i18n';
 import type { MLParser, ParserOptions } from '@markuplint/ml-ast';
 import type { Pretender, SeverityOptions } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
+/**
+ * A tuple of the base HTML/ARIA specification and zero or more
+ * framework-specific extended specs (e.g. React, Vue, Svelte).
+ */
 export type MLSchema = readonly [MLMLSpec, ...ExtendedSpec[]];
+/**
+ * The set of dependencies required by {@link MLCore} to perform linting.
+ * Includes the parser, ruleset, rules, locale, schemas, and other settings.
+ */
 export type MLFabric = {
     readonly parser: Readonly<MLParser>;
     readonly ruleset: Partial<Readonly<Ruleset>>;

package/lib/violation-collector.d.ts

@@ -1,12 +1,45 @@
 import type { Violation } from '@markuplint/ml-config';
+/**
+ * Collects and manages lint violations across multiple files.
+ * Supports a maximum violation count to stop collecting early.
+ */
 export declare class ViolationCollector {
     #private;
+    /**
+     * @param maxCount - Maximum number of violations to collect; 0 means unlimited
+     */
     constructor(maxCount?: number);
+    /**
+     * Adds violations associated with a specific file path.
+     * Stops collecting once the maximum count is reached.
+     *
+     * @param filePath - The file that produced these violations
+     * @param violations - The violations to add
+     * @returns The current total number of collected violations
+     */
     pushWithFile(filePath: string, ...violations: readonly Violation[]): number;
+    /**
+     * The total number of collected violations.
+     */
     get length(): number;
+    /**
+     * Whether the collector has reached its maximum count and will no longer accept violations.
+     *
+     * @returns `true` if the collector is locked
+     */
     isLocked(): boolean;
+    /**
+     * Returns a copy of all collected violations as an array.
+     *
+     * @returns An array of violations with their associated file paths
+     */
     toArray(): (Violation & {
         filePath: string;
     })[];
+    /**
+     * Groups collected violations by their file path.
+     *
+     * @returns A Map from file path to an array of violations for that file
+     */
     groupByFile(): Map<string, Violation[]>;
 }

package/lib/violation-collector.js

@@ -10,7 +10,14 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ViolationCollector_violations, _ViolationCollector_maxCount, _ViolationCollector_locked;
+/**
+ * Collects and manages lint violations across multiple files.
+ * Supports a maximum violation count to stop collecting early.
+ */
 export class ViolationCollector {
+    /**
+     * @param maxCount - Maximum number of violations to collect; 0 means unlimited
+     */
     constructor(maxCount = 0) {
         _ViolationCollector_violations.set(this, []);
         _ViolationCollector_maxCount.set(this, 0);
@@ -18,6 +25,14 @@ export class ViolationCollector {
         __classPrivateFieldSet(this, _ViolationCollector_maxCount, maxCount, "f");
         __classPrivateFieldSet(this, _ViolationCollector_locked, false, "f");
     }
+    /**
+     * Adds violations associated with a specific file path.
+     * Stops collecting once the maximum count is reached.
+     *
+     * @param filePath - The file that produced these violations
+     * @param violations - The violations to add
+     * @returns The current total number of collected violations
+     */
     pushWithFile(filePath, ...violations) {
         if (__classPrivateFieldGet(this, _ViolationCollector_locked, "f")) {
             return __classPrivateFieldGet(this, _ViolationCollector_violations, "f").length;
@@ -31,15 +46,33 @@ export class ViolationCollector {
         }
         return __classPrivateFieldGet(this, _ViolationCollector_violations, "f").length;
     }
+    /**
+     * The total number of collected violations.
+     */
     get length() {
         return __classPrivateFieldGet(this, _ViolationCollector_violations, "f").length;
     }
+    /**
+     * Whether the collector has reached its maximum count and will no longer accept violations.
+     *
+     * @returns `true` if the collector is locked
+     */
     isLocked() {
         return __classPrivateFieldGet(this, _ViolationCollector_locked, "f");
     }
+    /**
+     * Returns a copy of all collected violations as an array.
+     *
+     * @returns An array of violations with their associated file paths
+     */
     toArray() {
         return [...__classPrivateFieldGet(this, _ViolationCollector_violations, "f")];
     }
+    /**
+     * Groups collected violations by their file path.
+     *
+     * @returns A Map from file path to an array of violations for that file
+     */
     groupByFile() {
         const grouped = new Map();
         for (const violation of __classPrivateFieldGet(this, _ViolationCollector_violations, "f")) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "4.13.2",
+	"version": "4.13.3",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -27,20 +27,20 @@
 		"./lib/configs.js": "./lib/configs.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/config-presets": "4.5.13",
-		"@markuplint/html-parser": "4.6.22",
-		"@markuplint/html-spec": "4.16.1",
-		"@markuplint/i18n": "4.7.0",
-		"@markuplint/ml-ast": "4.4.10",
-		"@markuplint/ml-config": "4.8.14",
-		"@markuplint/ml-spec": "4.10.1",
-		"@markuplint/parser-utils": "4.8.10",
-		"@markuplint/selector": "4.7.7",
-		"@markuplint/shared": "4.4.12",
+		"@markuplint/config-presets": "4.5.14",
+		"@markuplint/html-parser": "4.6.23",
+		"@markuplint/html-spec": "4.17.0",
+		"@markuplint/i18n": "4.7.1",
+		"@markuplint/ml-ast": "4.4.11",
+		"@markuplint/ml-config": "4.8.15",
+		"@markuplint/ml-spec": "4.10.2",
+		"@markuplint/parser-utils": "4.8.11",
+		"@markuplint/selector": "4.7.8",
+		"@markuplint/shared": "4.4.13",
 		"@types/debug": "4.1.12",
 		"debug": "4.4.3",
 		"is-plain-object": "5.0.0",
 		"type-fest": "4.41.0"
 	},
-	"gitHead": "6213ea30269ef404f030e67bbcc7fc7443ec1060"
+	"gitHead": "193ee7c1262bbed95424e38efdf1a8e56ff049f4"
 }