@diplodoc/yfmlint 1.3.5 → 1.6.0

package/build/rules/helpers.d.ts

@@ -1,16 +1,54 @@
 import type { MarkdownItToken, RuleOnError, RuleParams } from 'markdownlint';
 import type { TokenWithAttrs } from '../typings';
+export interface IncludeChainEntry {
+    file: string;
+    line: number;
+}
+export interface IncludeSourceInfo {
+    lineNumber: number;
+    sourceFile: string;
+    sourceLineNumber: number;
+    includeChain: IncludeChainEntry[];
+}
 /**
  * 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.
+ *
+ * @param params - Rule parameters from markdownlint
+ * @param rawLineNumber - The raw line number to validate
+ * @returns Object containing validated line number and file path
  */
 export declare function validateLineNumberAndGetFilePath(params: RuleParams, rawLineNumber: number | undefined): {
     lineNumber: number;
     filePath: string;
 };
+/**
+ * Extracts include source metadata from token.meta (set by the includes plugin).
+ * Returns null if the token is not from included content.
+ *
+ * @param params - Rule parameters from markdownlint
+ * @param rawLineNumber - The raw line number from the token
+ * @param token - The token to check for include metadata
+ * @param parentToken - The parent token to check for include metadata
+ * @returns Include source information or null if not from included content
+ */
+export declare function resolveIncludeSource(params: RuleParams, rawLineNumber: number | undefined, token?: MarkdownItToken, parentToken?: MarkdownItToken): IncludeSourceInfo | null;
+/**
+ * Formats include chain as: `main.md:3 → chapter.md:5 → details.md:10 ↛ broken.html`
+ *
+ * @param info - Include source information
+ * @param brokenTarget - The broken target (e.g., href or src)
+ * @returns Formatted include chain string
+ */
+export declare function formatIncludeChain(info: IncludeSourceInfo, brokenTarget: string): string;
 /**
  * Creates error context with optional file path information.
+ *
+ * @param baseContext - The base context string
+ * @param filePath - The file path to include if different from paramsName
+ * @param paramsName - The parameter name (original file path)
+ * @returns Formatted context string
  */
 export declare function createContextWithFileInfo(baseContext: string, filePath: string, paramsName: string): string;
 /**

package/build/rules/index.d.ts

@@ -9,3 +9,4 @@ export { yfm008 } from './yfm008';
 export { yfm009 } from './yfm009';
 export { yfm010 } from './yfm010';
 export { yfm011 } from './yfm011';
+export { yfm018 } from './yfm018';

package/build/rules/yfm018.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'markdownlint';
+export declare const yfm018: Rule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/yfmlint",
-  "version": "1.3.5",
+  "version": "1.6.0",
   "description": "YFM (Yandex Flavored Markdown) syntax linter with custom rules for Diplodoc platform",
   "keywords": [
     "docs",
@@ -45,7 +45,7 @@
     "lint": "lint update && lint",
     "lint:fix": "lint update && lint fix",
     "pre-commit": "lint update && lint-staged",
-    "prepare": "husky"
+    "prepare": "husky || exit 0"
   },
   "devDependencies": {
     "@diplodoc/lint": "^1.13.2",