@burglekitt/worktree 0.1.0 → 0.1.2

package/dist/commands/branch.d.ts

@@ -6,7 +6,6 @@ export default class Branch extends BaseCommand {
     static description: string;
     static examples: string[];
     static flags: {
-        help: import("@oclif/core/interfaces").BooleanFlag<void>;
         source: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     private confirmNonOriginSource;

package/dist/commands/branch.js

@@ -13,7 +13,6 @@ export default class Branch extends BaseCommand {
         "<%= config.bin %> <%= command.id %> my-new-branch",
     ];
     static flags = {
-        help: Flags.help({ char: "h", description: "Show branch help" }),
         source: Flags.string({
             char: "s",
             description: "Source branch to create the worktree from",
@@ -66,6 +65,8 @@ export default class Branch extends BaseCommand {
     }
     async run() {
         const { args, flags } = await this.parse(Branch);
+        // If there is no source flag provided, make sure defaultSourceBranch is configured
+        await this.verifyConfig(flags.source ? [] : ["defaultSourceBranch"]);
         const branchName = await this.getBranchName(args.branchName);
         const sourceBranch = await this.getSourceBranch(flags.source);
         const projectPath = await gitCreateWorktree(branchName, sourceBranch);

package/dist/commands/config.d.ts

@@ -8,7 +8,6 @@ export default class Config extends BaseCommand {
     };
     static flags: {
         list: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        help: import("@oclif/core/interfaces").BooleanFlag<void>;
         missing: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     private renderList;

package/dist/commands/config.js

@@ -1,11 +1,14 @@
 import { EOL } from "node:os";
 import { confirm, input } from "@inquirer/prompts";
 import { Args, Flags } from "@oclif/core";
+import chalk from "chalk";
 import { BaseCommand } from "../lib/base-command.js";
 import { CONFIG_NAMES } from "../lib/constants.js";
 import { gitGetConfigValue, gitSetConfigValue } from "../lib/git.js";
 import { conjoin } from "../lib/utils.js";
 import { isValidBranch, isValidCommand, isValidEmail, validateConfigValue, } from "../lib/validators.js";
+// TODO: Implement properly when Jira integration has been added
+const JIRA_ENABLED = false;
 export default class Config extends BaseCommand {
     static description = "Configure worktree CLI settings";
     static examples = ["<%= config.bin %> <%= command.id %>"];
@@ -18,7 +21,6 @@ export default class Config extends BaseCommand {
             char: "l",
             description: "List all available variables",
         }),
-        help: Flags.help({ char: "h", description: "Show config help" }),
         missing: Flags.boolean({
             char: "m",
             description: "Only prompt missing variables",
@@ -52,7 +54,7 @@ export default class Config extends BaseCommand {
     }
     async renderInput(missing) {
         const configNames = await this.getPromptConfigNames(missing);
-        const hasJiraPrompt = !!configNames.find((name) => name.startsWith("jira"));
+        const hasJiraPrompt = JIRA_ENABLED && !!configNames.find((name) => name.startsWith("jira"));
         // First check if there is anything to prompt
         if (configNames.length === 0) {
             this.log("No missing config found.");
@@ -96,12 +98,15 @@ export default class Config extends BaseCommand {
             });
             await gitSetConfigValue("codeEditor", codeEditor);
         }
+        this.log(`${chalk.green("✔")} Configuration complete!${EOL}`);
     }
     isValidArgName(name) {
         return CONFIG_NAMES.includes(name);
     }
     async run() {
         const { args, flags } = await this.parse(Config);
+        // Mark that config has been called at least once
+        await gitSetConfigValue("has-called-config", "true");
         if (args.name) {
             if (!this.isValidArgName(args.name)) {
                 this.error([

package/dist/lib/base-command.d.ts

@@ -1,6 +1,10 @@
 import { Command } from "@oclif/core";
 import type { CommandError } from "@oclif/core/interfaces";
+import type { ConfigName } from "./constants.js";
 export declare abstract class BaseCommand extends Command {
+    private confirmFirstTimeConfig;
+    private confirmMissingConfig;
+    protected verifyConfig(configNames?: ConfigName[]): Promise<void>;
     protected openWorktreePath(path: string): Promise<void>;
     protected catch(error: CommandError): Promise<any>;
 }

package/dist/lib/base-command.js

@@ -1,9 +1,38 @@
 import { exec } from "node:child_process";
+import { confirm } from "@inquirer/prompts";
 import { Command } from "@oclif/core";
 import chalk from "chalk";
 import ora from "ora";
 import { gitGetConfigValue } from "./git.js";
 export class BaseCommand extends Command {
+    confirmFirstTimeConfig() {
+        const message = "Looks like this is your first time running the CLI. Do you want to run the config command now?";
+        return confirm({ message });
+    }
+    confirmMissingConfig() {
+        const message = "Some required configuration values are missing. Do you want to run the config command now?";
+        return confirm({ message });
+    }
+    async verifyConfig(configNames = []) {
+        if ((await gitGetConfigValue("has-called-config")) !== "true") {
+            if (await this.confirmFirstTimeConfig()) {
+                await this.config.runCommand("config");
+                return;
+            }
+        }
+        let isMissingConfig = false;
+        for (const name of configNames) {
+            if (!(await gitGetConfigValue(name))) {
+                isMissingConfig = true;
+                break;
+            }
+        }
+        if (isMissingConfig) {
+            if (await this.confirmMissingConfig()) {
+                await this.config.runCommand("config", ["--missing"]);
+            }
+        }
+    }
     async openWorktreePath(path) {
         const codeEditor = await gitGetConfigValue("codeEditor");
         if (codeEditor) {

package/dist/lib/constants.d.ts

@@ -1,2 +1,2 @@
-export declare const CONFIG_NAMES: readonly ["jira.domain", "jira.email", "jira.apiToken", "codeEditor", "defaultSourceBranch"];
+export declare const CONFIG_NAMES: readonly ["has-called-config", "jira.domain", "jira.email", "jira.apiToken", "codeEditor", "defaultSourceBranch"];
 export type ConfigName = (typeof CONFIG_NAMES)[number];

package/dist/lib/constants.js

@@ -1,4 +1,5 @@
 export const CONFIG_NAMES = [
+    "has-called-config",
     "jira.domain",
     "jira.email",
     "jira.apiToken",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@burglekitt/worktree",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A CLI tool for managing git worktrees with enhanced workflow features",
   "main": "./bin/run.js",
   "type": "module",
@@ -32,11 +32,18 @@
   "license": "MIT",
   "packageManager": "pnpm@10.32.1+sha512.a706938f0e89ac1456b6563eab4edf1d1faf3368d1191fc5c59790e96dc918e4456ab2e67d613de1043d2e8c81f87303e6b40d4ffeca9df15ef1ad567348f2be",
   "bin": {
-    "worktree": "./bin/run.js",
-    "@burglekitt/worktree": "./bin/run.js"
+    "@burglekitt/worktree": "./bin/run.js",
+    "worktree": "./bin/run.js"
   },
   "oclif": {
-    "bin": "worktree",
+    "bin": "@burglekitt/worktree",
+    "binAliases": [
+      "@burglekitt/worktree",
+      "worktree"
+    ],
+    "plugins": [
+      "@oclif/plugin-*"
+    ],
     "commands": "./dist/commands",
     "dirname": "worktree",
     "topicSeparator": " "
@@ -44,6 +51,8 @@
   "dependencies": {
     "@inquirer/prompts": "^8.3.0",
     "@oclif/core": "^4.8.3",
+    "@oclif/plugin-help": "^6.2.37",
+    "@oclif/plugin-not-found": "^3.2.74",
     "chalk": "^5.6.2",
     "glob": "^13.0.6",
     "ora": "^9.3.0"