@mrsf/markdown-it-mrsf 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,84 @@
+/**
+ * MRSF markdown-it plugin — type definitions.
+ */
+import type { MrsfDocument } from "@mrsf/cli";
+/** Options for the MRSF markdown-it plugin. */
+export interface MrsfPluginOptions {
+    /**
+     * Path to the Markdown document on disk.
+     * Used for auto-discovery of the sidecar file via `@mrsf/cli`.
+     */
+    documentPath?: string;
+    /**
+     * Explicit path to the `.review.yaml` or `.review.json` sidecar file.
+     * Takes precedence over auto-discovery.
+     */
+    sidecarPath?: string;
+    /**
+     * Pre-loaded MRSF sidecar data.
+     * Takes precedence over `loader`, `sidecarPath`, and `documentPath`.
+     * Enables browser use, custom pipelines, and testing.
+     */
+    comments?: MrsfDocument;
+    /**
+     * Custom loader function that returns sidecar data.
+     * Takes precedence over `sidecarPath` and `documentPath`.
+     * Useful for integrations that manage their own sidecar state.
+     */
+    loader?: () => MrsfDocument | null;
+    /** Whether to show resolved comments (default: true). */
+    showResolved?: boolean;
+    /**
+     * Enable interactive mode — adds action buttons with `data-mrsf-action`
+     * attributes for host applications to hook into (default: false).
+     */
+    interactive?: boolean;
+    /**
+     * Position of the gutter badge relative to the line content.
+     * - `'left'`: badge in a left margin gutter, outside the content area
+     * - `'tight'`: badge inline, immediately before the text
+     * - `'right'`: badge floated to the right of the content (default)
+     */
+    gutterPosition?: "left" | "tight" | "right";
+    /**
+     * Whether to show the gutter badge on lines that have inline-highlighted
+     * comments (i.e. comments with `selected_text`). When false, lines where
+     * ALL comments have inline highlights will not get a gutter badge — the
+     * inline tooltip is the only way to view the comment. Default: true.
+     */
+    gutterForInline?: boolean;
+    /**
+     * Whether to render inline text highlights for comments that have
+     * `selected_text`. When false, only gutter badges are shown.
+     * Default: true.
+     */
+    inlineHighlights?: boolean;
+    /** Color scheme hint (default: 'auto'). */
+    theme?: "light" | "dark" | "auto";
+    /** Working directory for sidecar discovery (default: process.cwd()). */
+    cwd?: string;
+}
+/** Slim comment shape used internally after loading. */
+export interface SlimComment {
+    id: string;
+    author: string;
+    text: string;
+    line: number | null;
+    end_line: number | null;
+    start_column: number | null;
+    end_column: number | null;
+    selected_text: string | null;
+    resolved: boolean;
+    reply_to: string | null;
+    severity: string | null;
+    type: string | null;
+    timestamp: string | null;
+}
+/** A root comment with its threaded replies. */
+export interface CommentThread {
+    comment: SlimComment;
+    replies: SlimComment[];
+}
+/** Comments grouped by their anchored source line. */
+export type LineMap = Map<number, CommentThread[]>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * MRSF markdown-it plugin — type definitions.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@mrsf/markdown-it-mrsf",
+  "version": "0.1.0",
+  "description": "markdown-it plugin for rendering Sidemark/MRSF (Markdown Review Sidecar Format) review comments",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "import": "./dist/browser.js",
+        "types": "./dist/browser.d.ts"
+      },
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./browser": {
+      "import": "./dist/browser.js",
+      "types": "./dist/browser.d.ts"
+    },
+    "./style.css": "./dist/style.css",
+    "./controller": {
+      "import": "./dist/controller.js",
+      "types": "./dist/controller.d.ts"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc && cp src/style.css dist/style.css",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "cp ../LICENSE . && npm run build && npm test",
+    "postpublish": "rm -f LICENSE"
+  },
+  "keywords": [
+    "markdown-it",
+    "markdown-it-plugin",
+    "markdown",
+    "review",
+    "sidecar",
+    "mrsf",
+    "sidemark",
+    "comments"
+  ],
+  "license": "MIT",
+  "author": "Wictor Wilén (https://github.com/wictorwilen)",
+  "homepage": "https://github.com/wictorwilen/MRSF/tree/main/markdown-it#readme",
+  "bugs": {
+    "url": "https://github.com/wictorwilen/MRSF/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wictorwilen/MRSF.git",
+    "directory": "markdown-it"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "dist/style.css",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@mrsf/cli": "file:../cli"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "@types/node": "^22.13.10",
+    "markdown-it": "^14.1.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
+  }
+}