@dougis/markdown-lint-mcp 1.0.0

package/dist/rules/md056.d.ts

@@ -0,0 +1,21 @@
+import { Rule } from './rule-interface';
+/**
+ * MD056: Table column count
+ *
+ * This rule ensures that all rows in a Markdown table have the same number
+ * of columns. Tables with inconsistent column counts can render unpredictably.
+ */
+export declare const name = "MD056";
+export declare const description = "Table column count";
+/**
+ * Fix tables to ensure all rows have the same number of columns
+ * @param lines Array of string lines to fix
+ * @returns Fixed lines array with consistent table column counts
+ */
+export declare function fix(lines: string[]): string[];
+/**
+ * Rule implementation for MD056
+ */
+export declare const rule: Rule;
+export default rule;
+//# sourceMappingURL=md056.d.ts.map

package/dist/rules/md056.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"md056.d.ts","sourceRoot":"","sources":["../../src/rules/md056.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC;;;;;GAKG;AACH,eAAO,MAAM,IAAI,UAAU,CAAC;AAC5B,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAqDhD;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAqC7C;AA0DD;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,IAIlB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/md056.js

@@ -0,0 +1,154 @@
+/**
+ * MD056: Table column count
+ *
+ * This rule ensures that all rows in a Markdown table have the same number
+ * of columns. Tables with inconsistent column counts can render unpredictably.
+ */
+export const name = 'MD056';
+export const description = 'Table column count';
+/**
+ * Check if a line appears to be part of a table
+ * @param line The line to check
+ * @returns True if the line is part of a table
+ */
+function isTableLine(line) {
+    // Tables typically have pipe characters
+    return line.trim().includes('|');
+}
+/**
+ * Check if a line is a table separator row (contains only -, |, and :)
+ * @param line The line to check
+ * @returns True if the line is a table separator row
+ */
+function isTableSeparator(line) {
+    return /^\s*\|?(\s*:?-+:?\s*\|)+\s*:?-+:?\s*\|?\s*$/.test(line);
+}
+/**
+ * Count the number of columns in a table row
+ * @param line The table row line
+ * @returns The number of columns
+ */
+function countTableColumns(line) {
+    // Remove escaped pipe characters (they don't count as column separators)
+    const lineWithoutEscapedPipes = line.replace(/\\\|/g, '');
+    // Count columns by counting pipe characters
+    const trimmed = lineWithoutEscapedPipes.trim();
+    let pipeCount = 0;
+    for (let i = 0; i < trimmed.length; i++) {
+        if (trimmed[i] === '|') {
+            pipeCount++;
+        }
+    }
+    // If the line starts and ends with pipes, we have (pipeCount - 1) columns
+    // Otherwise, we have pipeCount + 1 columns (when line doesn't have surrounding pipes)
+    if (trimmed.startsWith('|') && trimmed.endsWith('|')) {
+        return Math.max(0, pipeCount - 1);
+    }
+    else if (trimmed.startsWith('|')) {
+        return pipeCount;
+    }
+    else if (trimmed.endsWith('|')) {
+        return pipeCount;
+    }
+    else {
+        return pipeCount + 1;
+    }
+}
+/**
+ * Fix tables to ensure all rows have the same number of columns
+ * @param lines Array of string lines to fix
+ * @returns Fixed lines array with consistent table column counts
+ */
+export function fix(lines) {
+    if (lines.length === 0)
+        return lines;
+    const result = [...lines];
+    let inTable = false;
+    let columnCount = -1;
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        // Check if this line is part of a table
+        if (isTableLine(line)) {
+            // If we're not already in a table, this is the start of a new table
+            if (!inTable) {
+                inTable = true;
+                columnCount = countTableColumns(line);
+            }
+            // Check column count against the first row's count
+            const lineColumnCount = countTableColumns(line);
+            // Skip fixing separator lines, they should be adjusted based on content rows
+            if (!isTableSeparator(line) && lineColumnCount !== columnCount) {
+                // We need to fix this row to match the column count
+                const fixedLine = fixTableRow(line, columnCount);
+                result[i] = fixedLine;
+            }
+        }
+        else {
+            // If we were in a table and now we're not, reset table tracking
+            if (inTable) {
+                inTable = false;
+                columnCount = -1;
+            }
+        }
+    }
+    return result;
+}
+/**
+ * Fix a table row to have the specified number of columns
+ * @param line The table row to fix
+ * @param targetColumnCount The target number of columns
+ * @returns A fixed table row with the correct number of columns
+ */
+function fixTableRow(line, targetColumnCount) {
+    const trimmed = line.trim();
+    const indentation = line.slice(0, line.indexOf(trimmed));
+    // Split by pipe characters
+    const parts = trimmed.split('|');
+    // Handle surrounding pipes
+    const startWithPipe = trimmed.startsWith('|');
+    const endWithPipe = trimmed.endsWith('|');
+    // Extract actual cell contents
+    let cells = [];
+    if (startWithPipe && endWithPipe) {
+        // Remove empty first and last parts that result from surrounding pipes
+        cells = parts.slice(1, -1);
+    }
+    else if (startWithPipe) {
+        cells = parts.slice(1);
+    }
+    else if (endWithPipe) {
+        cells = parts.slice(0, -1);
+    }
+    else {
+        cells = parts;
+    }
+    // If we have too few columns, add empty cells
+    while (cells.length < targetColumnCount) {
+        cells.push('   ');
+    }
+    // If we have too many columns, remove excess cells
+    if (cells.length > targetColumnCount) {
+        cells = cells.slice(0, targetColumnCount);
+    }
+    // Reconstruct the line
+    let fixedLine = cells.join('|');
+    // Add surrounding pipes if the original line had them
+    if (startWithPipe) {
+        fixedLine = '|' + fixedLine;
+    }
+    if (endWithPipe || startWithPipe) {
+        // If the line starts with a pipe, it should also end with a pipe for proper table formatting
+        fixedLine = fixedLine + '|';
+    }
+    return indentation + fixedLine;
+}
+/**
+ * Rule implementation for MD056
+ */
+export const rule = {
+    name,
+    description,
+    fix,
+};
+export default rule;
+//# sourceMappingURL=md056.js.map

