zinkee 0.1.15 → 0.1.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zinkee",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "description": "CLI for Zinkee API v2",
   "type": "module",
   "bin": {

package/src/cli-examples.ts

@@ -18,11 +18,6 @@ export interface ExampleRequest {
   filters: {
     type?: string;
   };
-  overrides: {
-    profile?: string;
-    baseUrl?: string;
-    apiKey?: string;
-  };
   json: boolean;
 }
 
@@ -48,46 +43,6 @@ function extractExampleFilters(tokens: readonly string[]): { type?: string } {
   return filters;
 }
 
-function extractExampleOverrides(tokens: readonly string[]): {
-  profile?: string;
-  baseUrl?: string;
-  apiKey?: string;
-} {
-  const overrides: {
-    profile?: string;
-    baseUrl?: string;
-    apiKey?: string;
-  } = {};
-
-  for (let index = 0; index < tokens.length; index += 1) {
-    const token = tokens[index];
-    const value = tokens[index + 1];
-
-    if (!value || value.startsWith("-")) {
-      continue;
-    }
-
-    if (token === "--profile") {
-      overrides.profile = value;
-      index += 1;
-      continue;
-    }
-
-    if (token === "--base-url") {
-      overrides.baseUrl = value;
-      index += 1;
-      continue;
-    }
-
-    if (token === "--api-key") {
-      overrides.apiKey = value;
-      index += 1;
-    }
-  }
-
-  return overrides;
-}
-
 export function extractExampleRequest(
   argv: readonly string[],
   optionMeta: OptionMetadata = createDefaultOptionMetadata(),
@@ -109,27 +64,17 @@ export function extractExampleRequest(
   return {
     commandName: cmdPath.commandName,
     filters: extractExampleFilters(remainingTokens),
-    overrides: extractExampleOverrides(argv),
     json: argv.includes("--json"),
   };
 }
 
-export async function showExamples(
+export function showExamples(
   commandName: string,
   json: boolean,
   stdout?: CommandIo,
   filters: { type?: string } = {},
-  options: {
-    enabled?: boolean;
-    configPath?: string;
-    overrides?: {
-      profile?: string;
-      baseUrl?: string;
-      apiKey?: string;
-    };
-  } = {},
-): Promise<void> {
-  const examples = await getResolvedCommandExamples(commandName, filters, options);
+): void {
+  const examples = getResolvedCommandExamples(commandName, filters);
 
   if (examples.length === 0) {
     throw new CliError("invalid_cli_usage", `No examples registered for "${commandName}".`);

package/src/cli-runner.ts

@@ -65,15 +65,11 @@ export async function runCli(argv: string[]): Promise<void> {
     const exampleRequest = extractExampleRequest(argv, optionMeta);
 
     if (exampleRequest) {
-      await showExamples(
+      showExamples(
         exampleRequest.commandName,
         exampleRequest.json,
         undefined,
         exampleRequest.filters,
-        {
-          enabled: true,
-          overrides: exampleRequest.overrides,
-        },
       );
       throw new ExampleDisplayed();
     }

package/src/index.test.ts

@@ -37,7 +37,6 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "records query",
       filters: {},
-      overrides: {},
       json: true,
     });
   });
@@ -62,9 +61,6 @@ describe("project bootstrap", () => {
       filters: {
         type: "option",
       },
-      overrides: {
-        profile: "local",
-      },
       json: false,
     });
   });
@@ -75,7 +71,6 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "schemas list",
       filters: {},
-      overrides: {},
       json: false,
     });
   });
@@ -96,12 +91,11 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "schemas fields create",
       filters: { type: "option" },
-      overrides: {},
       json: false,
     });
   });
 
-  it("extracts example overrides regardless of --example position", () => {
+  it("extracts example requests regardless of --example position", () => {
     expect(
       extractExampleRequest([
         "node",
@@ -116,7 +110,6 @@ describe("project bootstrap", () => {
     ).toEqual({
       commandName: "schemas list",
       filters: {},
-      overrides: { profile: "staging" },
       json: true,
     });
   });

package/src/utils/examples.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, it } from "vitest";
 
-import { getCommandExamples } from "./examples.js";
+import { commandRegistry } from "../command-registry.js";
+import { getCommandExamples, getResolvedCommandExamples } from "./examples.js";
 
 describe("getCommandExamples", () => {
   it("returns registered examples for complex commands", () => {
@@ -250,4 +251,24 @@ describe("getCommandExamples", () => {
     expect(getCommandExamples("config show")[0]?.response).toContain('"defaultProfile": "prod"');
     expect(getCommandExamples("config validate")[0]?.response).toContain('"valid": true');
   });
+
+  it.each(Object.keys(commandRegistry))(
+    "returns at least one example for %s",
+    (commandName) => {
+      const examples = getCommandExamples(commandName);
+      expect(examples.length, `${commandName} has no examples`).toBeGreaterThan(0);
+      for (const example of examples) {
+        expect(example.command, `${commandName} example missing command`).toBeTruthy();
+        expect(example.description, `${commandName} example missing description`).toBeTruthy();
+      }
+    },
+  );
+
+  it("getResolvedCommandExamples is synchronous and matches getCommandExamples", () => {
+    for (const commandName of Object.keys(commandRegistry)) {
+      const resolved = getResolvedCommandExamples(commandName);
+      expect(resolved, `${commandName} resolved must not be a thenable`).not.toHaveProperty("then");
+      expect(resolved).toEqual(getCommandExamples(commandName));
+    }
+  });
 });