feat: removed key format and created link to feature

Author: Swiftwork

packages/cli/README.md

@@ -74,8 +74,7 @@ Here's a comprehensive list of configuration options available in the `bucket.co
       "path": "gen/features.d.ts",
       "format": "react"
     }
-  ],
-  "keyFormat": "camelCase"
+  ]
 }
 ```
 
@@ -86,7 +85,6 @@ Here's a comprehensive list of configuration options available in the `bucket.co
 | `apiUrl`      | API URL for Bucket services (overrides baseUrl for API calls).                                                                                                       | "https://app.bucket.co/api"                          |
 | `appId`       | Your Bucket application ID.                                                                                                                                          | Required                                             |
 | `typesOutput` | Path(s) where TypeScript types will be generated. Can be a string or an array of objects with `path` and `format` properties. Available formats: `react` and `node`. | "gen/features.ts" with format "react"                |
-| `keyFormat`   | Format for feature keys (options: custom, pascalCase, camelCase, snakeCaseUpper, snakeCaseLower, kebabCaseUpper, kebabCaseLower).                                    | "custom"                                             |
 
 You can override these settings using command-line options for individual commands.
 

packages/cli/commands/features.ts

@@ -5,20 +5,19 @@ import { mkdir, writeFile } from "node:fs/promises";
 import { dirname, isAbsolute, join, relative } from "node:path";
 import ora, { Ora } from "ora";
 
-import { App, getApp } from "../services/bootstrap.js";
+import { App, getApp, getOrg } from "../services/bootstrap.js";
 import { createFeature, Feature, listFeatures } from "../services/features.js";
 import { configStore } from "../stores/config.js";
-import { baseUrlSuffix } from "../utils/constants.js";
 import { handleError, MissingAppIdError } from "../utils/errors.js";
 import { genFeatureKey, genTypes, KeyFormatPatterns } from "../utils/gen.js";
 import {
   appIdOption,
   featureKeyOption,
   featureNameArgument,
-  keyFormatOption,
   typesFormatOption,
   typesOutOption,
 } from "../utils/options.js";
