refactor: rename uibundle.json to ui-bundle.json and update references

Rename manifest filename from uibundle.json to ui-bundle.json (with
hyphen) across source, messages, and tests for consistency with the
ui-bundle naming convention.

Author: garychangsf

messages/ui-bundle.dev.md

@@ -18,19 +18,19 @@ Name of the UI bundle to preview.
 
 # flags.name.description
 
-The unique name of the UI bundle, as defined by the "name" property in the uibundle.json runtime configuration file.  The uibundle.json file is located in the "uiBundles" metadata directory of your DX project, such as force-app/main/default/uiBundles/MyApp/uibundle.json.
+The unique name of the UI bundle, as defined by the "name" property in the ui-bundle.json runtime configuration file.  The ui-bundle.json file is located in the "uiBundles" metadata directory of your DX project, such as force-app/main/default/uiBundles/MyApp/ui-bundle.json.
 
-If you don't specify this flag, the command automatically discovers the uibundle.json files in the current directory and subdirectories. If the command finds only one uibundle.json, it automatically uses it. If it finds multiple files, the command prompts you to select one.
+If you don't specify this flag, the command automatically discovers the ui-bundle.json files in the current directory and subdirectories. If the command finds only one ui-bundle.json, it automatically uses it. If it finds multiple files, the command prompts you to select one.
 
 # flags.url.summary
 
 URL where your developer server runs, such as https://localhost:5173. All UI, static, and hot deployment requests are forwarded to this URL.
 
 # flags.url.description
 
-You must specify this flag if the UI bundle's uibundle.json file doesn't contain a value for either the "dev.command" or "dev.url" configuration properties. All non-Salesforce API requests are forwarded to this URL.
+You must specify this flag if the UI bundle's ui-bundle.json file doesn't contain a value for either the "dev.command" or "dev.url" configuration properties. All non-Salesforce API requests are forwarded to this URL.
 
-If you specify this flag, it overrides the value in the uibundle.json file.
+If you specify this flag, it overrides the value in the ui-bundle.json file.
 
 This is the order of precedence that the dev server uses for the URL:  --url flag > manifest dev.url > URL from the dev server process (which was started using either manifest dev.command or default npm run dev).
 
@@ -52,7 +52,7 @@ This flag saves you from manually copying and pasting the URL. The browser opens
 
 # examples
 
-- Start the local development (dev) server by automatically discovering the UI bundle's uibundle.json file; use the org with alias "myorg":
+- Start the local development (dev) server by automatically discovering the UI bundle's ui-bundle.json file; use the org with alias "myorg":
 
   <%= config.bin %> <%= command.id %> --target-org myorg
 
@@ -182,7 +182,7 @@ Failed to watch manifest: %s.
 # error.dev-url-unreachable
 
 Dev server unreachable at %s.
-Start your dev server manually at that URL, or add dev.command to uibundle.json to start it automatically.
+Start your dev server manually at that URL, or add dev.command to ui-bundle.json to start it automatically.
 
 # error.dev-url-unreachable-with-flag
 
@@ -219,13 +219,13 @@ Select the UI bundle to run:
 
 # info.no-manifest-defaults
 
-No uibundle.json found. Using defaults: dev command=%s, proxy port=%s.
+No ui-bundle.json found. Using defaults: dev command=%s, proxy port=%s.
 
 Tip: See "sf ui-bundle dev --help" for configuration options.
 
 # warning.empty-manifest
 
-No dev configuration in uibundle.json - using defaults (command: %s).
+No dev configuration in ui-bundle.json - using defaults (command: %s).
 
 Tip: See "sf ui-bundle dev --help" for configuration options.
 

src/commands/ui-bundle/dev.ts

