markdownlint-obsidian-cli 1.0.0

package/README.md

@@ -0,0 +1,47 @@
+# markdownlint-obsidian-cli
+
+Command-line interface for linting Obsidian Flavored Markdown. Wraps the
+`markdownlint-obsidian` library with a `commander`-based CLI.
+
+## Install
+
+```bash
+# Global install
+npm install -g markdownlint-obsidian-cli
+bun add -g markdownlint-obsidian-cli
+
+# Project install (use via npx / bunx)
+npm install -D markdownlint-obsidian-cli
+```
+
+## Usage
+
+```bash
+# Lint all markdown files
+markdownlint-obsidian "**/*.md"
+
+# Fix auto-fixable issues in place
+markdownlint-obsidian --fix "**/*.md"
+
+# Check what would be fixed (no writes)
+markdownlint-obsidian --fix-check "**/*.md"
+
+# Machine-readable output
+markdownlint-obsidian --output-formatter sarif "**/*.md" > report.sarif
+markdownlint-obsidian --output-formatter junit "**/*.md" > junit.xml
+
+# Custom config location
+markdownlint-obsidian --config /path/to/project "**/*.md"
+```
+
+## Exit codes
+
+| Code | Meaning |
+| --- | --- |
+| `0` | Clean (no errors; warnings do not raise exit code) |
+| `1` | One or more lint errors found |
+| `2` | Tool or configuration failure |
+
+## License
+
+MIT

package/bin/markdownlint-obsidian.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env bun
+// Dev entry: Bun executes the TypeScript source directly — no compilation step.
+// The published hermetic entry is dist/bin.mjs (Node-compatible shebang,
+// imports compiled dist/src/cli/main.js), generated by `bun run build`.
+import { main } from "../src/main.ts";
+const code = await main(process.argv);
+process.exit(code);

package/dist/bin.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { main } from "./src/main.js";
+const code = await main(process.argv);
+process.exit(code);

package/dist/package.json

@@ -0,0 +1,4 @@
+{
+  "version": "1.0.0",
+  "type": "module"
+}

package/dist/src/args.d.ts

@@ -0,0 +1,34 @@
+import { Command } from "commander";
+/**
+ * Parsed CLI options returned by commander.
+ *
+ * Fields mirror markdownlint-cli2's flag set so downstream users can reuse
+ * existing muscle memory and automation.
+ */
+export interface CLIArgs {
+    readonly globs: string[];
+    readonly config?: string;
+    readonly configPointer?: string;
+    readonly fix: boolean;
+    readonly fixCheck: boolean;
+    readonly format: boolean;
+    readonly noGlobs: boolean;
+    readonly vaultRoot?: string;
+    /**
+     * Commander maps `--no-resolve` to `resolve: false`. Left `undefined`
+     * when the flag is not supplied so config-level `resolve` can win.
+     */
+    readonly resolve?: boolean;
+    readonly outputFormatter: string;
+}
+/**
+ * Build the top-level commander {@link Command} for the CLI.
+ *
+ * The returned program has `exitOverride()` configured by the caller so
+ * `--help` and `--version` can be caught in tests without terminating the
+ * process.
+ *
+ * @returns A fully wired commander `Command`.
+ */
+export declare function buildProgram(): Command;
+//# sourceMappingURL=args.d.ts.map

package/dist/src/args.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../../src/args.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMpC;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAqBtC"}

package/dist/src/args.js

@@ -0,0 +1,32 @@
+import { Command } from "commander";
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+const { version } = require("../package.json");
+/**
+ * Build the top-level commander {@link Command} for the CLI.
+ *
+ * The returned program has `exitOverride()` configured by the caller so
+ * `--help` and `--version` can be caught in tests without terminating the
+ * process.
+ *
+ * @returns A fully wired commander `Command`.
+ */
+export function buildProgram() {
+    const program = new Command();
+    program
+        .name("markdownlint-obsidian")
+        .description("Obsidian Flavored Markdown linter for CI pipelines")
+        .version(version)
+        .argument("[globs...]", "Glob patterns for files to lint")
+        .option("--config <path>", "Explicit config file path")
+        .option("--config-pointer <ptr>", "JSON Pointer into config (e.g. #/markdownlint)")
+        .option("--fix", "Auto-fix fixable errors in-place", false)
+        .option("--fix-check", "Check if fixes are needed without writing files", false)
+        .option("--format", "Read stdin, write linted content to stdout", false)
+        .option("--no-globs", "Ignore globs property in config file")
+        .option("--vault-root <path>", "Override auto-detected vault root")
+        .option("--no-resolve", "Disable wikilink resolution")
+        .option("--output-formatter <name>", "Output formatter (default, json, junit, sarif)", "default");
+    return program;
+}
+//# sourceMappingURL=args.js.map

