mdat-plugin-cli-help 1.0.1 → 1.0.3

package/dist/index.js

@@ -3395,7 +3395,6 @@ ZodNaN.create = (params) => {
 		...processCreateParams(params)
 	});
 };
-const BRAND = Symbol("zod_brand");
 var ZodBranded = class extends ZodType {
 	_parse(input) {
 		const { ctx } = this._processInputParams(input);
@@ -15175,7 +15174,7 @@ var CliHelpToObjectVisitor = class extends parser.getBaseCstVisitorConstructor()
 		return context.map((entry) => clean ? this.clean(entry.image) : entry.image).join(" ");
 	}
 	positionalParentCommandToArguments(object) {
-		const { arguments: theArguments, parentCommandName,...rest } = object;
+		const { arguments: theArguments, parentCommandName, ...rest } = object;
 		if (parentCommandName === void 0) return object;
 		return {
 			arguments: [parentCommandName, ...theArguments ?? []],
@@ -15322,13 +15321,21 @@ async function getPackageJson() {
 	const { packageFile } = await loadConfig();
 	if (packageFile === void 0) throw new Error("No packageFile found or set in config");
 	packageJson ??= await readPackage({ cwd: path.dirname(packageFile) });
-	return packageJson;
+	return {
+		packageJson,
+		packagePath: packageFile
+	};
 }
 
 //#endregion
 //#region src/utilities/is-executable.ts
+/**
+* This file is vendored with modification from https://github.com/sindresorhus/is-executable
+* to work around a "[DEP0176] DeprecationWarning: fs.X_OK is deprecated, use fs.constants.X_OK instead"
+* error from Node.
+*/
 const isWindows = process.platform === "win32";
-const pathExtensions = isWindows ? new Set(process.env.PATHEXT?.split(";").map((extension) => extension.toLowerCase()) ?? []) : /* @__PURE__ */ new Set();
+const pathExtensions = isWindows ? new Set(process.env.PATHEXT?.split(";").map((extension) => extension.toLowerCase())) : /* @__PURE__ */ new Set();
 /**
 * Check if a file is executable (async).
 */
@@ -15354,9 +15361,10 @@ async function inferCommand(cliCommand) {
 	return ensureExecutable(cliCommand);
 }
 async function getFirstBinFromPackage() {
-	const packageJson$1 = await getPackageJson();
+	const { packageJson: packageJson$1, packagePath } = await getPackageJson();
+	const packageDirectory = path.dirname(packagePath);
 	if (packageJson$1.bin) {
-		const binPath = typeof packageJson$1.bin === "string" ? packageJson$1.bin : String(Object.values(packageJson$1.bin).at(0));
+		const binPath = typeof packageJson$1.bin === "string" ? path.resolve(packageDirectory, packageJson$1.bin) : path.resolve(packageDirectory, String(Object.values(packageJson$1.bin).at(0)));
 		if (looksLikePath(binPath)) {
 			log.info(`Inferred <!-- cli-help --> command to run from package.json: ${binPath}`);
 			return binPath;
@@ -15368,14 +15376,18 @@ function looksLikePath(maybePath) {
 	const parsed = path.parse(maybePath);
 	return parsed.root !== "" || parsed.dir !== "";
 }
-async function ensureExecutable(path$1) {
-	let resolvedPath = await which(path$1, { nothrow: true }) ?? void 0;
-	resolvedPath ??= await getCommandPathFromPackage(path$1) ?? void 0;
+async function ensureExecutable(filePath) {
+	let resolvedPath = path.isAbsolute(filePath) ? filePath : await which(filePath, { nothrow: true }) ?? void 0;
+	resolvedPath ??= await getCommandPathFromPackage(filePath) ?? void 0;
 	if (resolvedPath !== void 0 && await isExecutable(resolvedPath)) return resolvedPath;
 	throw new Error(`The cli-help rule noticed that "${resolvedPath}" is not executable.`);
 }
 async function getCommandPathFromPackage(commandName) {
-	return (await getPackageJson()).bin?.[commandName] ?? void 0;
+	const { packageJson: packageJson$1 } = await getPackageJson();
+	for (const [key, value] of Object.entries(packageJson$1.bin ?? {})) {
+		if (key === commandName) return value;
+		if (path.normalize(value) === path.normalize(commandName)) return value;
+	}
 }
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mdat-plugin-cli-help",
-  "version": "1.0.1",
-  "description": "Mdat plugin to generate tabular CLI tool documentation in Markdown files.",
+  "version": "1.0.3",
+  "description": "Mdat plugin to generate tabular help documentation for CLI tools in Markdown files.",
   "keywords": [
     "markdown",
     "mdat-plugin",
@@ -35,20 +35,22 @@
   ],
   "dependencies": {
     "@types/which": "^3.0.4",
-    "execa": "^9.6.0",
-    "read-pkg": "^9.0.1",
-    "type-fest": "^5.2.0",
-    "which": "^5.0.0"
+    "execa": "^9.6.1",
+    "read-pkg": "^10.0.0",
+    "type-fest": "^5.3.0",
+    "which": "^6.0.0"
   },
   "devDependencies": {
-    "@kitschpatrol/shared-config": "^5.7.4",
-    "@types/node": "^20.19.24",
-    "bumpp": "^10.3.1",
+    "@kitschpatrol/shared-config": "^5.10.0",
+    "@types/node": "^20.19.25",
+    "bumpp": "^10.3.2",
     "chevrotain": "^11.0.3",
+    "mdat": "^1.3.2",
     "meow": "^14.0.0",
-    "tsdown": "^0.15.12",
+    "remark-mdat": "^1.2.0",
+    "tsdown": "^0.17.0",
     "typescript": "~5.9.3",
-    "vitest": "^4.0.6",
+    "vitest": "^4.0.15",
     "zod": "^3.25.76"
   },
   "peerDependencies": {
@@ -58,11 +60,8 @@
   "engines": {
     "node": ">=20.19.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
-    "build": "tsdown --tsconfig tsconfig.build.json",
+    "build": "tsdown --no-fixed-extension --tsconfig tsconfig.build.json",
     "clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
     "fix": "ksc fix",
     "lint": "ksc lint",

package/readme.md

@@ -15,7 +15,7 @@
 
 <!-- short-description -->
 
-**Mdat plugin to generate tabular CLI tool documentation in Markdown files.**
+**Mdat plugin to generate tabular help documentation for CLI tools in Markdown files.**
 
 <!-- /short-description -->