@@ -182,7 +182,7 @@ export default class UiBundleDev extends SfCommand<WebAppDevResult> {
 
     try {
       // Step 1: Discover and select webapp
-      this.logger.debug('Discovering uibundle.json manifest(s)...');
+      this.logger.debug('Discovering ui-bundle.json manifest(s)...');
 
       const { webapp: discoveredWebapp, allWebapps, autoSelected } = await discoverWebapp(flags.name);
 
@@ -277,7 +277,7 @@ export default class UiBundleDev extends SfCommand<WebAppDevResult> {
       const resolvedUrl = flags.url ?? manifest?.dev?.url ?? (hasDevCommand ? 'http://localhost:5173' : null);
       if (!resolvedUrl) {
         throw new SfError(
-          '❌ Unable to determine dev server URL. Specify --url or configure dev.url or dev.command in uibundle.json.',
+          '❌ Unable to determine dev server URL. Specify --url or configure dev.url or dev.command in ui-bundle.json.',
           'DevServerUrlError'
         );
       }
@@ -303,7 +303,7 @@ export default class UiBundleDev extends SfCommand<WebAppDevResult> {
         // dev.url in manifest but no dev.command - don't start (we can't control the port)
         throw new SfError(messages.getMessage('error.dev-url-unreachable', [resolvedUrl]), 'DevServerUrlError', [
           `Ensure your dev server is running at ${resolvedUrl}`,
-          'Or add dev.command to uibundle.json to start it automatically',
+          'Or add dev.command to ui-bundle.json to start it automatically',
         ]);
       } else {
         // URL not reachable - we have dev.command (or defaults) to start
@@ -372,7 +372,7 @@ export default class UiBundleDev extends SfCommand<WebAppDevResult> {
 
           const suggestions: string[] = [
             'The dev server may be taking longer than expected to start',
-            'Check if the dev server command is correct in uibundle.json',
+            'Check if the dev server command is correct in ui-bundle.json',
             `Try running the command manually to see the error: ${devCommand}`,
           ];
           const devError =
@@ -403,7 +403,7 @@ export default class UiBundleDev extends SfCommand<WebAppDevResult> {
       // Ensure devServerUrl is set (should always be set by step 3)
       if (!devServerUrl) {
         throw new SfError(
-          '❌ Unable to determine dev server URL. Please specify --url or configure dev.url in uibundle.json.',
+          '❌ Unable to determine dev server URL. Please specify --url or configure dev.url in ui-bundle.json.',
           'DevServerUrlError'
         );
       }

src/config/ManifestWatcher.ts

@@ -38,8 +38,8 @@ export type ManifestChangeEvent = {
  */
 type ManifestWatcherOptions = {
   /**
-   * Path to the uibundle.json manifest file
-   * Defaults to uibundle.json in the current working directory
+   * Path to the ui-bundle.json manifest file
+   * Defaults to ui-bundle.json in the current working directory
    */
   manifestPath?: string;
 
@@ -66,10 +66,10 @@ type ManifestWatcherEvents = {
 };
 
 /**
- * ManifestWatcher loads and monitors the uibundle.json manifest file
+ * ManifestWatcher loads and monitors the ui-bundle.json manifest file
  *
  * Features:
- * - Loads uibundle.json from project root
+ * - Loads ui-bundle.json from project root
  * - Watches for file changes and emits events
  * - Provides helpful error messages
  * - Supports hot-reload without restarting the proxy
@@ -87,7 +87,7 @@ export class ManifestWatcher extends EventEmitter {
     super();
 
     this.options = {
-      manifestPath: options.manifestPath ?? join(process.cwd(), 'uibundle.json'),
+      manifestPath: options.manifestPath ?? join(process.cwd(), 'ui-bundle.json'),
       watch: options.watch ?? true,
       debounceMs: options.debounceMs ?? 300,
     };
@@ -175,8 +175,8 @@ export class ManifestWatcher extends EventEmitter {
         });
         this.emit(
           'error',
-          new SfError('uibundle.json was deleted', 'ManifestRemovedError', [
-            'Recreate the uibundle.json file to continue',
+          new SfError('ui-bundle.json was deleted', 'ManifestRemovedError', [
+            'Recreate the ui-bundle.json file to continue',
           ])
         );
       } else {
@@ -208,10 +208,10 @@ export class ManifestWatcher extends EventEmitter {
   private loadManifest(): void {
     // Check if file exists
     if (!existsSync(this.options.manifestPath)) {
-      throw new SfError(`uibundle.json not found at ${this.options.manifestPath}`, 'ManifestNotFoundError', [
+      throw new SfError(`ui-bundle.json not found at ${this.options.manifestPath}`, 'ManifestNotFoundError', [
         'Make sure you are in the correct directory',
-        'Create a uibundle.json file in your project root',
-        'Check that the file is named exactly "uibundle.json"',
+        'Create a ui-bundle.json file in your project root',
+        'Check that the file is named exactly "ui-bundle.json"',
       ]);
     }
 
@@ -221,7 +221,7 @@ export class ManifestWatcher extends EventEmitter {
       rawContent = readFileSync(this.options.manifestPath, 'utf-8');
     } catch (error) {
       throw new SfError(
-        `Failed to read uibundle.json: ${error instanceof Error ? error.message : String(error)}`,
+        `Failed to read ui-bundle.json: ${error instanceof Error ? error.message : String(error)}`,
         'ManifestReadError',
         ['Check file permissions', 'Ensure the file is not locked by another process']
       );
@@ -232,7 +232,7 @@ export class ManifestWatcher extends EventEmitter {
     try {
       parsed = JSON.parse(rawContent) as WebAppManifest;
     } catch (error) {
-      throw new SfError(`Invalid JSON in uibundle.json: ${(error as Error).message}`, 'ManifestParseError', [
+      throw new SfError(`Invalid JSON in ui-bundle.json: ${(error as Error).message}`, 'ManifestParseError', [
         'Check for missing commas or brackets',
         'Validate JSON syntax using a JSON validator',
         'Common issues: trailing commas, unquoted keys, single quotes instead of double quotes',
@@ -272,7 +272,7 @@ export class ManifestWatcher extends EventEmitter {
       this.emit(
         'error',
         new SfError(`File watcher error: ${error.message}`, 'ManifestWatcherError', [
-          'The uibundle.json file watcher encountered an error',
+          'The ui-bundle.json file watcher encountered an error',
           'You may need to restart the command',
         ])
       );

src/config/manifest.ts

@@ -39,7 +39,7 @@ export type DevConfig = {
 };
 
 /**
- * WebApp manifest configuration - defines the structure of uibundle.json file
+ * WebApp manifest configuration - defines the structure of ui-bundle.json file
  * Extended from @salesforce/webapp-experimental with plugin-specific fields
  */
 export type WebAppManifest = BaseWebAppManifest & {

src/config/webappDiscovery.ts

@@ -22,7 +22,7 @@ import type { WebAppManifest } from './manifest.js';
 const logger = Logger.childFromRoot('WebappDiscovery');
 
 /**
- * Default command to run when no uibundle.json manifest is found
+ * Default command to run when no ui-bundle.json manifest is found
  */
 export const DEFAULT_DEV_COMMAND = 'npm run dev';
 
@@ -45,11 +45,11 @@ export type DiscoveredWebapp = {
   path: string;
   /** Relative path from cwd to the webapp directory */
   relativePath: string;
-  /** Parsed manifest content (null if no uibundle.json found) */
+  /** Parsed manifest content (null if no ui-bundle.json found) */
   manifest: WebAppManifest | null;
   /** Webapp name (from .uibundle-meta.xml or folder name) */
   name: string;
-  /** Whether this webapp has a uibundle.json manifest file */
+  /** Whether this webapp has a ui-bundle.json manifest file */
   hasManifest: boolean;
   /** Path to the manifest file (null if no manifest) */
   manifestPath: string | null;
@@ -126,7 +126,7 @@ async function pathExists(path: string): Promise<boolean> {
 }
 
 /**
- * Try to parse a uibundle.json file.
+ * Try to parse a ui-bundle.json file.
  * Accepts any valid JSON object - missing fields will use defaults.
  */
 async function tryParseWebappManifest(filePath: string): Promise<WebAppManifest | null> {
@@ -267,7 +267,7 @@ function findWebapplicationsFolderUpward(
 /**
  * Discover all webapps inside the uiBundles folder.
  * Only directories containing a {name}.uibundle-meta.xml file are considered valid webapps.
- * If a uibundle.json exists, use it for dev configuration.
+ * If a ui-bundle.json exists, use it for dev configuration.
  *
  * @param webappsFolderPath - Absolute path to the uiBundles folder
  * @param cwd - Original working directory for relative path calculation
@@ -292,7 +292,7 @@ async function discoverWebappsInFolder(webappsFolderPath: string, cwd: string):
         return null;
       }
 
-      const manifestFilePath = join(webappPath, 'uibundle.json');
+      const manifestFilePath = join(webappPath, 'ui-bundle.json');
 
       // Try to load manifest for dev configuration
       const manifest = await tryParseWebappManifest(manifestFilePath);
@@ -384,7 +384,7 @@ async function findAllWebapps(cwd: string = process.cwd()): Promise<FindAllWebap
     const metaXmlName = await findWebappMetaXml(cwd);
     if (metaXmlName) {
       // Current directory is a standalone webapp
-      const manifestFilePath = join(cwd, 'uibundle.json');
+      const manifestFilePath = join(cwd, 'ui-bundle.json');
       const manifest = await tryParseWebappManifest(manifestFilePath);
       const webappName = resolveWebappName(basename(cwd), metaXmlName);
 
@@ -476,7 +476,7 @@ export async function discoverWebapp(
           '  uiBundles/\n' +
           '    └── my-app/\n' +
           '        ├── my-app.uibundle-meta.xml  (required)\n' +
-          '        └── uibundle.json             (optional, for dev config)',
+          '        └── ui-bundle.json             (optional, for dev config)',
         'UIBundleNotFoundError'
       );
     } else if (inSfdxProject) {
@@ -487,7 +487,7 @@ export async function discoverWebapp(
           '  <package-path>/main/default/uiBundles/\n' +
           '    └── my-app/\n' +
           '        ├── my-app.uibundle-meta.xml  (required)\n' +
-          '        └── uibundle.json             (optional, for dev config)',
+          '        └── ui-bundle.json             (optional, for dev config)',
         'UIBundleNotFoundError'
       );
     } else {

src/server/DevServerManager.ts

@@ -359,7 +359,7 @@ export class DevServerManager extends EventEmitter {
     this.logger.error(`Dev server process error: ${error.message}`);
 
     const sfError = new SfError(`❌ Dev server process error: ${error.message}`, 'DevServerProcessError', [
-      'Check that the command is correct in uibundle.json',
+      'Check that the command is correct in ui-bundle.json',
       'Verify all dependencies are installed',
       'Try running the command manually to see the error',
     ]);

test/commands/ui-bundle/helpers/webappProjectUtils.ts

@@ -148,10 +148,10 @@ export function createWebappDirWithoutMeta(projectDir: string, name: string): vo
 }
 
 /**
- * Overwrite the `uibundle.json` manifest for a given UI bundle.
+ * Overwrite the `ui-bundle.json` manifest for a given UI bundle.
  */
 export function writeManifest(projectDir: string, webAppName: string, manifest: Record<string, unknown>): void {
-  writeFileSync(join(webappPath(projectDir, webAppName), 'uibundle.json'), JSON.stringify(manifest, null, 2));
+  writeFileSync(join(webappPath(projectDir, webAppName), 'ui-bundle.json'), JSON.stringify(manifest, null, 2));
 }
 
 /**

test/config/ManifestWatcher.test.ts

@@ -25,7 +25,7 @@ import type { WebAppManifest, ManifestChangeEvent } from '../../src/config/types
 describe('ManifestWatcher', () => {
   const $$ = new TestContext();
   const testDir = join(process.cwd(), '.test-manifests');
-  const testManifestPath = join(testDir, 'uibundle.json');
+  const testManifestPath = join(testDir, 'ui-bundle.json');
 
   const validManifest: WebAppManifest = {
     name: 'testApp',
@@ -90,7 +90,7 @@ describe('ManifestWatcher', () => {
       } catch (error) {
         expect(error).to.be.instanceOf(SfError);
         expect((error as SfError).name).to.equal('ManifestNotFoundError');
-        expect((error as SfError).message).to.include('uibundle.json not found');
+        expect((error as SfError).message).to.include('ui-bundle.json not found');
         expect((error as SfError).actions).to.exist;
       }
 
@@ -125,7 +125,7 @@ describe('ManifestWatcher', () => {
 
     it('should handle read permission errors', async () => {
       // Create a file path that doesn't exist to simulate read error
-      const invalidPath = join(testDir, 'nonexistent', 'uibundle.json');
+      const invalidPath = join(testDir, 'nonexistent', 'ui-bundle.json');
 
       const watcher = new ManifestWatcher({ manifestPath: invalidPath, watch: false });
 
@@ -431,8 +431,8 @@ describe('ManifestWatcher', () => {
   });
 
   describe('Default Options', () => {
-    it('should use uibundle.json in current directory by default', async () => {
-      const defaultPath = join(process.cwd(), 'uibundle.json');
+    it('should use ui-bundle.json in current directory by default', async () => {
+      const defaultPath = join(process.cwd(), 'ui-bundle.json');
 
       // Create manifest in current directory
       writeFileSync(defaultPath, JSON.stringify(validManifest, null, 2));

test/config/webappDiscovery.test.ts

@@ -38,7 +38,7 @@ describe('webappDiscovery', () => {
     // Create required .uibundle-meta.xml file
     writeFileSync(join(appPath, `${name}.uibundle-meta.xml`), '<WebApplication/>');
     if (manifest) {
-      writeFileSync(join(appPath, 'uibundle.json'), JSON.stringify(manifest));
+      writeFileSync(join(appPath, 'ui-bundle.json'), JSON.stringify(manifest));
     }
     return appPath;
   }