vimcord 2.0.4 → 2.0.5

package/README.md

@@ -65,6 +65,28 @@ await client.login();
 
 `login()` uses `TOKEN`, or `TOKEN_DEV` when `client.$devMode` is true.
 
+### Process CLI
+
+Call `setupCLI()` once to enable promptless slash commands through the process stdin. This works in a local terminal and in hosting dashboards that provide a console command field.
+
+```ts
+import { GatewayIntentBits } from "discord.js";
+import { setupCLI, Vimcord } from "vimcord";
+
+setupCLI({
+    loaders: "auto" // "auto" | "always" | "never"
+});
+
+const client = new Vimcord({
+    customId: "main",
+    client: {
+        intents: [GatewayIntentBits.Guilds]
+    }
+});
+```
+
+Clients participate by default once the process CLI is initialized. Set `globals.app.enableCLI` to `false` on clients that should remain unavailable to CLI commands. Enter `/help` in the process console to view commands.
+
 ### Modules And Command Dispatch
 
 ```ts
@@ -203,9 +225,9 @@ Command-local hooks override `client.globals.hooks`, and `client.globals.hooks`
 ### BetterEmbed
 
 ```ts
-import { BetterEmbed, defineGlobalToolConfig } from "vimcord";
+import { BetterEmbed, defineGlobalUxConfig } from "vimcord";
 
