feat(cli): allow overriding meta

Author: pi0

automd.config.ts

@@ -1,6 +1,7 @@
 import { glob } from "node:fs/promises";
 import * as md from "mdbox";
 import { fileURLToPath } from "node:url";
+import pkg from "./package.json" with { type: "json" };
 
 export default {
   input: ["README.md", "docs/**/*.md"],
@@ -10,7 +11,12 @@ export default {
         process.env.NO_COLOR = "1";
         const { usage } = await import("./src/cli/usage.ts");
         delete process.env.NO_COLOR;
-        const _usage = usage({ usage: { command: "srvx", docs: "", issues: "" } });
+        const _usage = usage({
+          meta: {
+            name: "srvx",
+            description: pkg.description,
+          },
+        });
         return {
           contents: md.codeBlock(_usage, "sh"),
         };

bin/srvx.mjs

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 import { main } from "../dist/cli.mjs";
+import pkg from "../package.json" with { type: "json" };
 
 await main({
+  meta: pkg,
   usage: {
     command: "srvx",
     docs: "https://srvx.h3.dev",

docs/1.guide/1.index.md

@@ -87,20 +87,20 @@ bun run server.mjs
 
 <!-- automd:examples -->
 
-| Example          | Source                                                                                     | Try                                                                  |
-| ---------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- |
-| `aws-lambda`     | [examples/aws-lambda](https://github.com/h3js/srvx/tree/main/examples/aws-lambda/)         | `npx giget gh:h3js/srvx/examples/aws-lambda srvx-aws-lambda`         |
-| `elysia`         | [examples/elysia](https://github.com/h3js/srvx/tree/main/examples/elysia/)                 | `npx giget gh:h3js/srvx/examples/elysia srvx-elysia`                 |
-| `express`        | [examples/express](https://github.com/h3js/srvx/tree/main/examples/express/)               | `npx giget gh:h3js/srvx/examples/express srvx-express`               |
-| `fastify`        | [examples/fastify](https://github.com/h3js/srvx/tree/main/examples/fastify/)               | `npx giget gh:h3js/srvx/examples/fastify srvx-fastify`               |
-| `h3`             | [examples/h3](https://github.com/h3js/srvx/tree/main/examples/h3/)                         | `npx giget gh:h3js/srvx/examples/h3 srvx-h3`                         |
-| `hello-world`    | [examples/hello-world](https://github.com/h3js/srvx/tree/main/examples/hello-world/)       | `npx giget gh:h3js/srvx/examples/hello-world srvx-hello-world`       |
-| `hono`           | [examples/hono](https://github.com/h3js/srvx/tree/main/examples/hono/)                     | `npx giget gh:h3js/srvx/examples/hono srvx-hono`                     |
-| `jsx`            | [examples/jsx](https://github.com/h3js/srvx/tree/main/examples/jsx/)                       | `npx giget gh:h3js/srvx/examples/jsx srvx-jsx`                       |
-| `node-handler`   | [examples/node-handler](https://github.com/h3js/srvx/tree/main/examples/node-handler/)     | `npx giget gh:h3js/srvx/examples/node-handler srvx-node-handler`     |
+| Example | Source | Try |
+| --- | --- | --- |
+| `aws-lambda` | [examples/aws-lambda](https://github.com/h3js/srvx/tree/main/examples/aws-lambda/) | `npx giget gh:h3js/srvx/examples/aws-lambda srvx-aws-lambda` |
+| `elysia` | [examples/elysia](https://github.com/h3js/srvx/tree/main/examples/elysia/) | `npx giget gh:h3js/srvx/examples/elysia srvx-elysia` |
+| `express` | [examples/express](https://github.com/h3js/srvx/tree/main/examples/express/) | `npx giget gh:h3js/srvx/examples/express srvx-express` |
+| `fastify` | [examples/fastify](https://github.com/h3js/srvx/tree/main/examples/fastify/) | `npx giget gh:h3js/srvx/examples/fastify srvx-fastify` |
+| `h3` | [examples/h3](https://github.com/h3js/srvx/tree/main/examples/h3/) | `npx giget gh:h3js/srvx/examples/h3 srvx-h3` |
+| `hello-world` | [examples/hello-world](https://github.com/h3js/srvx/tree/main/examples/hello-world/) | `npx giget gh:h3js/srvx/examples/hello-world srvx-hello-world` |
+| `hono` | [examples/hono](https://github.com/h3js/srvx/tree/main/examples/hono/) | `npx giget gh:h3js/srvx/examples/hono srvx-hono` |
+| `jsx` | [examples/jsx](https://github.com/h3js/srvx/tree/main/examples/jsx/) | `npx giget gh:h3js/srvx/examples/jsx srvx-jsx` |
+| `node-handler` | [examples/node-handler](https://github.com/h3js/srvx/tree/main/examples/node-handler/) | `npx giget gh:h3js/srvx/examples/node-handler srvx-node-handler` |
 | `service-worker` | [examples/service-worker](https://github.com/h3js/srvx/tree/main/examples/service-worker/) | `npx giget gh:h3js/srvx/examples/service-worker srvx-service-worker` |
-| `streaming`      | [examples/streaming](https://github.com/h3js/srvx/tree/main/examples/streaming/)           | `npx giget gh:h3js/srvx/examples/streaming srvx-streaming`           |
-| `tracing`        | [examples/tracing](https://github.com/h3js/srvx/tree/main/examples/tracing/)               | `npx giget gh:h3js/srvx/examples/tracing srvx-tracing`               |
-| `websocket`      | [examples/websocket](https://github.com/h3js/srvx/tree/main/examples/websocket/)           | `npx giget gh:h3js/srvx/examples/websocket srvx-websocket`           |
+| `streaming` | [examples/streaming](https://github.com/h3js/srvx/tree/main/examples/streaming/) | `npx giget gh:h3js/srvx/examples/streaming srvx-streaming` |
+| `tracing` | [examples/tracing](https://github.com/h3js/srvx/tree/main/examples/tracing/) | `npx giget gh:h3js/srvx/examples/tracing srvx-tracing` |
+| `websocket` | [examples/websocket](https://github.com/h3js/srvx/tree/main/examples/websocket/) | `npx giget gh:h3js/srvx/examples/websocket srvx-websocket` |
 
 <!-- /automd -->

docs/1.guide/9.cli.md

@@ -33,7 +33,7 @@ bunx --bun srvx
 <!-- automd:cliUsage -->
 
 ```sh
-srvx - Universal Server CLI
+srvx - Universal Server.
 
 SERVE MODE
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "srvx",
   "version": "0.11.0",
-  "description": "Universal Server API based on web platform standards. Works seamlessly with Deno, Bun and Node.js.",
+  "description": "Universal Server.",
   "homepage": "https://srvx.h3.dev",
   "license": "MIT",
   "repository": "h3js/srvx",

src/cli/main.ts

@@ -2,7 +2,6 @@ import { parseArgs as parseNodeArgs } from "node:util";
 import { fileURLToPath } from "node:url";
 import { fork } from "node:child_process";
 import { existsSync, statSync } from "node:fs";
-import pkg from "../../package.json" with { type: "json" };
 import * as c from "./_utils.ts";
 import type { CLIOptions, MainOptions } from "./types.ts";
 import { cliServe, NO_ENTRY_ERROR } from "./serve.ts";
@@ -15,7 +14,7 @@ export async function main(mainOpts: MainOptions): Promise<void> {
 
   // Handle version flag
   if (cliOpts.version) {
-    console.log(`srvx ${pkg.version}\n${runtime()}`);
+    process.stdout.write(versions(mainOpts).join("\n") + "\n");
     process.exit(0);
   }
   // Handle help flag
@@ -26,7 +25,7 @@ export async function main(mainOpts: MainOptions): Promise<void> {
 
   // Running in a child process
   if (process.send) {
-    console.log(c.gray(`srvx ${pkg.version} - ${runtime()}`));
+    console.log(c.gray(versions(mainOpts).join(" · ")));
     setupProcessErrorHandlers();
     await cliServe(cliOpts);
     return;
@@ -193,6 +192,15 @@ function setupProcessErrorHandlers() {
   });
 }
 
+function versions(mainOpts: MainOptions): string[] {
+  const versions: string[] = [];
+  if (mainOpts.meta?.name) {
+    versions.push(`${mainOpts.meta.name} ${mainOpts.meta.version || ""}`.trim());
+  }
+  versions.push(runtime());
+  return versions;
+}
+
 function runtime(): string {
   if (process.versions.bun) {
     return `bun ${process.versions.bun}`;

src/cli/types.ts

@@ -6,6 +6,11 @@ declare global {
 
 export type MainOptions = CLIOptions & {
   args?: string[];
+  meta?: {
+    name?: string;
+    version?: string;
+    description?: string;
+  };
   usage?: {
     command?: string;
     docs?: string;

src/cli/usage.ts

@@ -3,8 +3,13 @@ import type { MainOptions } from "./types.ts";
 
 export function usage(mainOpts: MainOptions): string {
   const command = mainOpts.usage?.command || "srvx";
+
+  const name = mainOpts.meta?.name || command;
+  const ver = mainOpts.meta?.version || "";
+  const desc = mainOpts.meta?.description;
+
   return `
-${c.cyan(command)} - Universal Server CLI
+${c.cyan(name)}${c.gray(`${ver ? ` ${ver}` : ""} ${desc ? `- ${desc}` : ""}`)}
 
 ${c.bold("SERVE MODE")}