bet-cli 0.1.3 → 0.1.4

package/dist/index.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import { Command } from "commander";
+import { GroupedHelp } from "./lib/help.js";
 import { registerUpdate } from "./commands/update.js";
 import { registerList } from "./commands/list.js";
 import { registerSearch } from "./commands/search.js";
@@ -10,10 +11,13 @@ import { registerShell } from "./commands/shell.js";
 import { registerCompletion } from "./commands/completion.js";
 import { registerIgnore } from "./commands/ignore.js";
 const program = new Command();
+program.createHelp = function createHelp() {
+    return Object.assign(new GroupedHelp(), this.configureHelp());
+};
 program
     .name("bet")
     .description("Explore and jump between local projects.")
-    .version("0.1.2");
+    .version("0.1.3");
 registerUpdate(program);
 registerList(program);
 registerSearch(program);

package/dist/lib/help.js

@@ -0,0 +1,81 @@
+import { Help } from "commander";
+const GROUP_1 = ["list", "search", "info", "go", "path"];
+const GROUP_2 = ["shell", "completion"];
+const GROUP_3 = ["update", "ignore", "help"];
+const GROUPS = [
+    { heading: "Projects", names: GROUP_1 },
+    { heading: "Shell integration", names: GROUP_2 },
+    { heading: "Index & config", names: GROUP_3 },
+];
+function getGroupIndex(cmdName) {
+    for (let i = 0; i < GROUPS.length; i++) {
+        if (GROUPS[i].names.includes(cmdName))
+            return i;
+    }
+    return GROUPS.length; // unlisted commands go last
+}
+/**
+ * Custom Help that renders top-level commands in three groups with headings.
+ */
+export class GroupedHelp extends Help {
+    formatHelp(cmd, helper) {
+        const termWidth = helper.padWidth(cmd, helper);
+        const helpWidth = helper.helpWidth ?? 80;
+        const itemIndentWidth = 2;
+        const itemSeparatorWidth = 2;
+        const formatItem = (term, description) => {
+            if (description) {
+                const fullText = `${term.padEnd(termWidth + itemSeparatorWidth)}${description}`;
+                return helper.wrap(fullText, helpWidth - itemIndentWidth, termWidth + itemSeparatorWidth);
+            }
+            return term;
+        };
+        const formatList = (textArray) => textArray.join("\n").replace(/^/gm, " ".repeat(itemIndentWidth));
+        const output = [];
+        // Usage
+        output.push(`Usage: ${helper.commandUsage(cmd)}`, "");
+        // Description
+        const commandDescription = helper.commandDescription(cmd);
+        if (commandDescription.length > 0) {
+            output.push(helper.wrap(commandDescription, helpWidth, 0), "");
+        }
+        // Arguments
+        const argumentList = helper.visibleArguments(cmd).map((argument) => formatItem(helper.argumentTerm(argument), helper.argumentDescription(argument)));
+        if (argumentList.length > 0) {
+            output.push("Arguments:", formatList(argumentList), "");
+        }
+        // Options
+        const optionList = helper.visibleOptions(cmd).map((option) => formatItem(helper.optionTerm(option), helper.optionDescription(option)));
+        if (optionList.length > 0) {
+            output.push("Options:", formatList(optionList), "");
+        }
+        if (this.showGlobalOptions) {
+            const globalOptionList = helper
+                .visibleGlobalOptions(cmd)
+                .map((option) => formatItem(helper.optionTerm(option), helper.optionDescription(option)));
+            if (globalOptionList.length > 0) {
+                output.push("Global Options:", formatList(globalOptionList), "");
+            }
+        }
+        // Commands (grouped)
+        const visibleCommands = helper.visibleCommands(cmd);
+        if (visibleCommands.length > 0) {
+            const byGroup = new Map();
+            for (const sub of visibleCommands) {
+                const name = sub.name();
+                const idx = getGroupIndex(name);
+                const list = byGroup.get(idx) ?? [];
+                list.push(sub);
+                byGroup.set(idx, list);
+            }
+            const groupIndices = [...byGroup.keys()].sort((a, b) => a - b);
+            for (const idx of groupIndices) {
+                const commands = byGroup.get(idx);
+                const heading = idx < GROUPS.length ? GROUPS[idx].heading : "Commands";
+                const commandList = commands.map((sub) => formatItem(helper.subcommandTerm(sub), helper.subcommandDescription(sub)));
+                output.push(`${heading}:`, formatList(commandList), "");
+            }
+        }
+        return output.join("\n");
+    }
+}

