katana-markdown-linter 0.17.7

package/README.md

@@ -0,0 +1,57 @@
+# katana-markdown-linter
+
+`katana-markdown-linter` is a thin npm launcher for the `kml` Markdown linter.
+The package does not contain independent lint logic. On first use, it downloads
+the matching `kml` binary archive from GitHub Releases, verifies the neighboring
+SHA-256 checksum, installs the binary into the wrapper cache, and then delegates
+all commands to that binary, including localized CLI help.
+
+## Install
+
+~~~bash
+npm install -g katana-markdown-linter
+kml --version
+~~~
+
+Use `npx` for one-off runs:
+
+~~~bash
+npx --yes katana-markdown-linter@0.17.7 --version
+npx --yes katana-markdown-linter@0.17.7 check README.md
+~~~
+
+## Basic Usage
+
+~~~bash
+kml check README.md
+kml check docs --config .markdownlint.json
+kml --locale ja help
+kml fix README.md
+~~~
+
+## Supported Platforms
+
+The npm launcher uses the same binary archives as the GitHub Release channel.
+It currently supports:
+
+- macOS arm64: `aarch64-apple-darwin`
+- macOS x64: `x86_64-apple-darwin`
+- Linux x64: `x86_64-unknown-linux-gnu`
+- Windows x64: `x86_64-pc-windows-msvc`
+
+Unsupported platforms fail before download with an explicit platform error.
+
+## Wrapper Contract
+
+- The package version selects the GitHub Release tag.
+- The launcher downloads `kml-vX.Y.Z-<target>.tar.gz` or
+  `kml-vX.Y.Z-<target>.zip`.
+- The launcher downloads the matching `.sha256` file and verifies the archive
+  before extraction.
+- The installed binary is cached under the package-local `vendor` directory by
+  default.
+
+For full CLI usage, rule coverage, and other install channels, see the
+[repository README](https://github.com/HiroyukiFuruno/katana-markdown-linter).
+Report package issues through
+[GitHub Issues](https://github.com/HiroyukiFuruno/katana-markdown-linter/issues).

package/bin/kml.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+const { spawnSync } = require("node:child_process");
+const { KmlInstaller } = require("../lib/installer");
+
+const installer = new KmlInstaller();
+const binaryPath = installer.ensureBinary();
+const result = spawnSync(binaryPath, process.argv.slice(2), { stdio: "inherit" });
+
+if (result.error) {
+  throw result.error;
+}
+
+process.exit(result.status === null ? 1 : result.status);

package/lib/installer.js

@@ -0,0 +1,112 @@
+const { execFileSync } = require("node:child_process");
+const { createHash } = require("node:crypto");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+
+class KmlInstaller {
+  constructor() {
+    this.packageRoot = path.resolve(__dirname, "..");
+    this.packageJson = require(path.join(this.packageRoot, "package.json"));
+    this.version = process.env.KML_WRAPPER_VERSION || `v${this.packageJson.version}`;
+    this.target = this.resolveTarget();
+    this.archiveName = this.resolveArchiveName();
+    this.installRoot = process.env.KML_WRAPPER_INSTALL_DIR || path.join(this.packageRoot, "vendor");
+  }
+
+  ensureBinary() {
+    const binaryPath = path.join(this.installRoot, this.version, this.target, "bin", this.binaryName());
+    if (fs.existsSync(binaryPath)) {
+      return binaryPath;
+    }
+    const workRoot = fs.mkdtempSync(path.join(os.tmpdir(), "kml-npm-wrapper-"));
+    const archivePath = this.prepareArchive(workRoot);
+    this.verifyChecksum(archivePath);
+    this.extractArchive(archivePath, workRoot);
+    const extractedBinary = this.findExtractedBinary(workRoot);
+    fs.mkdirSync(path.dirname(binaryPath), { recursive: true });
+    fs.copyFileSync(extractedBinary, binaryPath);
+    fs.chmodSync(binaryPath, 0o755);
+    return binaryPath;
+  }
+
+  prepareArchive(workRoot) {
+    const localDir = process.env.KML_WRAPPER_ARCHIVE_DIR;
+    if (localDir) {
+      return path.join(localDir, this.archiveName);
+    }
+    const archivePath = path.join(workRoot, this.archiveName);
+    this.download(this.archiveUrl(this.archiveName), archivePath);
+    this.download(this.archiveUrl(`${this.archiveName}.sha256`), `${archivePath}.sha256`);
+    return archivePath;
+  }
+
+  verifyChecksum(archivePath) {
+    const checksumPath = `${archivePath}.sha256`;
+    const expected = fs.readFileSync(checksumPath, "utf8").trim().split(/\s+/)[0];
+    const actual = createHash("sha256").update(fs.readFileSync(archivePath)).digest("hex");
+    if (actual !== expected) {
+      throw new Error(`Checksum mismatch for ${this.archiveName}`);
+    }
+  }
+
+  extractArchive(archivePath, workRoot) {
+    const extractRoot = path.join(workRoot, "extract");
+    fs.mkdirSync(extractRoot, { recursive: true });
+    execFileSync("tar", ["-xf", archivePath, "-C", extractRoot], { stdio: "inherit" });
+  }
+
+  findExtractedBinary(workRoot) {
+    const stack = [path.join(workRoot, "extract")];
+    while (stack.length > 0) {
+      const current = stack.pop();
+      for (const entry of fs.readdirSync(current, { withFileTypes: true })) {
+        const entryPath = path.join(current, entry.name);
+        if (entry.isDirectory()) {
+          stack.push(entryPath);
+        } else if (entry.name === this.binaryName()) {
+          return entryPath;
+        }
+      }
+    }
+    throw new Error(`Archive does not contain ${this.binaryName()}`);
+  }
+
+  download(url, outputPath) {
+    execFileSync("curl", ["-fsSL", url, "-o", outputPath], { stdio: "inherit" });
+  }
+
+  archiveUrl(name) {
+    const repo = "HiroyukiFuruno/katana-markdown-linter";
+    return `https://github.com/${repo}/releases/download/${this.version}/${name}`;
+  }
+
+  resolveArchiveName() {
+    const suffix = this.target.includes("windows") ? "zip" : "tar.gz";
+    return `kml-${this.version}-${this.target}.${suffix}`;
+  }
+
+  resolveTarget() {
+    const key = `${process.platform}/${process.arch}`;
+    const targets = {
+      "darwin/arm64": "aarch64-apple-darwin",
+      "darwin/x64": "x86_64-apple-darwin",
+      "linux/x64": "x86_64-unknown-linux-gnu",
+      "win32/x64": "x86_64-pc-windows-msvc"
+    };
+    if (!targets[key]) {
+      throw new Error(`Unsupported platform for kml wrapper: ${key}`);
+    }
+    return targets[key];
+  }
+
+  binaryName() {
+    return this.target.includes("windows") ? "kml.exe" : "kml";
+  }
+}
+
+module.exports = { KmlInstaller };
+
+if (require.main === module) {
+  new KmlInstaller().ensureBinary();
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "katana-markdown-linter",
+  "version": "0.17.7",
+  "description": "Thin npm launcher for the kml Markdown linter binary with localized CLI help.",
+  "keywords": [
+    "markdown",
+    "markdownlint",
+    "linter",
+    "kml",
+    "cli"
+  ],
+  "homepage": "https://github.com/HiroyukiFuruno/katana-markdown-linter#readme",
+  "bugs": {
+    "url": "https://github.com/HiroyukiFuruno/katana-markdown-linter/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HiroyukiFuruno/katana-markdown-linter.git"
+  },
+  "bin": {
+    "kml": "bin/kml.js"
+  },
+  "scripts": {
+    "postinstall": "node lib/installer.js"
+  },
+  "files": [
+    "README.md",
+    "bin",
+    "lib"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}