@zjaaal/artemis 0.1.1 → 0.1.2

package/README.md

@@ -336,6 +336,7 @@ Global flags may be typed before or after the command name: `art --json math add
 | `art <topic>` or `art <topic> help` | every command inside the topic                                          |
 | `art <command> --help`              | the command's arguments, flags, defaults, choices, aliases and examples |
 | `art help --json`                   | the manifest of every command, as data                                  |
+| `art help <topic> --json`           | the manifest narrowed to one topic: same shape, only its commands       |
 | `art help <command> --json`         | the manifest entry of one command                                       |
 
 ### The JSON contract

package/dist/help/help.d.ts

@@ -1,4 +1,4 @@
-import type { CommandHelpFn, CreateStyleFn, ManifestFn, RootHelpFn, TopicHelpFn, UsageFn } from '../models.js';
+import type { CommandHelpFn, CreateStyleFn, ManifestFn, TopicManifestFn, RootHelpFn, TopicHelpFn, UsageFn } from '../models.js';
 /** Color helpers; with `enabled` false they return the text untouched. */
 export declare const createStyle: CreateStyleFn;
 /** `art uve config set [url] [flags]` */
@@ -8,3 +8,8 @@ export declare const topicHelp: TopicHelpFn;
 export declare const commandHelp: CommandHelpFn;
 /** Everything help shows, as data: what an agent reads to know which commands exist and how to call them. */
 export declare const manifest: ManifestFn;
+/**
+ * The manifest of one topic: the topic and its sub-topics, and every command under it. It keeps the
+ * shape of the whole manifest, so a caller reads both the same way.
+ */
+export declare const topicManifest: TopicManifestFn;

package/dist/help/help.js

@@ -157,3 +157,13 @@ export const manifest = (bin, registry) => ({
     commands: [...registry.commands.values()].map((entry) => describeCommand(bin, entry)),
     globalFlags: describeFlags(GLOBAL_FLAGS)
 });
+const isWithin = (id, topicId) => id === topicId || id.startsWith(`${topicId} `);
+/**
+ * The manifest of one topic: the topic and its sub-topics, and every command under it. It keeps the
+ * shape of the whole manifest, so a caller reads both the same way.
+ */
+export const topicManifest = (everything, topicId) => ({
+    ...everything,
+    topics: everything.topics.filter((topic) => isWithin(topic.id, topicId)),
+    commands: everything.commands.filter((command) => isWithin(command.id, topicId))
+});

package/dist/models.d.ts

@@ -288,6 +288,8 @@ export type Manifest = {
     globalFlags: ManifestFlag[];
 };
 export type ManifestFn = (bin: string, registry: Registry) => Manifest;
+/** The manifest narrowed to one topic: the topic and its sub-topics, and every command under it. Same shape. */
+export type TopicManifestFn = (everything: Manifest, topicId: string) => Manifest;
 /** Where output goes. A node `Writable`, such as `process.stdout`, fits. */
 export type OutputSink = {
     write: (chunk: string) => unknown;

package/dist/run/run.js

@@ -2,7 +2,7 @@ import { createContext } from '../context/context.js';
 import { EXIT_CODE, FLAG_PREFIX, HELP_WORD, ID_SEPARATOR } from '../constants.js';
 import { discover } from '../discover/discover.js';
 import { CommandError, UsageError, isUsageError } from '../errors/errors.js';
-import { commandHelp, manifest, rootHelp, topicHelp, usage } from '../help/help.js';
+import { commandHelp, manifest, rootHelp, topicHelp, topicManifest, usage } from '../help/help.js';
 import { parse } from '../parse/parse.js';
 import { reportError } from './report.js';
 import { resolveWorld } from './world.js';
@@ -79,7 +79,10 @@ function helpFor(session, target) {
     const { bin, registry, style } = session;
     const everything = manifest(bin, registry);
     if (target.kind === 'topic') {
-        return { text: topicHelp(bin, registry, target.topic, style), data: everything };
+        return {
+            text: topicHelp(bin, registry, target.topic, style),
+            data: topicManifest(everything, target.topic.id)
+        };
     }
     return {
         text: commandHelp(bin, target.entry, style),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zjaaal/artemis",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Drop one file in a folder and get a CLI command. A command framework agents can write and read.",
   "type": "module",
   "packageManager": "pnpm@10.34.7",