package/dist/lib/ignore.js

@@ -1,14 +1,50 @@
 import { isSubpath } from "../utils/paths.js";
 export const DEFAULT_IGNORES = [
+    // JS/TS/Node
     "**/node_modules/**",
     "**/.git/**",
     "**/dist/**",
     "**/build/**",
     "**/.next/**",
+    // Rust, Scala, Java (Maven)
     "**/target/**",
+    // PHP, Ruby, Go
     "**/vendor/**",
+    // Python
     "**/.venv/**",
     "**/venv/**",
+    "**/__pycache__/**",
+    "**/.mypy_cache/**",
+    "**/.pytest_cache/**",
+    "**/.eggs/**",
+    "**/*.egg-info/**",
+    "**/*.egg",
+    // Ruby
+    "**/.bundle/**",
+    "**/vendor/bundle/**",
+    // PHP (Symfony, Laravel cache/log)
+    "**/var/cache/**",
+    "**/var/log/**",
+    // Java/Kotlin (Gradle, IntelliJ output)
+    "**/.gradle/**",
+    "**/out/**",
+    // Elixir
+    "**/deps/**",
+    "**/_build/**",
+    // Swift
+    "**/.build/**",
+    "**/DerivedData/**",
+    // Dart/Flutter
+    "**/.dart_tool/**",
+    "**/.packages",
+    // C# / .NET
+    "**/obj/**",
+    // Haskell
+    "**/.stack-work/**",
+    "**/.cabal-sandbox/**",
+    // Scala (Metals)
+    "**/.metals/**",
+    "**/.bloop/**",
 ];
 export function getEffectiveIgnores(config) {
     return config.ignores !== undefined ? config.ignores : DEFAULT_IGNORES;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bet-cli",
   "description": "Explore and jump between local projects.",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "author": "Chris Mckenzie",
   "license": "Apache-2.0",
   "repository": {

package/src/index.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import { Command } from "commander";
+import { GroupedHelp } from "./lib/help.js";
 import { registerUpdate } from "./commands/update.js";
 import { registerList } from "./commands/list.js";
 import { registerSearch } from "./commands/search.js";
@@ -12,10 +13,14 @@ import { registerIgnore } from "./commands/ignore.js";
 
 const program = new Command();
 
+program.createHelp = function createHelp(this: Command) {
+  return Object.assign(new GroupedHelp(), this.configureHelp());
+};
+
 program
   .name("bet")
   .description("Explore and jump between local projects.")
-  .version("0.1.3");
+  .version("0.1.4");
 
 registerUpdate(program);
 registerList(program);

package/src/lib/help.ts

@@ -0,0 +1,122 @@
+import { Help } from "commander";
+import type { Command } from "commander";
+
+const GROUP_1: string[] = ["list", "search", "info", "go", "path"];
+const GROUP_2: string[] = ["shell", "completion"];
+const GROUP_3: string[] = ["update", "ignore", "help"];
+
+const GROUPS: { heading: string; names: string[] }[] = [
+  { heading: "Projects", names: GROUP_1 },
+  { heading: "Shell integration", names: GROUP_2 },
+  { heading: "Index & config", names: GROUP_3 },
+];
+
+function getGroupIndex(cmdName: string): number {
+  for (let i = 0; i < GROUPS.length; i++) {
+    if (GROUPS[i].names.includes(cmdName)) return i;
+  }
+  return GROUPS.length; // unlisted commands go last
+}
+
+/**
+ * Custom Help that renders top-level commands in three groups with headings.
+ */
+export class GroupedHelp extends Help {
+  override formatHelp(cmd: Command, helper: Help): string {
+    const termWidth = helper.padWidth(cmd, helper);
+    const helpWidth = helper.helpWidth ?? 80;
+    const itemIndentWidth = 2;
+    const itemSeparatorWidth = 2;
+
+    const formatItem = (term: string, description: string): string => {
+      if (description) {
+        const fullText = `${term.padEnd(termWidth + itemSeparatorWidth)}${description}`;
+        return helper.wrap(
+          fullText,
+          helpWidth - itemIndentWidth,
+          termWidth + itemSeparatorWidth,
+        );
+      }
+      return term;
+    };
+
+    const formatList = (textArray: string[]): string =>
+      textArray.join("\n").replace(/^/gm, " ".repeat(itemIndentWidth));
+
+    const output: string[] = [];
+
+    // Usage
+    output.push(`Usage: ${helper.commandUsage(cmd)}`, "");
+
+    // Description
+    const commandDescription = helper.commandDescription(cmd);
+    if (commandDescription.length > 0) {
+      output.push(helper.wrap(commandDescription, helpWidth, 0), "");
+    }
+
+    // Arguments
+    const argumentList = helper.visibleArguments(cmd).map((argument) =>
+      formatItem(
+        helper.argumentTerm(argument),
+        helper.argumentDescription(argument),
+      ),
+    );
+    if (argumentList.length > 0) {
+      output.push("Arguments:", formatList(argumentList), "");
+    }
+
+    // Options
+    const optionList = helper.visibleOptions(cmd).map((option) =>
+      formatItem(
+        helper.optionTerm(option),
+        helper.optionDescription(option),
+      ),
+    );
+    if (optionList.length > 0) {
+      output.push("Options:", formatList(optionList), "");
+    }
+
+    if (this.showGlobalOptions) {
+      const globalOptionList = helper
+        .visibleGlobalOptions(cmd)
+        .map((option) =>
+          formatItem(
+            helper.optionTerm(option),
+            helper.optionDescription(option),
+          ),
+        );
+      if (globalOptionList.length > 0) {
+        output.push("Global Options:", formatList(globalOptionList), "");
+      }
+    }
+
+    // Commands (grouped)
+    const visibleCommands = helper.visibleCommands(cmd);
+    if (visibleCommands.length > 0) {
+      const byGroup = new Map<number, Command[]>();
+      for (const sub of visibleCommands) {
+        const name = sub.name();
+        const idx = getGroupIndex(name);
+        const list = byGroup.get(idx) ?? [];
+        list.push(sub);
+        byGroup.set(idx, list);
+      }
+
+      const groupIndices = [...byGroup.keys()].sort((a, b) => a - b);
+      for (const idx of groupIndices) {
+        const commands = byGroup.get(idx)!;
+        const heading =
+          idx < GROUPS.length ? GROUPS[idx].heading : "Commands";
+        const commandList = commands.map((sub) =>
+          formatItem(
+            helper.subcommandTerm(sub),
+            helper.subcommandDescription(sub),
+          ),
+        );
+        output.push(`${heading}:`, formatList(commandList), "");
+      }
+    }
+
+    return output.join("\n");
+  }
+}

package/src/lib/ignore.ts

@@ -1,22 +1,61 @@
 import { isSubpath } from "../utils/paths.js";
 
 export const DEFAULT_IGNORES = [
+  // JS/TS/Node
   "**/node_modules/**",
   "**/.git/**",
   "**/dist/**",
   "**/build/**",
   "**/.next/**",
+  // Rust, Scala, Java (Maven)
   "**/target/**",
+  // PHP, Ruby, Go
   "**/vendor/**",
+  // Python
   "**/.venv/**",
   "**/venv/**",
+  "**/__pycache__/**",
+  "**/.mypy_cache/**",
+  "**/.pytest_cache/**",
+  "**/.eggs/**",
+  "**/*.egg-info/**",
+  "**/*.egg",
+  // Ruby
+  "**/.bundle/**",
+  "**/vendor/bundle/**",
+  // PHP (Symfony, Laravel cache/log)
+  "**/var/cache/**",
+  "**/var/log/**",
+  // Java/Kotlin (Gradle, IntelliJ output)
+  "**/.gradle/**",
+  "**/out/**",
+  // Elixir
+  "**/deps/**",
+  "**/_build/**",
+  // Swift
+  "**/.build/**",
+  "**/DerivedData/**",
+  // Dart/Flutter
+  "**/.dart_tool/**",
+  "**/.packages",
+  // C# / .NET
+  "**/obj/**",
+  // Haskell
+  "**/.stack-work/**",
+  "**/.cabal-sandbox/**",
+  // Scala (Metals)
+  "**/.metals/**",
+  "**/.bloop/**",
 ];
 
 export function getEffectiveIgnores(config: { ignores?: string[] }): string[] {
   return config.ignores !== undefined ? config.ignores : DEFAULT_IGNORES;
 }
 
-export function isPathIgnored(projectPath: string, ignoredPaths: string[]): boolean {
+export function isPathIgnored(
+  projectPath: string,
+  ignoredPaths: string[],
+): boolean {
   if (ignoredPaths.length === 0) return false;
   return ignoredPaths.some(
     (ip) => projectPath === ip || isSubpath(projectPath, ip),