markuplint 4.14.0 → 4.18.0

package/lib/reporter/standard-reporter.d.ts

@@ -1,3 +1,15 @@
 import type { CLIOptions } from '../cli/bootstrap.js';
 import type { MLResultInfo } from '../types.js';
+/**
+ * Formats lint results using the standard (detailed) reporter.
+ *
+ * Produces multi-line output that shows each violation's message with
+ * surrounding source code context, highlighted error regions, and
+ * line numbers. Clean files are reported as "passed" or "skipped"
+ * unless `--problem-only` is set.
+ *
+ * @param results - The lint result information for a single file.
+ * @param options - CLI options controlling color and problem-only output.
+ * @returns An array of formatted output lines.
+ */
 export declare function standardReporter(results: MLResultInfo, options: CLIOptions): string[];

package/lib/reporter/standard-reporter.js

@@ -2,6 +2,18 @@ import { messageToString, font, name, invisibleSpace, space, pad, getWidth, xter
 const commandName = name.toLowerCase();
 const loggerError = font.red;
 const loggerWarning = xterm(208);
+/**
+ * Formats lint results using the standard (detailed) reporter.
+ *
+ * Produces multi-line output that shows each violation's message with
+ * surrounding source code context, highlighted error regions, and
+ * line numbers. Clean files are reported as "passed" or "skipped"
+ * unless `--problem-only` is set.
+ *
+ * @param results - The lint result information for a single file.
+ * @param options - CLI options controlling color and problem-only output.
+ * @returns An array of formatted output lines.
+ */
 export function standardReporter(results, options) {
     const sizes = {
         line: 0,

package/lib/testing-tool/index.d.ts

@@ -1,10 +1,32 @@
 import type { Target } from '@markuplint/file-resolver';
 import type { Config, RuleConfigValue, Rule, RegexSelector, PlainData } from '@markuplint/ml-config';
 import type { AnyMLRule, RuleSeed } from '@markuplint/ml-core';
+/**
+ * Lints inline source code with a given configuration. Convenience function for testing.
+ *
+ * @param sourceCode - The markup source code to lint
+ * @param config - The markuplint configuration to apply
+ * @param rules - Optional custom rules; if omitted, preset rules are imported
+ * @param locale - The locale for error messages (defaults to `'en'`)
+ * @param fix - Whether to attempt auto-fixing
+ * @returns An object containing violations and the fixed code
+ */
 export declare function mlTest(sourceCode: string, config: Config, rules?: readonly Readonly<AnyMLRule>[], locale?: string, fix?: boolean): Promise<{
     violations: readonly import("@markuplint/ml-config").Violation[];
     fixedCode: string;
 }>;
+/**
+ * Tests a single rule against inline source code. Designed for rule unit testing.
+ *
+ * @template T - The rule's configuration value type
+ * @template O - The rule's options type
+ * @param rule - The rule seed to test
+ * @param sourceCode - The markup source code to lint
+ * @param config - Configuration with rule settings, nodeRule, and childNodeRule
+ * @param fix - Whether to attempt auto-fixing
+ * @param locale - The locale for error messages (defaults to `'en'`)
+ * @returns An object containing violations (without ruleId) and the fixed code
+ */
 export declare function mlRuleTest<T extends RuleConfigValue, O extends PlainData>(rule: Readonly<RuleSeed<T, O>>, sourceCode: string, config?: Omit<Config, 'rules' | 'nodeRules' | 'childNodeRules'> & {
     rule?: Rule<T, Partial<O>>;
     nodeRule?: NodeRule<T, Partial<O>>[];
@@ -13,10 +35,26 @@ export declare function mlRuleTest<T extends RuleConfigValue, O extends PlainDat
     violations: readonly import("@markuplint/ml-config").Violation[];
     fixedCode: string;
 }>;
+/**
+ * Lints a file target with a given configuration. Convenience function for integration testing.
+ *
+ * @param target - A file path or inline source code target
+ * @param config - The markuplint configuration to apply
+ * @param rules - Optional custom rules; if omitted, preset rules are imported
+ * @param locale - The locale for error messages
+ * @param fix - Whether to attempt auto-fixing
+ * @returns An object containing violations and the fixed code
+ */
 export declare function mlTestFile(target: Target, config?: Config, rules?: readonly Readonly<AnyMLRule>[], locale?: string, fix?: boolean): Promise<{
     violations: readonly import("@markuplint/ml-config").Violation[];
     fixedCode: string | undefined;
 }>;
+/**
+ * A node-level rule override configuration for testing, targeting elements by selector.
+ *
+ * @template T - The rule's configuration value type
+ * @template O - The rule's options type
+ */
 export interface NodeRule<T extends RuleConfigValue, O extends PlainData = undefined> {
     selector?: string;
     regexSelector?: RegexSelector;
@@ -25,6 +63,12 @@ export interface NodeRule<T extends RuleConfigValue, O extends PlainData = undef
     obsolete?: boolean;
     rule?: Rule<T, O>;
 }
+/**
+ * A child-node-level rule override configuration for testing, targeting child elements by selector.
+ *
+ * @template T - The rule's configuration value type
+ * @template O - The rule's options type
+ */
 export interface ChildNodeRule<T extends RuleConfigValue, O extends PlainData = undefined> {
     selector?: string;
     regexSelector?: RegexSelector;

package/lib/testing-tool/index.js

@@ -1,6 +1,16 @@
 import { MLRule } from '@markuplint/ml-core';
 import { lint } from '../api/index.js';
 import { getGlobal } from '../global-settings.js';
+/**
+ * Lints inline source code with a given configuration. Convenience function for testing.
+ *
+ * @param sourceCode - The markup source code to lint
+ * @param config - The markuplint configuration to apply
+ * @param rules - Optional custom rules; if omitted, preset rules are imported
+ * @param locale - The locale for error messages (defaults to `'en'`)
+ * @param fix - Whether to attempt auto-fixing
+ * @returns An object containing violations and the fixed code
+ */
 export async function mlTest(sourceCode, config, rules, locale = 'en', fix = false) {
     const global = getGlobal();
     const results = await lint([{ sourceCode }], {
@@ -18,6 +28,18 @@ export async function mlTest(sourceCode, config, rules, locale = 'en', fix = fal
         fixedCode: result?.fixedCode ?? sourceCode,
     };
 }
+/**
+ * Tests a single rule against inline source code. Designed for rule unit testing.
+ *
+ * @template T - The rule's configuration value type
+ * @template O - The rule's options type
+ * @param rule - The rule seed to test
+ * @param sourceCode - The markup source code to lint
+ * @param config - Configuration with rule settings, nodeRule, and childNodeRule
+ * @param fix - Whether to attempt auto-fixing
+ * @param locale - The locale for error messages (defaults to `'en'`)
+ * @returns An object containing violations (without ruleId) and the fixed code
+ */
 export async function mlRuleTest(rule, sourceCode, 
 // eslint-disable-next-line unicorn/no-object-as-default-parameter
 config = { rule: true }, fix = false, locale = 'en') {
@@ -68,6 +90,16 @@ config = { rule: true }, fix = false, locale = 'en') {
     });
     return res;
 }
+/**
+ * Lints a file target with a given configuration. Convenience function for integration testing.
+ *
+ * @param target - A file path or inline source code target
+ * @param config - The markuplint configuration to apply
+ * @param rules - Optional custom rules; if omitted, preset rules are imported
+ * @param locale - The locale for error messages
+ * @param fix - Whether to attempt auto-fixing
+ * @returns An object containing violations and the fixed code
+ */
 export async function mlTestFile(target, config, rules, locale, fix = false) {
     const global = getGlobal();
     const results = await lint([target], {

package/lib/types.d.ts

@@ -1,5 +1,8 @@
 import type { Config, PlainData, RuleConfigValue, Violation } from '@markuplint/ml-config';
 import type { Document, Ruleset } from '@markuplint/ml-core';
+/**
+ * The result of linting a single file, including violations, source code, and fix results.
+ */
 export interface MLResultInfo {
     readonly violations: readonly Violation[];
     readonly filePath: string;

package/lib/v1.d.ts

@@ -1,4 +1,6 @@
 /**
- * @deprecated
+ * Legacy v1 entry point re-exporting the deprecated `exec` function.
+ *
+ * @deprecated Use `lint` or `MLEngine` from the current API instead.
  */
 export { lint_v1 as exec } from './api/v1.js';

package/lib/v1.js

@@ -1,4 +1,6 @@
 /**
- * @deprecated
+ * Legacy v1 entry point re-exporting the deprecated `exec` function.
+ *
+ * @deprecated Use `lint` or `MLEngine` from the current API instead.
  */
 export { lint_v1 as exec } from './api/v1.js';

package/lib/version.d.ts

@@ -1 +1,4 @@
+/**
+ * The current version string of the markuplint package, read from `package.json`.
+ */
 export declare const version: string;

package/lib/version.js

@@ -2,4 +2,7 @@ import { createRequire } from 'node:module';
 const require = createRequire(import.meta.url);
 // TODO: Use import attribute in Node.js v22 and v20.10 or later
 const pkg = require('../package.json');
+/**
+ * The current version string of the markuplint package, read from `package.json`.
+ */
 export const version = pkg.version;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "markuplint",
-	"version": "4.14.0",
+	"version": "4.18.0",
 	"description": "An HTML linter for all markup developers",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
@@ -23,25 +23,25 @@
 		"clean": "tsc --build --clean tsconfig.build.json"
 	},
 	"dependencies": {
-		"@markuplint/cli-utils": "4.4.13",
-		"@markuplint/file-resolver": "4.9.17",
-		"@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-core": "4.13.2",
-		"@markuplint/ml-spec": "4.10.1",
-		"@markuplint/rules": "4.11.2",
-		"@markuplint/shared": "4.4.12",
-		"@types/debug": "4.1.12",
-		"chokidar": "4.0.3",
+		"@markuplint/cli-utils": "4.18.0",
+		"@markuplint/file-resolver": "4.18.0",
+		"@markuplint/html-parser": "4.18.0",
+		"@markuplint/html-spec": "4.18.0",
+		"@markuplint/i18n": "4.18.0",
+		"@markuplint/ml-ast": "4.18.0",
+		"@markuplint/ml-config": "4.18.0",
+		"@markuplint/ml-core": "4.18.0",
+		"@markuplint/ml-spec": "4.18.0",
+		"@markuplint/rules": "4.18.0",
+		"@markuplint/shared": "4.18.0",
+		"@types/debug": "4.1.13",
+		"chokidar": "5.0.0",
 		"debug": "4.4.3",
 		"meow": "13.2.0",
 		"os-locale": "6.0.2",
 		"strict-event-emitter": "0.5.1",
-		"strip-ansi": "7.1.2",
-		"type-fest": "4.41.0"
+		"strip-ansi": "7.2.0",
+		"type-fest": "5.6.0"
 	},
-	"gitHead": "6213ea30269ef404f030e67bbcc7fc7443ec1060"
+	"gitHead": "1885af6349def3f19df975b9e9c399dd47361de1"
 }