@diplodoc/yfmlint 1.6.0 → 1.7.0

package/build/rules/directives.d.ts

@@ -0,0 +1,17 @@
+export declare const NOTE_OPEN_RE: RegExp;
+export declare const NOTE_CLOSE_RE: RegExp;
+export declare const NOTE_STRICT_RE: RegExp;
+export declare const CUT_OPEN_RE: RegExp;
+export declare const CUT_CLOSE_RE: RegExp;
+export declare const CUT_STRICT_RE: RegExp;
+export declare const TABS_OPEN_RE: RegExp;
+export declare const TABS_CLOSE_RE: RegExp;
+export declare const TABS_STRICT_RE: RegExp;
+export declare const INCLUDE_STRICT_RE: RegExp;
+export declare const CHANGELOG_OPEN_RE: RegExp;
+export declare const CHANGELOG_CLOSE_RE: RegExp;
+export declare const IF_OPEN_RE: RegExp;
+export declare const IF_CLOSE_RE: RegExp;
+export declare const FOR_OPEN_RE: RegExp;
+export declare const FOR_CLOSE_RE: RegExp;
+export declare function isKnownDirective(directive: string): boolean;

package/build/rules/helpers.d.ts

@@ -10,6 +10,15 @@ export interface IncludeSourceInfo {
     sourceLineNumber: number;
     includeChain: IncludeChainEntry[];
 }
+export interface DirectiveMatch {
+    directive: string;
+    lineNumber: number;
+    line: string;
+}
+export interface PairedDirectiveSpec {
+    open: RegExp;
+    close: RegExp;
+}
 /**
  * Validates and adjusts lineNumber to prevent markdownlint exception.
  * When include files are used, lineNumber might exceed the original file's line count.
@@ -85,3 +94,66 @@ export declare function findImagesInInlineTokens(params: RuleParams, ruleName: s
  * @returns {void}
  */
 export declare function findYfmLintTokens(params: RuleParams, ruleName: string, onError: RuleOnError, handler?: (token: TokenWithAttrs) => void): void;
+/**
+ * Returns a set of 1-based line numbers that should be skipped during directive scanning.
+ * Lines inside fenced code blocks (```` ``` ```) and indented code blocks are excluded
+ * to prevent false positives on code examples that contain YFM syntax.
+ *
+ * @param params - Rule parameters from markdownlint
+ * @returns Set of line numbers (1-based) that belong to code blocks
+ */
+export declare function getIgnoredLineNumbers(params: RuleParams): Set<number>;
+/**
+ * Replaces inline code spans (backtick-delimited) with spaces of the same length.
+ * Preserves character positions so that match offsets remain accurate.
+ * Handles single and multi-backtick spans (e.g., `` `code` `` and ` ``code`` `).
+ *
+ * @param line - A single line of markdown text
+ * @returns The line with all inline code spans replaced by spaces
+ */
+export declare function stripInlineCode(line: string): string;
+/**
+ * Finds all YFM/Liquid directive matches (`{% ... %}`) in the document lines,
+ * skipping lines inside code blocks and inline code spans.
+ *
+ * @param params - Rule parameters from markdownlint
+ * @returns Array of directive matches with their directive content, line number, and original line text
+ */
+export declare function findDirectiveMatches(params: RuleParams): DirectiveMatch[];
+/**
+ * Validates that opening and closing directives are properly paired using a stack.
+ * Reports two types of issues:
+ * - Unexpected closing directive (closing without a matching opening)
+ * - Unclosed opening directive (opening without a matching closing)
+ *
+ * @param params - Rule parameters from markdownlint
+ * @param spec - Pair specification with `open` and `close` regexes tested against the directive content
+ * @returns Array of issues, each with a line number, context (original line), and detail message
+ */
+export declare function findPairedDirectiveIssues(params: RuleParams, spec: PairedDirectiveSpec): Array<{
+    lineNumber: number;
+    context: string;
+    detail: string;
+}>;
+/**
+ * Detects interleaved (improperly nested) directives using a unified stack across all specs.
+ *
+ * Example of interleaved directives:
+ *   {% note info %}
+ *   {% list tabs %}
+ *   {% endnote %}      ← closes note, but tabs is still open inside
+ *   {% endlist %}
+ *
+ * Per-spec stacks cannot detect this because each spec closes cleanly in isolation.
+ * This function uses a single stack for all directive types and reports when a closing
+ * directive skips over unclosed directives of a different type.
+ *
+ * @param params - Rule parameters from markdownlint
+ * @param specs - Array of paired directive specifications
+ * @returns Array of issues with line number, context, and detail message
+ */
+export declare function findInterleavedDirectiveIssues(params: RuleParams, specs: PairedDirectiveSpec[]): Array<{
+    lineNumber: number;
+    context: string;
+    detail: string;
+}>;

package/build/rules/index.d.ts

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

package/build/rules/yfm020.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diplodoc/yfmlint",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "YFM (Yandex Flavored Markdown) syntax linter with custom rules for Diplodoc platform",
   "keywords": [
     "docs",