-defineGlobalToolConfig({
+defineGlobalUxConfig({
     embedColor: "#5865F2",
     embedColorDev: "#FF9D00"
 });
@@ -213,7 +235,7 @@ defineGlobalToolConfig({
 const embed = new BetterEmbed({
     context: { interaction },
     title: "Welcome, $USER_NAME",
-    description: ["Your avatar: $USER_AVATAR", "Today is $MONTH/$DAY/$YEAR"],
+    description: [showAvatar && "Your avatar: $USER_AVATAR", "", "Today is $MONTH/$DAY/$YEAR"],
     timestamp: true
 });
 
@@ -250,7 +272,8 @@ const intro = new BetterContainer().addText("## Help").addText("Choose a page be
 const moderation = new BetterContainer().addText("## Moderation").addText("Ban, kick, and timeout commands.");
 
 const paginator = new Paginator({
-    type: PaginationType.LongJump,
+    type: PaginationType.LongSkip,
+    skipSize: 5,
     idle: 60_000,
     onTimeout: PaginationTimeout.DisableComponents
 });
@@ -279,7 +302,9 @@ const result = await promptMessage(interaction, {
     }),
     participants: [interaction.user],
     timeout: 30_000,
-    onResolve: [ResolveAction.DisableComponents],
+    onConfirm: ResolveAction.DisableComponents,
+    onReject: ResolveAction.DisableComponents,
+    onTimeout: ResolveAction.DeleteMessage,
     highlightSelectedButton: true
 });
 
@@ -306,12 +331,19 @@ const modal = new BetterModal({ title: "Create Ticket" })
         label: "Description",
         style: TextInputStyle.Paragraph,
         required: false
+    })
+    .addUserSelect({
+        customId: "assignees",
+        label: "Assignees",
+        maxValues: 3,
+        required: false
     });
 
 const result = await modal.showAndAwait(interaction, { timeout: 60_000 });
 if (!result) return;
 
 const subject = result.getField<string>("subject", true);
+const assignees = result.getField("assignees", "getSelectedUsers");
 
 await result.reply({
     content: `Ticket created: ${subject}`,
@@ -370,10 +402,11 @@ Users.use(SoftDeletePlugin);
 
 ```ts
 client.logger.success("Startup complete");
+client.logger.debug("Only shown when verbose mode is enabled");
 
-const stopLoader = client.logger.loader("Syncing commands...");
+const loader = client.logger.loader("Syncing commands...");
 await client.modules.commands.push();
-stopLoader("Commands synced");
+loader.succeed("Commands synced");
 ```
 
 ---
@@ -396,8 +429,10 @@ stopLoader("Commands synced");
 | `BetterModal` | Modal helper with V2 component support |
 | `promptMessage`, `promptModal` | Confirmation prompt helpers |
 | `dynaSend` | Send helper for interactions, channels, messages, members, and users |
-| `defineGlobalToolConfig` | Global UX defaults for embeds, collectors, paginator, and prompts |
+| `defineGlobalUxConfig` | Global UX defaults for embeds, collectors, paginator, and prompts |
 | `defineGlobalCommandHooks` | Global command hooks used when modules do not define local hooks |
+| `setupCLI` | Initializes the process-wide stdin CLI and its client targets |
+| `CLILogger` | CLI-specific logger with target headers, groups, tables, styles, and loaders |
 
 ### Client Options
 
@@ -411,7 +446,7 @@ const client = new Vimcord({
         app: {
             name: "My Bot",
             devMode: false,
-            verbose: false,
+            enableCLI: true,
             disableBanner: false
         },
         staff: {
@@ -426,7 +461,6 @@ const client = new Vimcord({
         maxFailures: 2,
         maxRefreshAttempts: 3
     },
-    logLevel: "debug",
     verbose: false
 });
 ```
@@ -465,32 +499,70 @@ client.configure({
 });
 ```
 
+### Plugin CLI And Health Contributions
+
+Plugin install hooks receive a typed context. Contributions remain scoped to that client and are removed automatically when the plugin unloads.
+
+```ts
+import type { VimcordPluginContext } from "vimcord";
+import { VimcordPlugin } from "vimcord";
+
+class ServicePlugin extends VimcordPlugin {
+    override name = "service";
+    override description = "Example service integration";
+    override version = "1.0.0";
+
+    constructor(private readonly service: { ping(): Promise<void> }) {
+        super();
+    }
+
+    override install({ cli, health }: VimcordPluginContext) {
+        cli.registerCommand({
+            name: "service-info",
+            description: "Displays service information.",
+            execute: ({ logger, client }) => logger.header("Service Info", client)
+        });
+
+        health.register({
+            id: "service",
+            label: "Service API",
+            check: async () => {
+                const startedAt = performance.now();
+                await this.service.ping();
+                return { status: "healthy", latencyMs: performance.now() - startedAt };
+            }
+        });
+    }
+
+    override uninstall() {}
+}
+```
+
 ---
 
 ## Examples
 
 ### Status Rotation
 
-Status config is user-owned. Vimcord does not provide a default status rotation.
+Status config is user-owned. Vimcord does not provide a default status rotation, and a single profile applies in both
+development and production.
 
 ```ts
 import { ActivityType } from "discord.js";
 
 await client.status.set({
-    production: {
-        interval: 30_000,
-        randomize: true,
-        activity: [
-            { name: "$GUILD_COUNT servers", type: ActivityType.Watching, status: "online" },
-            { name: "Need help? Use /help", type: ActivityType.Custom, status: "online" }
-        ]
-    },
-    development: {
-        activity: { name: "In development", type: ActivityType.Custom, status: "dnd" }
-    }
+    interval: 30_000,
+    randomize: true,
+    activity: [
+        { name: "$GUILD_COUNT servers", type: ActivityType.Watching, status: "online" },
+        { name: "Need help? Use /help", type: ActivityType.Custom, status: "online" }
+    ]
 });
 ```
 
+Pass `production` and/or `development` profiles when their statuses differ. An omitted profile leaves that environment's
+status blank; profiles do not fall back across environments.
+
 ### Command Dispatch Events
 
 ```ts
@@ -547,8 +619,6 @@ MONGO_URI_DEV=mongodb://localhost:27017/discord-bot-dev
 
 Created by [**xsqu1znt**](https://github.com/xsqu1znt) with a simple goal: make Discord bot development enjoyable again.
 
-Built on top of [qznt](https://github.com/xsqu1znt/qznt) for that extra bit of utility magic.
-
 **License:** MIT
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vimcord",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "A powerful and opinionated Discord.js wrapper.",
   "author": "xsqu1znt",
   "license": "MIT",
@@ -16,7 +16,7 @@
   },
   "type": "module",
   "dependencies": {
-    "@vimcord/core": "0.1.4"
+    "@vimcord/core": "0.1.5"
   },
   "scripts": {
     "build": "tsup",