package/dist/src/args.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"args.js","sourceRoot":"","sources":["../../src/args.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAwB,CAAC;AAyBtE;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,OAAO;SACJ,IAAI,CAAC,uBAAuB,CAAC;SAC7B,WAAW,CAAC,oDAAoD,CAAC;SACjE,OAAO,CAAC,OAAO,CAAC;SAChB,QAAQ,CAAC,YAAY,EAAE,iCAAiC,CAAC;SACzD,MAAM,CAAC,iBAAiB,EAAE,2BAA2B,CAAC;SACtD,MAAM,CAAC,wBAAwB,EAAE,gDAAgD,CAAC;SAClF,MAAM,CAAC,OAAO,EAAE,kCAAkC,EAAE,KAAK,CAAC;SAC1D,MAAM,CAAC,aAAa,EAAE,iDAAiD,EAAE,KAAK,CAAC;SAC/E,MAAM,CAAC,UAAU,EAAE,4CAA4C,EAAE,KAAK,CAAC;SACvE,MAAM,CAAC,YAAY,EAAE,sCAAsC,CAAC;SAC5D,MAAM,CAAC,qBAAqB,EAAE,mCAAmC,CAAC;SAClE,MAAM,CAAC,cAAc,EAAE,6BAA6B,CAAC;SACrD,MAAM,CACL,2BAA2B,EAC3B,gDAAgD,EAChD,SAAS,CACV,CAAC;IACJ,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/src/main.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Exit codes used by every CLI path.
+ *
+ * 0 = clean, 1 = lint errors, 2 = tool or config failure.
+ */
+export declare const EXIT_CODES: Readonly<{
+    readonly CLEAN: 0;
+    readonly LINT_ERRORS: 1;
+    readonly TOOL_FAILURE: 2;
+}>;
+/**
+ * Entry point called by `bin/markdownlint-obsidian.js`.
+ *
+ * Parses arguments, runs the linting pipeline via the engine API,
+ * prints formatter output, and returns the appropriate exit code.
+ *
+ * @param argv - Argument vector, typically `process.argv`.
+ * @returns Resolved exit code (0, 1, or 2).
+ */
+export declare function main(argv: string[]): Promise<number>;
+//# sourceMappingURL=main.d.ts.map

package/dist/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AA2BA;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;;EAIZ,CAAC;AAEZ;;;;;;;;GAQG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAY1D"}

package/dist/src/main.js

@@ -0,0 +1,136 @@
+import { buildProgram } from "./args.js";
+import { lint, fix, getFormatter, loadConfig, } from "markdownlint-obsidian/engine";
+/**
+ * Exit codes used by every CLI path.
+ *
+ * 0 = clean, 1 = lint errors, 2 = tool or config failure.
+ */
+export const EXIT_CODES = Object.freeze({
+    CLEAN: 0,
+    LINT_ERRORS: 1,
+    TOOL_FAILURE: 2,
+});
+/**
+ * Entry point called by `bin/markdownlint-obsidian.js`.
+ *
+ * Parses arguments, runs the linting pipeline via the engine API,
+ * prints formatter output, and returns the appropriate exit code.
+ *
+ * @param argv - Argument vector, typically `process.argv`.
+ * @returns Resolved exit code (0, 1, or 2).
+ */
+export async function main(argv) {
+    const program = buildProgram();
+    program.exitOverride();
+    const parsed = parseArgv(program, argv);
+    if (parsed.terminal !== null)
+        return parsed.terminal;
+    const opts = program.opts();
+    const cwd = process.cwd();
+    const globs = program.args;
+    return runPipeline(globs, opts, cwd);
+}
+function parseArgv(program, argv) {
+    try {
+        program.parse(argv);
+        return { terminal: null };
+    }
+    catch (err) {
+        const e = err;
+        if (e.code === "commander.helpDisplayed" || e.code === "commander.version") {
+            return { terminal: EXIT_CODES.CLEAN };
+        }
+        return { terminal: EXIT_CODES.TOOL_FAILURE };
+    }
+}
+function resolveFormatter(name) {
+    try {
+        return getFormatter(name);
+    }
+    catch (err) {
+        process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
+        return null;
+    }
+}
+function emitAndExit(results, formatterName) {
+    const formatter = resolveFormatter(formatterName);
+    if (formatter === null)
+        return EXIT_CODES.TOOL_FAILURE;
+    const output = formatter(results);
+    if (output)
+        process.stdout.write(output + "\n");
+    return results.some((r) => r.hasErrors) ? EXIT_CODES.LINT_ERRORS : EXIT_CODES.CLEAN;
+}
+function fmtRange(col, del) {
+    return del === 0 ? `col ${col}` : `col ${col}–${col + del - 1}`;
+}
+function onCustomRuleError(modulePath, message) {
+    process.stderr.write(`OFM905: failed to load custom rule module "${modulePath}": ${message}\n`);
+}
+function buildEngineOptions(globArgs, config, opts, cwd) {
+    const effectiveGlobs = globArgs.length > 0 ? [...globArgs] : config.globs;
+    return {
+        globs: effectiveGlobs,
+        cwd,
+        ...(opts.vaultRoot !== undefined && { vaultRoot: opts.vaultRoot }),
+        ...(opts.resolve === false && { resolve: false }),
+        ...(opts.config !== undefined && { config: opts.config }),
+        onCustomRuleError,
+    };
+}
+async function runFixBranch(engineOptions, opts) {
+    try {
+        const outcome = await fix({
+            ...engineOptions,
+            check: opts.fixCheck,
+        });
+        if (outcome.filesFixed.length > 0) {
+            const verb = opts.fixCheck ? "Would fix" : "Fixed";
+            process.stderr.write(`${verb} ${outcome.filesFixed.length} file(s)\n`);
+        }
+        for (const conflict of outcome.conflicts) {
+            const colA = fmtRange(conflict.first.editColumn, conflict.first.deleteCount);
+            const colB = fmtRange(conflict.second.editColumn, conflict.second.deleteCount);
+            process.stderr.write(`[fix-conflict] ${conflict.filePath}: ${conflict.reason} (${colA} vs ${colB})\n`);
+        }
+        return emitAndExit(outcome.finalPass, opts.outputFormatter);
+    }
+    catch (err) {
+        process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
+        return EXIT_CODES.TOOL_FAILURE;
+    }
+}
+async function runLintBranch(engineOptions, opts) {
+    try {
+        const results = await lint(engineOptions);
+        return emitAndExit(results, opts.outputFormatter);
+    }
+    catch (err) {
+        process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
+        return EXIT_CODES.TOOL_FAILURE;
+    }
+}
+function checkMutualExclusion(opts) {
+    if (opts.fix && opts.fixCheck) {
+        process.stderr.write("OFM902: --fix and --fix-check are mutually exclusive\n");
+        return EXIT_CODES.TOOL_FAILURE;
+    }
+    return null;
+}
+async function runPipeline(globArgs, opts, cwd) {
+    const exclusionCode = checkMutualExclusion(opts);
+    if (exclusionCode !== null)
+        return exclusionCode;
+    if (resolveFormatter(opts.outputFormatter) === null)
+        return EXIT_CODES.TOOL_FAILURE;
+    const config = await loadConfig(opts.config ?? cwd).catch(() => null);
+    if (!config) {
+        process.stderr.write("OFM901: failed to load configuration\n");
+        return EXIT_CODES.TOOL_FAILURE;
+    }
+    const engineOptions = buildEngineOptions(globArgs, config, opts, cwd);
+    return opts.fix || opts.fixCheck
+        ? runFixBranch(engineOptions, opts)
+        : runLintBranch(engineOptions, opts);
+}
+//# sourceMappingURL=main.js.map

package/dist/src/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EACL,IAAI,EACJ,GAAG,EACH,YAAY,EACZ,UAAU,GAGX,MAAM,8BAA8B,CAAC;AAkBtC;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,CAAC;IACR,WAAW,EAAE,CAAC;IACd,YAAY,EAAE,CAAC;CACP,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAc;IACvC,MAAM,OAAO,GAAG,YAAY,EAAE,CAAC;IAC/B,OAAO,CAAC,YAAY,EAAE,CAAC;IAEvB,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACxC,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC,QAAQ,CAAC;IAErD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAiB,CAAC;IAC3C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,KAAK,GAAG,OAAO,CAAC,IAAgB,CAAC;IAEvC,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;AACvC,CAAC;AAMD,SAAS,SAAS,CAAC,OAAgB,EAAE,IAAc;IACjD,IAAI,CAAC;QACH,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,GAAwB,CAAC;QACnC,IAAI,CAAC,CAAC,IAAI,KAAK,yBAAyB,IAAI,CAAC,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YAC3E,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;QACxC,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC;IAC/C,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY;IACpC,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,OAA8B,EAAE,aAAqB;IACxE,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAClD,IAAI,SAAS,KAAK,IAAI;QAAE,OAAO,UAAU,CAAC,YAAY,CAAC;IACvD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,MAAM;QAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAChD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;AACtF,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW,EAAE,GAAW;IACxC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC,OAAO,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC;AAClE,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAkB,EAAE,OAAe;IAC5D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,8CAA8C,UAAU,MAAM,OAAO,IAAI,CAAC,CAAC;AAClG,CAAC;AAED,SAAS,kBAAkB,CACzB,QAA2B,EAC3B,MAA8C,EAC9C,IAAmB,EACnB,GAAW;IAEX,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAC1E,OAAO;QACL,KAAK,EAAE,cAAc;QACrB,GAAG;QACH,GAAG,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QAClE,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QACjD,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QACzD,iBAAiB;KAClB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,aAAqB,EAAE,IAAmB;IACpE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC;YACxB,GAAI,aAA2C;YAC/C,KAAK,EAAE,IAAI,CAAC,QAAQ;SACrB,CAAC,CAAC;QACH,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC;YACnD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,YAAY,CAAC,CAAC;QACzE,CAAC;QACD,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAC7E,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAC/E,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,kBAAkB,QAAQ,CAAC,QAAQ,KAAK,QAAQ,CAAC,MAAM,KAAK,IAAI,OAAO,IAAI,KAAK,CACjF,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC9D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9E,OAAO,UAAU,CAAC,YAAY,CAAC;IACjC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,aAAqB,EAAE,IAAmB;IACrE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAA2C,CAAC,CAAC;QACxE,OAAO,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9E,OAAO,UAAU,CAAC,YAAY,CAAC;IACjC,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAmB;IAC/C,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC/E,OAAO,UAAU,CAAC,YAAY,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,QAA2B,EAC3B,IAAmB,EACnB,GAAW;IAEX,MAAM,aAAa,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,aAAa,KAAK,IAAI;QAAE,OAAO,aAAa,CAAC;IAEjD,IAAI,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,IAAI;QAAE,OAAO,UAAU,CAAC,YAAY,CAAC;IAEpF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;IACtE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC/D,OAAO,UAAU,CAAC,YAAY,CAAC;IACjC,CAAC;IAED,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACtE,OAAO,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,QAAQ;QAC9B,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,CAAC;QACnC,CAAC,CAAC,aAAa,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;AACzC,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "markdownlint-obsidian-cli",
+  "version": "1.0.0",
+  "description": "CLI for markdownlint-obsidian — lint Obsidian Flavored Markdown from the command line",
+  "type": "module",
+  "bin": {
+    "markdownlint-obsidian": "./bin/markdownlint-obsidian.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/src/main.d.ts",
+      "default": "./dist/src/main.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "bin/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && node scripts/gen-dist-bin.mjs",
+    "typecheck": "tsc --noEmit",
+    "test": "bun test --timeout 30000",
+    "test:watch": "bun test --watch --timeout 30000",
+    "prepublishOnly": "bun run build && bun run test"
+  },
+  "dependencies": {
+    "markdownlint-obsidian": "workspace:*",
+    "commander": "^12.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "bun": ">=1.1.30"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alisonaquinas/markdownlint-obsidian.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://github.com/alisonaquinas/markdownlint-obsidian#readme",
+  "bugs": {
+    "url": "https://github.com/alisonaquinas/markdownlint-obsidian/issues"
+  },
+  "keywords": [
+    "markdown",
+    "markdownlint",
+    "obsidian",
+    "linter",
+    "cli"
+  ]
+}

package/src/args.ts

@@ -0,0 +1,60 @@
+import { Command } from "commander";
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+const { version } = require("../package.json") as { version: string };
+
+/**
+ * Parsed CLI options returned by commander.
+ *
+ * Fields mirror markdownlint-cli2's flag set so downstream users can reuse
+ * existing muscle memory and automation.
+ */
+export interface CLIArgs {
+  readonly globs: string[];
+  readonly config?: string;
+  readonly configPointer?: string;
+  readonly fix: boolean;
+  readonly fixCheck: boolean;
+  readonly format: boolean;
+  readonly noGlobs: boolean;
+  readonly vaultRoot?: string;
+  /**
+   * Commander maps `--no-resolve` to `resolve: false`. Left `undefined`
+   * when the flag is not supplied so config-level `resolve` can win.
+   */
+  readonly resolve?: boolean;
+  readonly outputFormatter: string;
+}
+
+/**
+ * Build the top-level commander {@link Command} for the CLI.
+ *
+ * The returned program has `exitOverride()` configured by the caller so
+ * `--help` and `--version` can be caught in tests without terminating the
+ * process.
+ *
+ * @returns A fully wired commander `Command`.
+ */
+export function buildProgram(): Command {
+  const program = new Command();
+  program
+    .name("markdownlint-obsidian")
+    .description("Obsidian Flavored Markdown linter for CI pipelines")
+    .version(version)
+    .argument("[globs...]", "Glob patterns for files to lint")
+    .option("--config <path>", "Explicit config file path")
+    .option("--config-pointer <ptr>", "JSON Pointer into config (e.g. #/markdownlint)")
+    .option("--fix", "Auto-fix fixable errors in-place", false)
+    .option("--fix-check", "Check if fixes are needed without writing files", false)
+    .option("--format", "Read stdin, write linted content to stdout", false)
+    .option("--no-globs", "Ignore globs property in config file")
+    .option("--vault-root <path>", "Override auto-detected vault root")
+    .option("--no-resolve", "Disable wikilink resolution")
+    .option(
+      "--output-formatter <name>",
+      "Output formatter (default, json, junit, sarif)",
+      "default",
+    );
+  return program;
+}

package/src/main.ts

@@ -0,0 +1,183 @@
+import type { Command } from "commander";
+import { buildProgram } from "./args.js";
+import {
+  lint,
+  fix,
+  getFormatter,
+  loadConfig,
+  type Formatter,
+  type LintResult,
+} from "markdownlint-obsidian/engine";
+
+interface ParsedOptions {
+  readonly fix: boolean;
+  readonly fixCheck: boolean;
+  readonly format: boolean;
+  readonly vaultRoot?: string;
+  /**
+   * Commander maps `--no-resolve` to `resolve: false` and leaves the default
+   * at `true`. This is a tri-state in practice: `undefined` means the flag
+   * was never touched (fall back to config), `false` means `--no-resolve`
+   * was supplied.
+   */
+  readonly resolve?: boolean;
+  readonly outputFormatter: string;
+  readonly config?: string;
+}
+
+/**
+ * Exit codes used by every CLI path.
+ *
+ * 0 = clean, 1 = lint errors, 2 = tool or config failure.
+ */
+export const EXIT_CODES = Object.freeze({
+  CLEAN: 0,
+  LINT_ERRORS: 1,
+  TOOL_FAILURE: 2,
+} as const);
+
+/**
+ * Entry point called by `bin/markdownlint-obsidian.js`.
+ *
+ * Parses arguments, runs the linting pipeline via the engine API,
+ * prints formatter output, and returns the appropriate exit code.
+ *
+ * @param argv - Argument vector, typically `process.argv`.
+ * @returns Resolved exit code (0, 1, or 2).
+ */
+export async function main(argv: string[]): Promise<number> {
+  const program = buildProgram();
+  program.exitOverride();
+
+  const parsed = parseArgv(program, argv);
+  if (parsed.terminal !== null) return parsed.terminal;
+
+  const opts = program.opts<ParsedOptions>();
+  const cwd = process.cwd();
+  const globs = program.args as string[];
+
+  return runPipeline(globs, opts, cwd);
+}
+
+interface ParseResult {
+  readonly terminal: number | null;
+}
+
+function parseArgv(program: Command, argv: string[]): ParseResult {
+  try {
+    program.parse(argv);
+    return { terminal: null };
+  } catch (err: unknown) {
+    const e = err as { code?: string };
+    if (e.code === "commander.helpDisplayed" || e.code === "commander.version") {
+      return { terminal: EXIT_CODES.CLEAN };
+    }
+    return { terminal: EXIT_CODES.TOOL_FAILURE };
+  }
+}
+
+function resolveFormatter(name: string): Formatter | null {
+  try {
+    return getFormatter(name);
+  } catch (err) {
+    process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
+    return null;
+  }
+}
+
+function emitAndExit(results: readonly LintResult[], formatterName: string): number {
+  const formatter = resolveFormatter(formatterName);
+  if (formatter === null) return EXIT_CODES.TOOL_FAILURE;
+  const output = formatter(results);
+  if (output) process.stdout.write(output + "\n");
+  return results.some((r) => r.hasErrors) ? EXIT_CODES.LINT_ERRORS : EXIT_CODES.CLEAN;
+}
+
+function fmtRange(col: number, del: number): string {
+  return del === 0 ? `col ${col}` : `col ${col}–${col + del - 1}`;
+}
+
+function onCustomRuleError(modulePath: string, message: string): void {
+  process.stderr.write(`OFM905: failed to load custom rule module "${modulePath}": ${message}\n`);
+}
+
+function buildEngineOptions(
+  globArgs: readonly string[],
+  config: Awaited<ReturnType<typeof loadConfig>>,
+  opts: ParsedOptions,
+  cwd: string,
+): object {
+  const effectiveGlobs = globArgs.length > 0 ? [...globArgs] : config.globs;
+  return {
+    globs: effectiveGlobs,
+    cwd,
+    ...(opts.vaultRoot !== undefined && { vaultRoot: opts.vaultRoot }),
+    ...(opts.resolve === false && { resolve: false }),
+    ...(opts.config !== undefined && { config: opts.config }),
+    onCustomRuleError,
+  };
+}
+
+async function runFixBranch(engineOptions: object, opts: ParsedOptions): Promise<number> {
+  try {
+    const outcome = await fix({
+      ...(engineOptions as Parameters<typeof fix>[0]),
+      check: opts.fixCheck,
+    });
+    if (outcome.filesFixed.length > 0) {
+      const verb = opts.fixCheck ? "Would fix" : "Fixed";
+      process.stderr.write(`${verb} ${outcome.filesFixed.length} file(s)\n`);
+    }
+    for (const conflict of outcome.conflicts) {
+      const colA = fmtRange(conflict.first.editColumn, conflict.first.deleteCount);
+      const colB = fmtRange(conflict.second.editColumn, conflict.second.deleteCount);
+      process.stderr.write(
+        `[fix-conflict] ${conflict.filePath}: ${conflict.reason} (${colA} vs ${colB})\n`,
+      );
+    }
+    return emitAndExit(outcome.finalPass, opts.outputFormatter);
+  } catch (err) {
+    process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
+    return EXIT_CODES.TOOL_FAILURE;
+  }
+}
+
+async function runLintBranch(engineOptions: object, opts: ParsedOptions): Promise<number> {
+  try {
+    const results = await lint(engineOptions as Parameters<typeof lint>[0]);
+    return emitAndExit(results, opts.outputFormatter);
+  } catch (err) {
+    process.stderr.write(`${err instanceof Error ? err.message : String(err)}\n`);
+    return EXIT_CODES.TOOL_FAILURE;
+  }
+}
+
+function checkMutualExclusion(opts: ParsedOptions): number | null {
+  if (opts.fix && opts.fixCheck) {
+    process.stderr.write("OFM902: --fix and --fix-check are mutually exclusive\n");
+    return EXIT_CODES.TOOL_FAILURE;
+  }
+  return null;
+}
+
+async function runPipeline(
+  globArgs: readonly string[],
+  opts: ParsedOptions,
+  cwd: string,
+): Promise<number> {
+  const exclusionCode = checkMutualExclusion(opts);
+  if (exclusionCode !== null) return exclusionCode;
+
+  if (resolveFormatter(opts.outputFormatter) === null) return EXIT_CODES.TOOL_FAILURE;
+
+  const config = await loadConfig(opts.config ?? cwd).catch(() => null);
+  if (!config) {
+    process.stderr.write("OFM901: failed to load configuration\n");
+    return EXIT_CODES.TOOL_FAILURE;
+  }
+
+  const engineOptions = buildEngineOptions(globArgs, config, opts, cwd);
+  return opts.fix || opts.fixCheck
+    ? runFixBranch(engineOptions, opts)
+    : runLintBranch(engineOptions, opts);
+}