fix: replace IMarkdownSourceCode with MarkdownSourceCode (#336)

* fix: update type reference for `MarkdownRuleDefinition`

* wip: fix CI failure

* wip: fix CI issues

* wip: remove `IMarkdownSourceCode` interface and replace it with `MarkdownSourceCode`

* wip: export `TextSourceCode`

* wip: replace `MarkdownTextSourceCodeOptions` with `SourceCodeBaseTypeOptions`

* wip: add types to generic

Author: lumirlumir

package.json

@@ -76,6 +76,7 @@
     "prettier": "^3.3.3",
     "rollup": "^4.19.0",
     "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-delete": "^3.0.1",
     "typescript": "^5.5.4",
     "yorkie": "^2.0.0"
   },

rollup.config.js

@@ -1,4 +1,5 @@
 import copy from "rollup-plugin-copy";
+import del from "rollup-plugin-delete";
 
 export default {
 	input: "src/index.js",
@@ -10,6 +11,7 @@ export default {
 		},
 	],
 	plugins: [
+		del({ targets: "dist/*" }),
 		copy({
 			targets: [{ src: "src/types.ts", dest: "dist/esm" }],
 		}),

src/index.js

@@ -9,6 +9,7 @@
 
 import { processor } from "./processor.js";
 import { MarkdownLanguage } from "./language/markdown-language.js";
+import { MarkdownSourceCode } from "./language/markdown-source-code.js";
 import recommendedRules from "./build/recommended-config.js";
 import rules from "./build/rules.js";
 
@@ -139,3 +140,4 @@ const plugin = {
 recommendedPlugins.markdown = processorPlugins.markdown = plugin;
 
 export default plugin;
+export { MarkdownSourceCode };

src/language/markdown-source-code.js

@@ -26,14 +26,18 @@ import { findOffsets } from "../util.js";
 /** @typedef {import("@eslint/core").File} File */
 /** @typedef {import("@eslint/core").TraversalStep} TraversalStep */
 /** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
-/** @typedef {import("@eslint/core").TextSourceCode} TextSourceCode */
 /** @typedef {import("@eslint/core").ParseResult<RootNode>} ParseResult */
 /** @typedef {import("@eslint/core").SourceLocation} SourceLocation */
 /** @typedef {import("@eslint/core").SourceRange} SourceRange */
 /** @typedef {import("@eslint/core").FileProblem} FileProblem */
 /** @typedef {import("@eslint/core").DirectiveType} DirectiveType */
 /** @typedef {import("@eslint/core").RulesConfig} RulesConfig */
-/** @typedef {import("../types.ts").IMarkdownSourceCode} IMarkdownSourceCode */
+/**
+ * @typedef {import("@eslint/core").TextSourceCode<Options>} TextSourceCode<Options>
+ * @template {SourceCodeBaseTypeOptions} [Options=SourceCodeBaseTypeOptions]
+ */
+/** @typedef {import("../types.ts").MarkdownLanguageOptions} MarkdownLanguageOptions */
+/** @typedef {import("../types.ts").SourceCodeBaseTypeOptions} SourceCodeBaseTypeOptions */
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -137,7 +141,7 @@ function extractInlineConfigCommentsFromHTML(node) {
 
 /**
  * Markdown Source Code Object
- * @implements {IMarkdownSourceCode}
+ * @implements {TextSourceCode<{LangOptions: MarkdownLanguageOptions, RootNode: RootNode, SyntaxElementWithLoc: MarkdownNode, ConfigNode: { value: string; position: SourceLocation }}>}
  */
 export class MarkdownSourceCode extends TextSourceCodeBase {
 	/**

src/types.ts

@@ -21,6 +21,7 @@ import type {
 	SourceLocation,
 	TextSourceCode,
 } from "@eslint/core";
+import type { MarkdownSourceCode } from "./index.js";
 
 //------------------------------------------------------------------------------
 // Helpers
@@ -73,29 +74,13 @@ export interface MarkdownLanguageOptions extends LanguageOptions {
 export type MarkdownLanguageContext = LanguageContext<MarkdownLanguageOptions>;
 
 /**
- * The `SourceCode` interface for Markdown files.
+ * Generic options for the `SourceCodeBase` type.
  */
-export interface IMarkdownSourceCode
-	extends TextSourceCode<{
-		LangOptions: MarkdownLanguageOptions;
-		RootNode: Root;
-		SyntaxElementWithLoc: Node;
-		ConfigNode: { value: string; position: SourceLocation };
-	}> {
-	/**
-	 * Gets the entire source text split into an array of lines.
-	 * @returns The source text as an array of lines.
-	 */
-	get lines(): Array<string>;
-
-	/**
-	 * Gets the source code for the given node.
-	 * @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?: Node, beforeCount?: number, afterCount?: number): string;
+export interface SourceCodeBaseTypeOptions {
+	LangOptions: LanguageOptions;
+	RootNode: unknown;
+	SyntaxElementWithLoc: unknown;
+	ConfigNode: unknown;
 }
 
 export interface MarkdownRuleVisitor
@@ -121,7 +106,7 @@ export type MarkdownRuleDefinition<
 	// Language specific type options (non-configurable)
 	{
 		LangOptions: MarkdownLanguageOptions;
-		Code: IMarkdownSourceCode;
+		Code: MarkdownSourceCode;
 		Visitor: MarkdownRuleVisitor;
 		Node: Node;
 	} & Required<

tests/types/types.test.ts

@@ -1,5 +1,5 @@
 import markdown, {
-	IMarkdownSourceCode,
+	MarkdownSourceCode,
 	MarkdownNode,
 	MarkdownRuleDefinition,
 	MarkdownRuleVisitor,
@@ -48,7 +48,7 @@ typeof processorPlugins satisfies {};
 
 (): RuleModule => ({
 	create({ sourceCode }): MarkdownRuleVisitor {
-		sourceCode satisfies IMarkdownSourceCode;
+		sourceCode satisfies MarkdownSourceCode;
 
 		sourceCode.ast satisfies RootNode;
 		sourceCode.lines satisfies string[];