@diplodoc/yfmlint 1.3.3 → 1.3.5

package/build/rules/helpers.d.ts

@@ -0,0 +1,49 @@
+import type { MarkdownItToken, RuleOnError, RuleParams } from 'markdownlint';
+import type { TokenWithAttrs } from '../typings';
+/**
+ * Validates and adjusts lineNumber to prevent markdownlint exception.
+ * When include files are used, lineNumber might exceed the original file's line count.
+ * Also returns the file path from markdown-it env if available.
+ */
+export declare function validateLineNumberAndGetFilePath(params: RuleParams, rawLineNumber: number | undefined): {
+    lineNumber: number;
+    filePath: string;
+};
+/**
+ * Creates error context with optional file path information.
+ */
+export declare function createContextWithFileInfo(baseContext: string, filePath: string, paramsName: string): string;
+/**
+ * Finds all inline tokens containing links and calls handler for each link.
+ * Used by rules that validate links (YFM002, YFM003, YFM010).
+ *
+ * @param params - Rule parameters from markdownlint
+ * @param ruleName - Name of the rule (e.g., 'YFM002') to check in link attributes
+ * @param onError - Error callback function
+ * @param handler - Optional custom handler for each link token
+ * @returns {void}
+ */
+export declare function findLinksInInlineTokens(params: RuleParams, ruleName: string, onError: RuleOnError, handler?: (link: TokenWithAttrs, inline: MarkdownItToken) => void): void;
+/**
+ * Finds all inline tokens containing images and calls handler for each image.
+ * Used by rules that validate images (YFM011).
+ *
+ * @param params - Rule parameters from markdownlint
+ * @param ruleName - Name of the rule (e.g., 'YFM011') to check in image attributes
+ * @param onError - Error callback function
+ * @param handler - Optional custom handler for each image token
+ * @returns {void}
+ */
+export declare function findImagesInInlineTokens(params: RuleParams, ruleName: string, onError: RuleOnError, handler?: (image: TokenWithAttrs, inline: MarkdownItToken) => void): void;
+/**
+ * Finds all __yfm_lint tokens and calls handler for each.
+ * Used by rules that validate YFM-specific constructs (YFM004-YFM008).
+ * These tokens are created by plugins from @diplodoc/transform when isLintRun = true.
+ *
+ * @param params - Rule parameters from markdownlint
+ * @param ruleName - Name of the rule (e.g., 'YFM004') to check in token attributes
+ * @param onError - Error callback function
+ * @param handler - Optional custom handler for each token
+ * @returns {void}
+ */
+export declare function findYfmLintTokens(params: RuleParams, ruleName: string, onError: RuleOnError, handler?: (token: TokenWithAttrs) => void): void;

package/build/typings.d.ts

@@ -1,5 +1,7 @@
 import type { LintError as BaseLintError, MarkdownItToken } from 'markdownlint';
 import type { LogLevels } from './utils';
+export type { BaseLintError };
+export type MarkdownItPlugin = any;
 export type RawLintConfig = {
     default?: boolean;
 } & {
@@ -16,7 +18,7 @@ export type LintConfig = {
     [x: string]: false | RuleConfig;
 };
 export interface Options {
-    plugins?: Function[];
+    plugins?: MarkdownItPlugin[];
     pluginOptions?: Record<string, unknown>;
     lintConfig?: RawLintConfig;
     frontMatter?: RegExp | null;

package/build/utils.d.ts

@@ -5,6 +5,28 @@ export declare enum LogLevels {
     ERROR = "error",
     DISABLED = "disabled"
 }
+/**
+ * Normalizes and merges multiple lint configurations.
+ *
+ * Accepts various input formats and converts them to a unified LintConfig:
+ * - boolean: true -> {loglevel: 'warn'}, false -> {loglevel: 'disabled'}
+ * - string: log level name -> {loglevel: '...'}
+ * - object: {level: '...', ...} -> {loglevel: '...', ...}
+ *
+ * After merging, simplifies config by converting {loglevel: 'disabled'} to false.
+ *
+ * @param {...RawLintConfig} parts - One or more configuration objects to normalize and merge
+ * @returns {LintConfig} Normalized and merged configuration
+ */
 export declare function normalizeConfig(...parts: RawLintConfig[]): LintConfig;
+/**
+ * Gets log level for a rule based on its names.
+ * Rules can have multiple names (e.g., ['YFM001', 'inline-code-length']).
+ * Returns the log level for the first matching rule name, or default if none found.
+ *
+ * @param {LintConfig} logLevels - Configuration object mapping rule names to log levels
+ * @param {string[]} ruleNames - Array of rule names (e.g., ['YFM001', 'inline-code-length'])
+ * @returns {LogLevels} Log level for the rule, or default if not configured
+ */
 export declare function getLogLevel(logLevels: LintConfig, ruleNames: string[]): LogLevels;
 export declare function log(errors: LintError[], logger: Logger): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@diplodoc/yfmlint",
-  "version": "1.3.3",
-  "description": "A simple transformer of text in YFM (Yandex Flavored Markdown) to HTML",
+  "version": "1.3.5",
+  "description": "YFM (Yandex Flavored Markdown) syntax linter with custom rules for Diplodoc platform",
   "keywords": [
     "docs",
     "yfm",
@@ -40,6 +40,7 @@
     "prepublishOnly": "npm run lint && npm run test && npm run build",
     "test": "vitest --run",
     "test:watch": "vitest",
+    "test:coverage": "vitest --run --coverage",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "lint": "lint update && lint",
     "lint:fix": "lint update && lint fix",
@@ -47,18 +48,19 @@
     "prepare": "husky"
   },
   "devDependencies": {
-    "@diplodoc/lint": "^1.2.1",
+    "@diplodoc/lint": "^1.13.2",
     "@diplodoc/transform": "^4.48.4",
     "@diplodoc/tsconfig": "^1.0.2",
     "@types/lodash": "^4.17.15",
+    "@types/markdown-it": "^13.0.9",
     "@types/markdown-it-attrs": "^4.1.3",
     "@vitest/coverage-v8": "^3.0.8",
-    "esbuild": "^0.19.12",
     "lodash": "^4.17.21",
+    "markdown-it": "^13.0.2",
     "markdown-it-attrs": "^4.3.1",
     "markdownlint": "github:diplodoc-platform/markdownlint#no-parse-micromark",
     "ts-dedent": "^2.2.0",
-    "typescript": "5.2.2",
+    "typescript": "5.9.3",
     "vite": "^6.2.1",
     "vitest": "^3.0.8"
   }