package/dist/rules/md056.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"md056.js","sourceRoot":"","sources":["../../src/rules/md056.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC;AAC5B,MAAM,CAAC,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAEhD;;;;GAIG;AACH,SAAS,WAAW,CAAC,IAAY;IAC/B,wCAAwC;IACxC,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,IAAY;IACpC,OAAO,6CAA6C,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,IAAY;IACrC,yEAAyE;IACzE,MAAM,uBAAuB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAE1D,4CAA4C;IAC5C,MAAM,OAAO,GAAG,uBAAuB,CAAC,IAAI,EAAE,CAAC;IAC/C,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACvB,SAAS,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAED,0EAA0E;IAC1E,sFAAsF;IACtF,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;IACpC,CAAC;SAAM,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,OAAO,SAAS,CAAC;IACnB,CAAC;SAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,KAAe;IACjC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAErC,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,WAAW,GAAG,CAAC,CAAC,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtB,wCAAwC;QACxC,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,oEAAoE;YACpE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,GAAG,IAAI,CAAC;gBACf,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACxC,CAAC;YAED,mDAAmD;YACnD,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAEhD,6EAA6E;YAC7E,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,eAAe,KAAK,WAAW,EAAE,CAAC;gBAC/D,oDAAoD;gBACpD,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;gBACjD,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;YACxB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,gEAAgE;YAChE,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,GAAG,KAAK,CAAC;gBAChB,WAAW,GAAG,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,IAAY,EAAE,iBAAyB;IAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzD,2BAA2B;IAC3B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEjC,2BAA2B;IAC3B,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAE1C,+BAA+B;IAC/B,IAAI,KAAK,GAAa,EAAE,CAAC;IAEzB,IAAI,aAAa,IAAI,WAAW,EAAE,CAAC;QACjC,uEAAuE;QACvE,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;SAAM,IAAI,aAAa,EAAE,CAAC;QACzB,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;SAAM,IAAI,WAAW,EAAE,CAAC;QACvB,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,KAAK,GAAG,KAAK,CAAC;IAChB,CAAC;IAED,8CAA8C;IAC9C,OAAO,KAAK,CAAC,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACxC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,mDAAmD;IACnD,IAAI,KAAK,CAAC,MAAM,GAAG,iBAAiB,EAAE,CAAC;QACrC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAC5C,CAAC;IAED,uBAAuB;IACvB,IAAI,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEhC,sDAAsD;IACtD,IAAI,aAAa,EAAE,CAAC;QAClB,SAAS,GAAG,GAAG,GAAG,SAAS,CAAC;IAC9B,CAAC;IACD,IAAI,WAAW,IAAI,aAAa,EAAE,CAAC;QACjC,6FAA6F;QAC7F,SAAS,GAAG,SAAS,GAAG,GAAG,CAAC;IAC9B,CAAC;IAED,OAAO,WAAW,GAAG,SAAS,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI;IACJ,WAAW;IACX,GAAG;CACJ,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/md058.d.ts

@@ -0,0 +1,27 @@
+import { Rule } from './rule-interface';
+/**
+ * MD058: Tables should be surrounded by blank lines
+ *
+ * This rule is triggered when tables are not preceded or followed by a blank line.
+ * Surrounding tables with blank lines improves readability by visually separating
+ * them from other content.
+ */
+export declare const name = "MD058";
+export declare const description = "Tables should be surrounded by blank lines";
+/**
+ * Checks if a line is a table divider row (contains only |, -, :, and spaces)
+ * @param line The line to check
+ * @returns True if the line is a table divider
+ */
+/**
+ * Fix tables by ensuring they have blank lines before and after
+ * @param lines Array of string lines to fix
+ * @returns Fixed lines array with blank lines added around tables
+ */
+export declare function fix(lines: string[]): string[];
+/**
+ * Rule implementation for MD058
+ */
+export declare const rule: Rule;
+export default rule;
+//# sourceMappingURL=md058.d.ts.map

package/dist/rules/md058.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"md058.d.ts","sourceRoot":"","sources":["../../src/rules/md058.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,UAAU,CAAC;AAC5B,eAAO,MAAM,WAAW,+CAA+C,CAAC;AAaxE;;;;GAIG;AACH;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAsC7C;AAED;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,IAIlB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/md058.js

@@ -0,0 +1,71 @@
+/**
+ * MD058: Tables should be surrounded by blank lines
+ *
+ * This rule is triggered when tables are not preceded or followed by a blank line.
+ * Surrounding tables with blank lines improves readability by visually separating
+ * them from other content.
+ */
+export const name = 'MD058';
+export const description = 'Tables should be surrounded by blank lines';
+/**
+ * Checks if a line appears to be part of a table
+ * Tables in markdown typically start with | or have a line with |---|---| pattern
+ * @param line The line to check
+ * @returns True if the line appears to be part of a table
+ */
+function isTableLine(line) {
+    // Table lines either start with | or have | inside them with spaces/dashes in between
+    return line.trim().startsWith('|') || /^\s*\|.*\|/.test(line);
+}
+/**
+ * Checks if a line is a table divider row (contains only |, -, :, and spaces)
+ * @param line The line to check
+ * @returns True if the line is a table divider
+ */
+/**
+ * Fix tables by ensuring they have blank lines before and after
+ * @param lines Array of string lines to fix
+ * @returns Fixed lines array with blank lines added around tables
+ */
+export function fix(lines) {
+    if (lines.length === 0)
+        return lines;
+    const result = [];
+    let inTable = false;
+    let tableStartIndex = -1;
+    // Process each line to identify table boundaries
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        // Check for table start
+        if (!inTable && isTableLine(line)) {
+            inTable = true;
+            tableStartIndex = result.length;
+            // Add a blank line before the table if needed
+            if (tableStartIndex > 0 && result[tableStartIndex - 1].trim() !== '') {
+                result.splice(tableStartIndex, 0, '');
+                tableStartIndex++;
+            }
+        }
+        // Add the current line
+        result.push(line);
+        // Check for table end
+        if (inTable && (i === lines.length - 1 || !isTableLine(lines[i + 1]))) {
+            inTable = false;
+            // Add a blank line after the table if needed
+            if (i < lines.length - 1 && lines[i + 1].trim() !== '') {
+                result.push('');
+            }
+        }
+    }
+    return result;
+}
+/**
+ * Rule implementation for MD058
+ */
+export const rule = {
+    name,
+    description,
+    fix,
+};
+export default rule;
+//# sourceMappingURL=md058.js.map

package/dist/rules/md058.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"md058.js","sourceRoot":"","sources":["../../src/rules/md058.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC;AAC5B,MAAM,CAAC,MAAM,WAAW,GAAG,4CAA4C,CAAC;AAExE;;;;;GAKG;AACH,SAAS,WAAW,CAAC,IAAY;IAC/B,sFAAsF;IACtF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,KAAe;IACjC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAErC,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,eAAe,GAAG,CAAC,CAAC,CAAC;IAEzB,iDAAiD;IACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtB,wBAAwB;QACxB,IAAI,CAAC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,GAAG,IAAI,CAAC;YACf,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;YAEhC,8CAA8C;YAC9C,IAAI,eAAe,GAAG,CAAC,IAAI,MAAM,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACrE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBACtC,eAAe,EAAE,CAAC;YACpB,CAAC;QACH,CAAC;QAED,uBAAuB;QACvB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAElB,sBAAsB;QACtB,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACtE,OAAO,GAAG,KAAK,CAAC;YAEhB,6CAA6C;YAC7C,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBACvD,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI;IACJ,WAAW;IACX,GAAG;CACJ,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/md059.d.ts

@@ -0,0 +1,22 @@
+import { Rule } from './rule-interface';
+/**
+ * MD059: Link text should be descriptive
+ *
+ * This rule is triggered when link text is non-descriptive, such as "click here",
+ * "more", "link", etc. These generic terms don't provide context about where the
+ * link will take the user, which is important for accessibility.
+ */
+export declare const name = "MD059";
+export declare const description = "Link text should be descriptive";
+/**
+ * Fix non-descriptive link text in Markdown files
+ * @param lines Array of string lines to fix
+ * @returns Fixed lines array with more descriptive link text
+ */
+export declare function fix(lines: string[]): string[];
+/**
+ * Rule implementation for MD059
+ */
+export declare const rule: Rule;
+export default rule;
+//# sourceMappingURL=md059.d.ts.map

package/dist/rules/md059.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"md059.d.ts","sourceRoot":"","sources":["../../src/rules/md059.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,IAAI,UAAU,CAAC;AAC5B,eAAO,MAAM,WAAW,oCAAoC,CAAC;AAiH7D;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CA6C7C;AAED;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,IAIlB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/md059.js

@@ -0,0 +1,161 @@
+/**
+ * MD059: Link text should be descriptive
+ *
+ * This rule is triggered when link text is non-descriptive, such as "click here",
+ * "more", "link", etc. These generic terms don't provide context about where the
+ * link will take the user, which is important for accessibility.
+ */
+export const name = 'MD059';
+export const description = 'Link text should be descriptive';
+/**
+ * Non-descriptive link text patterns that should be avoided
+ */
+const NON_DESCRIPTIVE_PATTERNS = [
+    /^click here$/i,
+    /^click$/i,
+    /^here$/i,
+    /^link$/i,
+    /^this link$/i,
+    /^more$/i,
+    /^more here$/i,
+    /^details$/i,
+    /^learn more$/i,
+    /^read more$/i,
+    /^source$/i,
+    /^link text$/i,
+    /^go$/i,
+    /^page$/i,
+    /^this$/i,
+    /^website$/i,
+    /^visit$/i,
+    /^info$/i,
+];
+/**
+ * Regular expression to find Markdown links
+ * Captures the link text in capture group 1
+ */
+const LINK_REGEX = /\[([^\]]+)\]\([^)]+\)/g;
+/**
+ * Check if link text is non-descriptive
+ * @param text Link text to check
+ * @returns True if the text is non-descriptive
+ */
+function isNonDescriptive(text) {
+    const trimmed = text.trim();
+    // Very short link text (1-2 characters) is likely non-descriptive
+    if (trimmed.length <= 2) {
+        return true;
+    }
+    // Check against known non-descriptive patterns
+    for (const pattern of NON_DESCRIPTIVE_PATTERNS) {
+        if (pattern.test(trimmed)) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Suggest more descriptive link text by adding context
+ * @param linkText Original link text
+ * @param surroundingText Text surrounding the link for context
+ * @returns Improved link text or null if no improvement needed
+ */
+function suggestImprovedLinkText(linkText, surroundingText) {
+    // If link text is already descriptive, no change needed
+    if (!isNonDescriptive(linkText)) {
+        return null;
+    }
+    // Try to find context from surrounding text
+    // Get 5 words before and after the link
+    const contextWords = surroundingText.split(/\s+/);
+    const linkWordIndex = contextWords.findIndex(word => word.includes(`[${linkText}]`));
+    if (linkWordIndex === -1) {
+        // Fallback improvement if we can't find context
+        return `More information about ${linkText}`;
+    }
+    // Get words before the link (up to 5)
+    const startIndex = Math.max(0, linkWordIndex - 5);
+    const beforeWords = contextWords.slice(startIndex, linkWordIndex).join(' ');
+    // Get words after the link (up to 5)
+    const endIndex = Math.min(contextWords.length, linkWordIndex + 6);
+    const afterWords = contextWords.slice(linkWordIndex + 1, endIndex).join(' ');
+    // Try to form an improved link text using context
+    let improvedText = '';
+    // Check for context in surrounding text
+    const topicMatch = surroundingText.match(/(?:about|regarding|on|for)\s+(\w+(?:\s+\w+){0,4})/i);
+    if (topicMatch && topicMatch[1]) {
+        improvedText = `${linkText} about ${topicMatch[1]}`;
+    }
+    else if (beforeWords && afterWords) {
+        // Combine some context before and after
+        const beforeContext = beforeWords.split(/\s+/).slice(-2).join(' ');
+        const afterContext = afterWords.split(/\s+/).slice(0, 2).join(' ');
+        improvedText = `${beforeContext} ${linkText} ${afterContext}`.trim();
+    }
+    else if (beforeWords) {
+        // Use context from before
+        const relevantBefore = beforeWords.split(/\s+/).slice(-3).join(' ');
+        improvedText = `${relevantBefore} ${linkText}`.trim();
+    }
+    else if (afterWords) {
+        // Use context from after
+        const relevantAfter = afterWords.split(/\s+/).slice(0, 3).join(' ');
+        improvedText = `${linkText} ${relevantAfter}`.trim();
+    }
+    else {
+        // Fallback if no context is found
+        improvedText = `More information about ${linkText}`;
+    }
+    return improvedText;
+}
+/**
+ * Fix non-descriptive link text in Markdown files
+ * @param lines Array of string lines to fix
+ * @returns Fixed lines array with more descriptive link text
+ */
+export function fix(lines) {
+    return lines.map((line, _index) => {
+        // Skip lines that don't have any links
+        if (!line.includes('[') || !line.includes('](')) {
+            return line;
+        }
+        let result = line;
+        let match;
+        let offset = 0;
+        // Reset the regex lastIndex
+        LINK_REGEX.lastIndex = 0;
+        // Process each link in the line
+        while ((match = LINK_REGEX.exec(line)) !== null) {
+            const [fullMatch, linkText] = match;
+            // Check if link text is non-descriptive
+            if (isNonDescriptive(linkText)) {
+                // Use surrounding text for context
+                const improvedText = suggestImprovedLinkText(linkText, line);
+                if (improvedText) {
+                    // Create the new link text
+                    const newText = fullMatch.replace(`[${linkText}]`, `[${improvedText}]`);
+                    // Replace at the correct position with the offset applied
+                    const startPos = match.index + offset;
+                    const endPos = startPos + fullMatch.length;
+                    // Update the result string
+                    result = result.substring(0, startPos) + newText + result.substring(endPos);
+                    // Update the offset for subsequent replacements
+                    offset += newText.length - fullMatch.length;
+                    // Update the lastIndex to account for the change in string length
+                    LINK_REGEX.lastIndex += newText.length - fullMatch.length;
+                }
+            }
+        }
+        return result;
+    });
+}
+/**
+ * Rule implementation for MD059
+ */
+export const rule = {
+    name,
+    description,
+    fix,
+};
+export default rule;
+//# sourceMappingURL=md059.js.map

package/dist/rules/md059.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"md059.js","sourceRoot":"","sources":["../../src/rules/md059.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC;AAC5B,MAAM,CAAC,MAAM,WAAW,GAAG,iCAAiC,CAAC;AAE7D;;GAEG;AACH,MAAM,wBAAwB,GAAG;IAC/B,eAAe;IACf,UAAU;IACV,SAAS;IACT,SAAS;IACT,cAAc;IACd,SAAS;IACT,cAAc;IACd,YAAY;IACZ,eAAe;IACf,cAAc;IACd,WAAW;IACX,cAAc;IACd,OAAO;IACP,SAAS;IACT,SAAS;IACT,YAAY;IACZ,UAAU;IACV,SAAS;CACV,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAE5C;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,IAAY;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAE5B,kEAAkE;IAClE,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+CAA+C;IAC/C,KAAK,MAAM,OAAO,IAAI,wBAAwB,EAAE,CAAC;QAC/C,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB,CAAC,QAAgB,EAAE,eAAuB;IACxE,wDAAwD;IACxD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,4CAA4C;IAC5C,wCAAwC;IACxC,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC;IAErF,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;QACzB,gDAAgD;QAChD,OAAO,0BAA0B,QAAQ,EAAE,CAAC;IAC9C,CAAC;IAED,sCAAsC;IACtC,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC;IAClD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE5E,qCAAqC;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC;IAClE,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE7E,kDAAkD;IAClD,IAAI,YAAY,GAAG,EAAE,CAAC;IAEtB,wCAAwC;IACxC,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;IAC/F,IAAI,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAChC,YAAY,GAAG,GAAG,QAAQ,UAAU,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IACtD,CAAC;SAAM,IAAI,WAAW,IAAI,UAAU,EAAE,CAAC;QACrC,wCAAwC;QACxC,MAAM,aAAa,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnE,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnE,YAAY,GAAG,GAAG,aAAa,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC,IAAI,EAAE,CAAC;IACvE,CAAC;SAAM,IAAI,WAAW,EAAE,CAAC;QACvB,0BAA0B;QAC1B,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpE,YAAY,GAAG,GAAG,cAAc,IAAI,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;IACxD,CAAC;SAAM,IAAI,UAAU,EAAE,CAAC;QACtB,yBAAyB;QACzB,MAAM,aAAa,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpE,YAAY,GAAG,GAAG,QAAQ,IAAI,aAAa,EAAE,CAAC,IAAI,EAAE,CAAC;IACvD,CAAC;SAAM,CAAC;QACN,kCAAkC;QAClC,YAAY,GAAG,0BAA0B,QAAQ,EAAE,CAAC;IACtD,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,KAAe;IACjC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QAChC,uCAAuC;QACvC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,IAAI,KAAK,CAAC;QACV,IAAI,MAAM,GAAG,CAAC,CAAC;QAEf,4BAA4B;QAC5B,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;QAEzB,gCAAgC;QAChC,OAAO,CAAC,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YAChD,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC;YAEpC,wCAAwC;YACxC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/B,mCAAmC;gBACnC,MAAM,YAAY,GAAG,uBAAuB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBAE7D,IAAI,YAAY,EAAE,CAAC;oBACjB,2BAA2B;oBAC3B,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,QAAQ,GAAG,EAAE,IAAI,YAAY,GAAG,CAAC,CAAC;oBAExE,0DAA0D;oBAC1D,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;oBACtC,MAAM,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC;oBAE3C,2BAA2B;oBAC3B,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;oBAE5E,gDAAgD;oBAChD,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;oBAE5C,kEAAkE;oBAClE,UAAU,CAAC,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI;IACJ,WAAW;IACX,GAAG;CACJ,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/rules/rule-interface.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Represents a rule violation detected by a rule
+ */
+export interface RuleViolation {
+    /**
+     * Line number where the violation was found (1-based)
+     */
+    lineNumber: number;
+    /**
+     * Details about the violation
+     */
+    details: string;
+    /**
+     * Range [startIndex, length] where the violation occurs
+     */
+    range?: [number, number];
+}
+/**
+ * Interface for rule implementations
+ */
+export interface Rule {
+    /**
+     * Rule name
+     */
+    name: string;
+    /**
+     * Rule description
+     */
+    description: string;
+    /**
+     * Validate function that checks an array of lines for violations
+     * @param lines Array of string lines to validate
+     * @param config Optional rule configuration
+     * @returns Array of rule violations
+     */
+    validate?: (lines: string[], config?: any) => RuleViolation[];
+    /**
+     * Fix function that applies the rule to an array of lines
+     * @param lines Array of string lines to fix
+     * @param config Optional rule configuration
+     * @returns Fixed lines array
+     */
+    fix?: (lines: string[], config?: any) => string[];
+}
+/**
+ * Type for the rules map
+ */
+export interface RuleMap {
+    [key: string]: Rule;
+}
+//# sourceMappingURL=rule-interface.d.ts.map

package/dist/rules/rule-interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-interface.d.ts","sourceRoot":"","sources":["../../src/rules/rule-interface.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1B;AAED;;GAEG;AAEH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,GAAG,KAAK,aAAa,EAAE,CAAC;IAE9D;;;;;OAKG;IACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,GAAG,KAAK,MAAM,EAAE,CAAC;CACnD;AAGD;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB"}

package/dist/rules/rule-interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rule-interface.js.map

package/dist/rules/rule-interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-interface.js","sourceRoot":"","sources":["../../src/rules/rule-interface.ts"],"names":[],"mappings":""}

package/dist/server.d.ts

@@ -0,0 +1,59 @@
+/**
+ * MCP server for markdownlint functionality
+ * Provides tools for linting and fixing markdown files
+ */
+export declare class MarkdownLintServer {
+    private server;
+    /**
+     * Initialize the markdownlint MCP server
+     */
+    constructor();
+    /**
+     * Set up handlers for MCP tool requests
+     */
+    private setupToolHandlers;
+    /**
+     * Lint a markdown file and report issues
+     * @param filePath Path to the markdown file
+     * @returns MCP content response with linting results
+     */
+    lintMarkdown(filePath: string): Promise<{
+        content: {
+            type: string;
+            text: string;
+        }[];
+    }>;
+    /**
+     * Fix markdown issues in a file
+     * @param filePath Path to the markdown file
+     * @param writeToFile Whether to write fixes back to the file
+     * @returns MCP content response with fix results
+     */
+    fixMarkdown(filePath: string, writeToFile: boolean): Promise<{
+        content: {
+            type: string;
+            text: string;
+        }[];
+    }>;
+    /**
+     * Get the current markdownlint configuration
+     * @returns MCP content response with configuration details
+     */
+    getConfiguration(): Promise<{
+        content: {
+            type: string;
+            text: string;
+        }[];
+    }>;
+    /**
+     * Start the MCP server
+     */
+    run(): Promise<void>;
+}
+/**
+ * Create and return a new MarkdownLint server instance
+ * @returns A new MarkdownLintServer instance
+ */
+export declare function createServer(): MarkdownLintServer;
+export default MarkdownLintServer;
+//# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAsBA;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,MAAM,CAAS;IAEvB;;OAEG;;IAwBH;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAkGzB;;;;OAIG;IACU,YAAY,CAAC,QAAQ,EAAE,MAAM;;;;;;IA+F1C;;;;;OAKG;IACU,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO;;;;;;IAoN/D;;;OAGG;IACU,gBAAgB;;;;;;IAc7B;;OAEG;IACU,GAAG;CAMjB;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,kBAAkB,CAEjD;AAED,eAAe,kBAAkB,CAAC"}