@codacy/tools-markdownlint-0 0.4.0 → 0.6.0

package/dist/index.js

@@ -33,9 +33,10 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var import_tooling = require("@codacy/tooling");
+var import_tooling2 = require("@codacy/tooling");
 
 // src/adapter.ts
+var import_tooling = require("@codacy/tooling");
 var import_path = __toESM(require("path"));
 var import_fs = __toESM(require("fs"));
 
@@ -47,6 +48,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Incremental Heading Levels",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -55,6 +57,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Heading Style",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -69,6 +72,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Unordered List Style",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -83,6 +87,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce consistent indentation for list items at the same level",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -91,6 +96,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Unordered List Indentation",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "indent",
@@ -115,6 +121,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Trailing Spaces",
     enabled: false,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "br_spaces",
@@ -139,6 +146,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Hard Tabs",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "code_blocks",
@@ -163,6 +171,7 @@ var patterns_default = [
     severityLevel: "Warning",
     title: "Avoid Reversed Link Syntax",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -171,6 +180,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Disallow Multiple Consecutive Blank Lines",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "maximum",
@@ -185,6 +195,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Maximum Line Length",
     enabled: false,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "code_block_line_length",
@@ -234,6 +245,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Dollar Signs Before Commands Without Showing Output",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -242,6 +254,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce space after hash in ATX style heading",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -250,6 +263,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Multiple Spaces After Hash in ATX Style Heading",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -258,6 +272,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Space Inside Hashes on Closed Atx Style Headings",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -266,6 +281,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Multiple Spaces Inside Hashes on Closed ATX Style Headings",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -274,6 +290,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Headings Surrounded by Blank Lines",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "lines_above",
@@ -293,6 +310,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Headings Start at Beginning of Line",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -301,6 +319,7 @@ var patterns_default = [
     severityLevel: "Warning",
     title: "Avoid Multiple Headings with the Same Content",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "siblings_only",
@@ -315,6 +334,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Single Top-Level Heading in Markdown Document",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "front_matter_title",
@@ -334,6 +354,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Trailing Punctuation in Headings",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "punctuation",
@@ -348,6 +369,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Multiple Spaces After Blockquote Symbol",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -356,6 +378,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Blank Line Inside Blockquote",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -364,6 +387,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Ordered List Item Prefix Consistency",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -378,6 +402,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Spaces After List Markers",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "ol_multi",
@@ -407,6 +432,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce blank lines surrounding fenced code blocks",
     enabled: false,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "list_items",
@@ -421,6 +447,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Lists Surrounded by Blank Lines",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -429,6 +456,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Disallow Inline HTML in Markdown",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "allowed_elements",
@@ -443,6 +471,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Angle Brackets Around Bare URLs",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -451,6 +480,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Horizontal Rule Style",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -465,6 +495,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Using Emphasis Instead of Headings",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "punctuation",
@@ -479,6 +510,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Disallow Spaces Inside Emphasis Markers",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -487,6 +519,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Disallow Spaces Inside Code Span Elements",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -495,6 +528,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Avoid Spaces Inside Link Text",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -503,6 +537,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce language specification in fenced code blocks",
     enabled: false,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "allowed_languages",
@@ -522,6 +557,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce First Line as Top-Level Heading",
     enabled: false,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "front_matter_title",
@@ -541,6 +577,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Disallow Empty Links",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -549,6 +586,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Required Heading Structure",
     enabled: false,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "headings",
@@ -568,6 +606,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Proper Capitalization of Proper Names",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "code_blocks",
@@ -592,6 +631,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Images to Have Alternate Text (alt text)",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -600,6 +640,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce consistent code block style",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -614,6 +655,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Single Trailing Newline at End of File",
     enabled: false,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -622,6 +664,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Code Fence Style",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -636,6 +679,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Emphasis Style",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -650,6 +694,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Strong Style",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -664,6 +709,7 @@ var patterns_default = [
     severityLevel: "Warning",
     title: "Enforce Valid Link Fragments in Markdown",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   },
   {
@@ -672,6 +718,7 @@ var patterns_default = [
     severityLevel: "Warning",
     title: "Enforce Defined Labels for Reference Links and Images",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "shortcut_syntax",
@@ -686,6 +733,7 @@ var patterns_default = [
     severityLevel: "Warning",
     title: "Enforce Link and Image Reference Definitions Are Needed",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "ignored_definitions",
@@ -700,6 +748,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Link and Image Style in Markdown",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "autolink",
@@ -739,6 +788,7 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Table Pipe Style Consistency",
     enabled: true,
+    languages: ["Markdown"],
     parameters: [
       {
         name: "style",
@@ -753,10 +803,23 @@ var patterns_default = [
     severityLevel: "Info",
     title: "Enforce Consistent Table Column Count",
     enabled: true,
+    languages: ["Markdown"],
     parameters: []
   }
 ];
 
+// src/metadata.ts
+var descriptor = {
+  id: "markdownlint",
+  displayName: "markdownlint",
+  preferredVersion: "0.37.4",
+  languages: ["Markdown"],
+  filePatterns: ["**/*.md", "**/*.markdown"],
+  supportedOS: ["linux", "darwin", "win32"],
+  supportedArch: ["x64", "arm64"],
+  supportedRunners: ["local", "container"]
+};
+
 // src/adapter.ts
 var TOOL_ID = "markdownlint";
 var LOCAL_CONFIG_FILES = [
@@ -778,12 +841,36 @@ function ruleMetadata(ruleId) {
   const patternId = `${TOOL_ID}_${ruleId}`;
   return PATTERN_META.get(patternId) ?? { category: "Documentation", severity: "Info" };
 }
+function coerceParameterValue(value) {
+  const trimmed = value.trim();
+  if (trimmed === "true") return true;
+  if (trimmed === "false") return false;
+  if (trimmed.startsWith("[") || trimmed.startsWith("{") || trimmed.startsWith('"')) {
+    try {
+      return JSON.parse(trimmed);
+    } catch {
+      return value;
+    }
+  }
+  if (/^-?\d+(\.\d+)?$/.test(trimmed)) {
+    return Number(trimmed);
+  }
+  return value;
+}
 function buildMarkdownlintConfig(patterns) {
   const config = { default: false };
   const prefix = `${TOOL_ID}_`;
   for (const p of patterns) {
     const ruleId = p.patternId.startsWith(prefix) ? p.patternId.slice(prefix.length) : p.patternId;
-    config[ruleId] = true;
+    if (p.parameters && Object.keys(p.parameters).length > 0) {
+      const coerced = {};
+      for (const [key, value] of Object.entries(p.parameters)) {
+        coerced[key] = coerceParameterValue(value);
+      }
+      config[ruleId] = coerced;
+    } else {
+      config[ruleId] = true;
+    }
   }
   return config;
 }
@@ -800,16 +887,9 @@ async function importMarkdownlintSync() {
   return import("markdownlint/sync");
 }
 var adapter = {
-  id: TOOL_ID,
-  displayName: "markdownlint",
-  preferredVersion: "0.37.4",
+  ...descriptor,
   compatibleVersions: ">=0.30.0 <1.0.0",
   website: "https://github.com/DavidAnson/markdownlint",
-  languages: ["Markdown"],
-  filePatterns: ["**/*.md", "**/*.markdown"],
-  supportedOS: ["linux", "darwin", "win32"],
-  supportedArch: ["x64", "arm64"],
-  supportedRunners: ["local", "container"],
   prerequisites: [],
   /**
    * Verifies that the `markdownlint` npm package is loadable and returns its
@@ -886,7 +966,7 @@ var adapter = {
     const absoluteFiles = ctx.targetFiles.map((f) => import_path.default.resolve(ctx.repositoryRoot, f));
     if (absoluteFiles.length === 0) {
       const completedAt2 = /* @__PURE__ */ new Date();
-      return buildResult(startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
+      return (0, import_tooling.buildResult)(TOOL_ID, startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
     }
     let lintFn;
     let readConfigFn;
@@ -903,7 +983,7 @@ var adapter = {
         message: `Failed to load markdownlint: ${err instanceof Error ? err.message : String(err)}`,
         level: "error"
       });
-      return buildResult(startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
+      return (0, import_tooling.buildResult)(TOOL_ID, startedAt, completedAt2, issues, errors, ctx.targetFiles.length);
     }
     let inlineConfig;
     if (codacyConfig.useLocalConfigurationFile && codacyConfig.localConfigurationFile) {
@@ -924,7 +1004,7 @@ var adapter = {
       ctx.logger.info("Skipping analysis: no local config and no patterns enabled", {
         toolId: TOOL_ID
       });
-      return buildResult(startedAt, /* @__PURE__ */ new Date(), issues, errors, ctx.targetFiles.length);
+      return (0, import_tooling.buildResult)(TOOL_ID, startedAt, /* @__PURE__ */ new Date(), issues, errors, ctx.targetFiles.length);
     }
     const lintOptions = { files: absoluteFiles };
     if (inlineConfig !== void 0) {
@@ -981,29 +1061,9 @@ var adapter = {
       errorCount: errors.length,
       durationMs: Date.now() - startMs
     });
-    return buildResult(startedAt, completedAt, issues, errors, ctx.targetFiles.length);
+    return (0, import_tooling.buildResult)(TOOL_ID, startedAt, completedAt, issues, errors, ctx.targetFiles.length);
   }
 };
-function buildResult(startedAt, completedAt, issues, errors, filesAnalyzed) {
-  const durationMs = completedAt.getTime() - startedAt.getTime();
-  return {
-    metadata: {
-      startedAt: startedAt.toISOString(),
-      completedAt: completedAt.toISOString(),
-      durationMs
-    },
-    issues,
-    errors,
-    summary: {
-      toolId: TOOL_ID,
-      status: errors.some((e) => e.level === "error") ? "partial" : "success",
-      issueCount: issues.length,
-      errorCount: errors.length,
-      durationMs,
-      filesAnalyzed
-    }
-  };
-}
 
 // src/index.ts
-var index_default = (0, import_tooling.defineToolAdapter)(adapter);
+var index_default = (0, import_tooling2.defineToolAdapter)(adapter);

package/dist/metadata.d.ts

@@ -0,0 +1,13 @@
+import { AdapterDescriptor } from '@codacy/tooling';
+
+/**
+ * Lightweight adapter descriptor for lazy loading.
+ *
+ * This module contains only plain-data metadata fields and has zero heavy
+ * imports (no patterns.json, no runtime utilities). The CLI imports this
+ * at startup for adapter registration without loading the full adapter module.
+ */
+
+declare const descriptor: AdapterDescriptor;
+
+export { descriptor };

package/dist/metadata.js

@@ -0,0 +1,39 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/metadata.ts
+var metadata_exports = {};
+__export(metadata_exports, {
+  descriptor: () => descriptor
+});
+module.exports = __toCommonJS(metadata_exports);
+var descriptor = {
+  id: "markdownlint",
+  displayName: "markdownlint",
+  preferredVersion: "0.37.4",
+  languages: ["Markdown"],
+  filePatterns: ["**/*.md", "**/*.markdown"],
+  supportedOS: ["linux", "darwin", "win32"],
+  supportedArch: ["x64", "arm64"],
+  supportedRunners: ["local", "container"]
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  descriptor
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codacy/tools-markdownlint-0",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "markdownlint adapter — Library-mode Markdown linter",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,7 @@
   ],
   "dependencies": {
     "markdownlint": "^0.37.4",
-    "@codacy/tooling": "0.4.0"
+    "@codacy/tooling": "0.6.0"
   },
   "license": "MIT",
   "author": "Codacy <support@codacy.com> (https://www.codacy.com)",
@@ -22,8 +22,18 @@
   "engines": {
     "node": ">=20.0.0"
   },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./metadata": {
+      "types": "./dist/metadata.d.ts",
+      "default": "./dist/metadata.js"
+    }
+  },
   "scripts": {
-    "build": "tsup src/index.ts --format cjs --dts --clean",
+    "build": "tsup src/index.ts src/metadata.ts --format cjs --dts --clean",
     "test": "vitest run",
     "lint": "eslint src/",
     "clean": "rm -rf dist",