feat: pm-x generator

README.md

@@ -122,6 +122,37 @@ The `pm-install` generator generates commands for several JavaScript package man
 - `dev`: Install as a dev dependency. (defaults to `false`).
 - `auto`: Auto-detect package manager using [unjs/nypm](https://github.com/unjs/nypm#-nypm). (defaults to `true`).
 
+### `pm-x`
+
+The `pm-x` generator generates commands for running a package through JavaScript package managers.
+
+#### Usage
+
+    <!-- AUTOMD_START generator="pm-x" name="package-name" usage="[files] <flags>" -->
+    <!-- AUTOMD_END -->
+
+**Updated Result:**
+
+    <!-- AUTOMD_START generator="pm-x" name="package-name" usage="[files] <flags>" -->
+
+    ```sh
+    # npm
+    npx package-name@latest [files] <flags>
+
+    # pnpm
+    pnpm dlx package-name@latest [files] <flags>
+
+    # bun
+    bunx package-name@latest [files] <flags>
+    ```
+
+    <!-- AUTOMD_END -->
+
+#### Arguments
+
+- `name`: The package name (by default tries to read from the `name` field in `package.json`).
+- `usage`: An additional string appended at the end of each command suggesting usage. (defaults to `""`).
+
 ## Development
 
 - Clone this repository

playground/README.md

@@ -1,5 +1,20 @@
 ## Usage
 
+<!-- AUTOMD_START generator="pm-x" name="package-name" usage="[path]" -->
+
+```sh
+# npm
+npx package-name@latest [path]
+
+# pnpm
+pnpm dlx package-name@latest [path]
+
+# bun
+bunx package-name@latest [path]
+```
+
+<!-- AUTOMD_END -->
+
 <!-- AUTOMD_START generator="pm-install" name="package-name" dev="true" -->
 
 ```sh

src/generators/index.ts

@@ -1,8 +1,10 @@
 import { Generator } from "../generator";
 import jsdocs from "./jsdocs";
-import pmInstall from "./pm-install";
+import pmInstall from "./pm/install";
+import pmX from "./pm/x";
 
 export default {
   jsdocs,
   "pm-install": pmInstall,
+  "pm-x": pmX,
 } as Record<string, Generator>;

src/generators/pm/install.ts

@@ -0,0 +1,31 @@
+import { codeBlock } from "omark";
+import { defineGenerator } from "../../generator";
+import { INSTALL_COMMANDS, inferPackageName } from "./utils";
+
+export default defineGenerator({
+  name: "pm-install",
+  async generate({ options, args }) {
+    const name = args.name || (await inferPackageName(options.dir));
+
+    if (!name) {
+      return {
+        contents: "<!-- package name is unspecified -->",
+      };
+    }
+
+    // TODO: support noAuto/no-auto
+    if (args.auto ?? true) {
+      INSTALL_COMMANDS.unshift(["npx nypm", "i"]);
+    }
+
+    return {
+      contents: codeBlock(
+        INSTALL_COMMANDS.map(
+          ([cmd, install]) =>
+            `# ${cmd.includes("nypm") ? "✨ Auto-detect" : cmd}\n${cmd} ${install}${args.dev ? " -D" : ""} ${name}`,
+        ).join("\n\n"),
+        "sh",
+      ),
+    };
+  },
+});

src/generators/pm/utils.ts

@@ -0,0 +1,21 @@
+import { readPackageJSON } from "pkg-types";
+
+export async function inferPackageName(dir: string) {
+  const pkgName = await readPackageJSON(dir)
+    .then((pkg) => pkg?.name)
+    .catch(() => undefined);
+  return pkgName || process.env.npm_package_name;
+}
+
+export const INSTALL_COMMANDS = [
+  ["npm", "install"],
+  ["yarn", "add"],
+  ["pnpm", "install"],
+  ["bun", "install"],
+];
+
+export const RUN_COMMANDS = [
+  ["npm", "npx"],
+  ["pnpm", "pnpm dlx"],
+  ["bun", "bunx"],
+];

src/generators/pm/x.ts

@@ -0,0 +1,26 @@
+import { codeBlock } from "omark";
+import { defineGenerator } from "../../generator";
+import { RUN_COMMANDS, inferPackageName } from "./utils";
+
+export default defineGenerator({
+  name: "pm-x",
+  async generate({ options, args }) {
+    const name = args.name || (await inferPackageName(options.dir));
+
+    if (!name) {
+      return {
+        contents: "<!-- package name is unspecified -->",
+      };
+    }
+
+    return {
+      contents: codeBlock(
+        RUN_COMMANDS.map(
+          ([pm, cmd]) =>
+            `# ${pm}\n${cmd} ${name}@latest${args.usage ? ` ${args.usage}` : ""}`,
+        ).join("\n\n"),
+        "sh",
+      ),
+    };
+  },
+});