+import { baseUrlSuffix, featureUrl } from "../utils/path.js";
 
 type CreateFeatureArgs = {
   key?: string;
@@ -32,6 +31,7 @@ export const createFeatureAction = async (
   let spinner: Ora | undefined;
   try {
     if (!appId) throw new MissingAppIdError();
+    const org = getOrg();
     const app = getApp(appId);
     console.log(
       `Creating feature for app ${chalk.cyan(app.name)}${baseUrlSuffix(baseUrl)}.`,
@@ -44,7 +44,7 @@ export const createFeatureAction = async (
     }
 
     if (!key) {
-      const keyFormat = configStore.getConfig("keyFormat") ?? "custom";
+      const keyFormat = org.featureKeyFormat;
       key = await input({
         message: "New feature key:",
         default: genFeatureKey(name, keyFormat),
@@ -54,9 +54,13 @@ export const createFeatureAction = async (
 
     spinner = ora(`Creating feature...`).start();
     const feature = await createFeature(appId, name, key);
-    // todo: would like to link to feature here but we don't have the env id, only app id
+    const production = app.environments.find((e) => e.isProduction);
     spinner.succeed(
-      `Created feature ${chalk.cyan(feature.name)} with key ${chalk.cyan(feature.key)}${baseUrlSuffix(baseUrl)}.`,
+      `Created feature ${chalk.cyan(feature.name)} with key ${chalk.cyan(feature.key)}${
+        production
+          ? ` at ${chalk.cyan(featureUrl(baseUrl, production, feature))}`
+          : ""
+      }.`,
     );
   } catch (error) {
     spinner?.fail("Feature creation failed.");
@@ -150,7 +154,6 @@ export function registerFeatureCommands(cli: Command) {
     .command("create")
     .description("Create a new feature.")
     .addOption(appIdOption)
-    .addOption(keyFormatOption)
     .addOption(featureKeyOption)
     .addArgument(featureNameArgument)
     .action(createFeatureAction);
@@ -171,10 +174,9 @@ export function registerFeatureCommands(cli: Command) {
 
   // Update the config with the cli override values
   featuresCommand.hook("preAction", (_, command) => {
-    const { appId, keyFormat, out, format } = command.opts();
+    const { appId, out, format } = command.opts();
     configStore.setConfig({
       appId,
-      keyFormat,
       typesOutput: out ? [{ path: out, format: format || "react" }] : undefined,
     });
   });

packages/cli/commands/init.ts

@@ -63,9 +63,6 @@ export const initAction = async (args: InitArgs = {}) => {
       });
     }
 
-    const keyFormat =
-      apps.find((app) => app.id === appId)?.featureKeyFormat ?? "custom";
-
     // Get types output path
     const typesOutput = await input({
       message: "Where should we generate the types?",
@@ -85,7 +82,6 @@ export const initAction = async (args: InitArgs = {}) => {
     // Update config
     configStore.setConfig({
       appId,
-      keyFormat,
       typesOutput: [{ path: typesOutput, format: typesFormat }],
     });
 

packages/cli/commands/new.ts

@@ -7,7 +7,6 @@ import {
   appIdOption,
   featureKeyOption,
   featureNameArgument,
-  keyFormatOption,
   typesFormatOption,
   typesOutOption,
 } from "../utils/options.js";
@@ -38,7 +37,6 @@ export function registerNewCommand(cli: Command) {
       "Initialize the Bucket CLI, authenticates, and creates a new feature.",
     )
     .addOption(appIdOption)
-    .addOption(keyFormatOption)
     .addOption(typesOutOption)
     .addOption(typesFormatOption)
     .addOption(featureKeyOption)
@@ -47,10 +45,9 @@ export function registerNewCommand(cli: Command) {
 
   // Update the config with the cli override values
   cli.hook("preAction", (command) => {
-    const { appId, keyFormat, out, format } = command.opts();
+    const { appId, out, format } = command.opts();
     configStore.setConfig({
       appId,
-      keyFormat,
       typesOutput: out ? [{ path: out, format: format || "react" }] : undefined,
     });
   });

packages/cli/index.ts

@@ -14,6 +14,12 @@ import { handleError } from "./utils/errors.js";
 import { apiUrlOption, baseUrlOption, debugOption } from "./utils/options.js";
 import { stripTrailingSlash } from "./utils/path.js";
 
+type Options = {
+  debug?: boolean;
+  baseUrl?: string;
+  apiUrl?: string;
+};
+
 async function main() {
   // Must load tokens and config before anything else
   await authStore.initialize();
@@ -26,8 +32,9 @@ async function main() {
 
   // Pre-action hook
   program.hook("preAction", async () => {
-    const { debug, baseUrl, apiUrl } = program.opts();
+    const { debug, baseUrl, apiUrl } = program.opts<Options>();
     const cleanedBaseUrl = stripTrailingSlash(baseUrl?.trim());
+    // Set baseUrl and apiUrl in config store, will skip if undefined
     configStore.setConfig({
       baseUrl: cleanedBaseUrl,
       apiUrl:

packages/cli/package.json

@@ -50,12 +50,14 @@
     "find-up": "^7.0.0",
     "json5": "^2.2.3",
     "open": "^10.1.0",
-    "ora": "^8.1.0"
+    "ora": "^8.1.0",
+    "slug": "^10.0.0"
   },
   "devDependencies": {
     "@bucketco/eslint-config": "workspace:^",
     "@bucketco/tsconfig": "workspace:^",
     "@types/node": "^22.5.1",
+    "@types/slug": "^5.0.9",
     "eslint": "^9.21.0",
     "prettier": "^3.5.2",
     "shx": "^0.3.4",

packages/cli/schema.json

@@ -30,19 +30,6 @@
         },
         "required": ["path"]
       }
-    },
-    "keyFormat": {
-      "type": "string",
-      "description": "Format for the suggested feature keys, must match Bucket app settings. Defaults to custom.",
-      "enum": [
-        "custom",
-        "pascalCase",
-        "camelCase",
-        "snakeCaseUpper",
-        "snakeCaseLower",
-        "kebabCaseUpper",
-        "kebabCaseLower"
-      ]
     }
   },
   "required": ["appId"]

packages/cli/services/bootstrap.ts

@@ -1,16 +1,16 @@
-import { KeyFormat } from "../stores/config.js";
 import { authRequest } from "../utils/auth.js";
+import { KeyFormat } from "../utils/gen.js";
 
 export type BootstrapResponse = {
-  org: OrgResponse;
-  user: UserResponse;
+  org: Org;
+  user: User;
 };
 
-export type OrgResponse = {
+export type Org = {
   id: string;
   name: string;
   logoUrl: string;
-  apps: AppResponse[];
+  apps: App[];
   inviteKey: string;
   createdAt: Date;
   updatedAt: Date;
@@ -23,13 +23,21 @@ export type OrgResponse = {
   featureKeyFormat: KeyFormat;
 };
 
-export type AppResponse = {
+export type Environment = {
+  id: string;
+  name: string;
+  isProduction: boolean;
+  order: number;
+};
+
+export type App = {
   id: string;
   name: string;
   demo: boolean;
+  environments: Environment[];
 };
 
-export type UserResponse = {
+export type User = {
   id: string;
   email: string;
   name: string;
@@ -39,13 +47,6 @@ export type UserResponse = {
   isAdmin: boolean;
 };
 
-export type App = {
-  id: string;
-  name: string;
-  demo: boolean;
-  featureKeyFormat: KeyFormat;
-};
-
 let bootstrapResponse: BootstrapResponse | null = null;
 
 export async function bootstrap(): Promise<BootstrapResponse> {
@@ -55,23 +56,28 @@ export async function bootstrap(): Promise<BootstrapResponse> {
   return bootstrapResponse;
 }
 
+export function getOrg(): Org {
+  if (!bootstrapResponse) {
+    throw new Error("CLI has not been bootstrapped.");
+  }
+  if (!bootstrapResponse.org) {
+    throw new Error("No organization found.");
+  }
+  return bootstrapResponse.org;
+}
+
 export function listApps(): App[] {
   if (!bootstrapResponse) {
-    throw new Error("Failed to load bootstrap response");
+    throw new Error("CLI has not been bootstrapped.");
   }
   const org = bootstrapResponse.org;
   if (!org) {
-    throw new Error("No organization found");
+    throw new Error("No organization found.");
   }
   if (!org.apps?.length) {
-    throw new Error("No apps found");
+    throw new Error("No apps found.");
   }
-  return bootstrapResponse.org.apps.map(({ id, name, demo }) => ({
-    name,
-    id,
-    featureKeyFormat: org.featureKeyFormat ?? "custom",
-    demo,
-  }));
+  return bootstrapResponse.org.apps;
 }
 
 export function getApp(id: string): App {
@@ -83,9 +89,12 @@ export function getApp(id: string): App {
   return app;
 }
 
-export function getUser(): UserResponse {
+export function getUser(): User {
   if (!bootstrapResponse) {
-    throw new Error("Failed to load bootstrap response");
+    throw new Error("CLI has not been bootstrapped.");
+  }
+  if (!bootstrapResponse.user) {
+    throw new Error("No user found.");
   }
   return bootstrapResponse.user;
 }

packages/cli/services/features.ts

@@ -16,6 +16,7 @@ export type RemoteConfig = {
 };
 
 export type Feature = {
+  id: string;
   name: string;
   key: string;
   remoteConfigs: RemoteConfig[];

packages/cli/stores/config.ts

@@ -16,17 +16,6 @@ import {
 import { ConfigValidationError, handleError } from "../utils/errors.js";
 import { stripTrailingSlash } from "../utils/path.js";
 
-export const keyFormats = [
-  "custom",
-  "pascalCase",
-  "camelCase",
-  "snakeCaseUpper",
-  "snakeCaseLower",
-  "kebabCaseUpper",
-  "kebabCaseLower",
-] as const;
-export type KeyFormat = (typeof keyFormats)[number];
-
 export const typeFormats = ["react", "node"] as const;
 export type TypeFormat = (typeof typeFormats)[number];
 
@@ -41,7 +30,6 @@ type Config = {
   apiUrl: string;
   appId: string | undefined;
   typesOutput: TypesOutput[];
-  keyFormat: KeyFormat;
 };
 
 const defaultConfig: Config = {
@@ -50,7 +38,6 @@ const defaultConfig: Config = {
   apiUrl: DEFAULT_API_URL,
   appId: undefined,
   typesOutput: [{ path: DEFAULT_TYPES_OUTPUT, format: "react" }],
-  keyFormat: "custom",
 };
 
 // Helper to normalize typesOutput to array format