fix IMarkdownSourceCode

fasttime · fasttime · commit c015363ecd64 · 2025-03-15T23:12:00.000+01:00
diff --git a/src/language/markdown-source-code.js b/src/language/markdown-source-code.js
@@ -32,6 +32,7 @@ import { findOffsets } from "../util.js";
 /** @typedef {import("@eslint/core").SourceRange} SourceRange */
 /** @typedef {import("@eslint/core").FileProblem} FileProblem */
 /** @typedef {import("@eslint/core").DirectiveType} DirectiveType */
+/** @typedef {import("../types.ts").IMarkdownSourceCode} IMarkdownSourceCode */
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -135,6 +136,7 @@ function extractInlineConfigCommentsFromHTML(node) {
 
 /**
  * Markdown Source Code Object
+ * @implements {IMarkdownSourceCode}
  */
 export class MarkdownSourceCode extends TextSourceCodeBase {
 	/**
diff --git a/src/types.ts b/src/types.ts
@@ -17,6 +17,7 @@ import type {
 	RuleDefinition,
 	RuleDefinitionTypeOptions,
 	RuleVisitor,
+	SourceLocation,
 	TextSourceCode,
 } from "@eslint/core";
 
@@ -58,23 +59,27 @@ export type RuleType = "problem" | "suggestion" | "layout";
 /**
  * The `SourceCode` interface for Markdown files.
  */
-export interface IMarkdownSourceCode extends TextSourceCode {
+export interface IMarkdownSourceCode
+	extends TextSourceCode<{
+		LangOptions: {};
+		RootNode: Root;
+		SyntaxElementWithLoc: Node;
+		ConfigNode: { value: string; position: SourceLocation };
+	}> {
 	/**
 	 * Gets the entire source text split into an array of lines.
-	 * @returns {Array<string>} The source text as an array of lines.
-	 * @public
+	 * @returns The source text as an array of lines.
 	 */
 	get lines(): Array<string>;
 
 	/**
 	 * Gets the source code for the given node.
-	 * @param {object} [node] The AST node to get the text for.
-	 * @param {number} [beforeCount] The number of characters before the node to retrieve.
-	 * @param {number} [afterCount] The number of characters after the node to retrieve.
-	 * @returns {string} The text representing the AST node.
-	 * @public
+	 * @param node The AST node to get the text for.
+	 * @param beforeCount The number of characters before the node to retrieve.
+	 * @param afterCount The number of characters after the node to retrieve.
+	 * @returns The text representing the AST node.
 	 */
-	getText(node?: object, beforeCount?: number, afterCount?: number): string;
+	getText(node?: Node, beforeCount?: number, afterCount?: number): string;
 }
 
 export interface MarkdownRuleVisitor
diff --git a/tests/types/types.test.ts b/tests/types/types.test.ts
@@ -1,8 +1,10 @@
 import markdown, {
+	IMarkdownSourceCode,
 	MarkdownNode,
 	MarkdownRuleVisitor,
 	ParentNode,
 	RootNode,
+	SourceLocation,
 	TextNode,
 	type RuleModule,
 } from "@eslint/markdown";
@@ -45,16 +47,22 @@ typeof processorPlugins satisfies {};
 
 const rule: RuleModule = {
 	create({ sourceCode }): MarkdownRuleVisitor {
+		sourceCode satisfies IMarkdownSourceCode;
+
+		sourceCode.ast satisfies RootNode;
+		sourceCode.lines satisfies string[];
+
 		return {
 			// Root selector
 			root(node) {
 				node satisfies RootNode;
 			},
 
-			// Known node selector, sourceCode.getText() used in visitor
+			// Known node selector, sourceCode methods used in visitor
 			text(node) {
 				node satisfies TextNode;
-				sourceCode.getText(node);
+				sourceCode.getText(node) satisfies string;
+				sourceCode.getLoc(node) satisfies SourceLocation;
 			},
 
 			// Known node selector with parent
