feat!: restructure function-specific flags for CLI

- Change --used-in-feature to --use-in-feature

BREAKING CHANGE: Command signatures changed for function init, deploy, and run

@W-22278901

Author: ritaagarwala-sf

README.md

@@ -168,10 +168,10 @@ USAGE
   $ sf data-code-extension function init -p <value> [--flags-dir <value>] [-u SearchIndexChunking]
 
 FLAGS
-  -p, --package-dir=<value>       (required) Directory path where the package will be created.
-  -u, --used-in-feature=<option>  [default: SearchIndexChunking] Feature flag for function initialization (function
-                                  packages only).
-                                  <options: SearchIndexChunking>
+  -p, --package-dir=<value>      (required) Directory path where the package will be created.
+  -u, --use-in-feature=<option>  [default: SearchIndexChunking] Feature flag for function initialization (function
+                                 packages only).
+                                 <options: SearchIndexChunking>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -191,7 +191,7 @@ FLAG DESCRIPTIONS
 
     The directory path where the new package will be initialized. The directory will be created if it doesn't exist.
 
-  -u, --used-in-feature=SearchIndexChunking  Feature flag for function initialization (function packages only).
+  -u, --use-in-feature=SearchIndexChunking  Feature flag for function initialization (function packages only).
 
     Configuration for which feature this function will be used in. SearchIndexChunking is the only valid option and is
     used by default if not specified.

commit.sh

@@ -2,12 +2,8 @@
 
 git add -A && git commit -m "feat!: restructure function-specific flags for CLI
 
-- Move --function-invoke-opt from deploy to init as --used-in-feature
-- Change value from UnstructuredChunking to SearchIndexChunking
-- Add --test-with flag to function run (required)
-- Remove --target-org from function run (not needed for functions)
-- Make --used-in-feature optional with SearchIndexChunking default
+- Change --used-in-feature to --use-in-feature
 
 BREAKING CHANGE: Command signatures changed for function init, deploy, and run
 
-@W-22278901"
+@W-22278901"

messages/init.md

@@ -20,7 +20,7 @@ Initializes the Data Code Extension by checking system requirements and setting
 
 - Initialize a function package with explicit feature flag:
 
-  <%= config.bin %> data-code-extension function init --package-dir ./my-function-package --used-in-feature SearchIndexChunking
+  <%= config.bin %> data-code-extension function init --package-dir ./my-function-package --use-in-feature SearchIndexChunking
 
 # examples.script
 
@@ -84,10 +84,10 @@ Directory path where the package will be created.
 
 The directory path where the new package will be initialized. The directory will be created if it doesn't exist.
 
-# flags.usedInFeature.summary
+# flags.useInFeature.summary
 
 Feature flag for function initialization (function packages only).
 
-# flags.usedInFeature.description
+# flags.useInFeature.description
 
 Configuration for which feature this function will be used in. SearchIndexChunking is the only valid option and is used by default if not specified.

src/base/initBase.ts

@@ -50,7 +50,7 @@ export abstract class InitBase<TFlags extends BaseInitFlags = BaseInitFlags> ext
       const executionResult = await DatacodeBinaryExecutor.executeBinaryInit(
         codeType,
         packageDir,
-        additionalFlags.usedInFeature as string | undefined
+        additionalFlags.useInFeature as string | undefined
       );
 
       this.spinner.stop();

src/commands/data-code-extension/function/init.ts

@@ -21,7 +21,7 @@ Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'init');
 
 export type FunctionInitFlags = BaseInitFlags & {
-  'used-in-feature': string;
+  'use-in-feature': string;
 };
 
 // eslint-disable-next-line sf-plugin/only-extend-SfCommand
@@ -41,10 +41,10 @@ export default class Init extends InitBase<FunctionInitFlags> {
       exists: false, // Allow non-existing directories (will be created)
     }),
     // Function-specific flag
-    'used-in-feature': Flags.string({
+    'use-in-feature': Flags.string({
       char: 'u',
-      summary: messages.getMessage('flags.usedInFeature.summary'),
-      description: messages.getMessage('flags.usedInFeature.description'),
+      summary: messages.getMessage('flags.useInFeature.summary'),
+      description: messages.getMessage('flags.useInFeature.description'),
       options: ['SearchIndexChunking'],
       default: 'SearchIndexChunking',
       required: false,
@@ -64,7 +64,7 @@ export default class Init extends InitBase<FunctionInitFlags> {
   // eslint-disable-next-line class-methods-use-this
   protected getAdditionalFlags(flags: FunctionInitFlags): Record<string, unknown> {
     return {
-      usedInFeature: flags['used-in-feature'],
+      useInFeature: flags['use-in-feature'],
     };
   }
 }

src/utils/datacodeBinaryExecutor.ts

@@ -83,20 +83,20 @@ export class DatacodeBinaryExecutor {
    *
    * @param codeType The type of code package to initialize
    * @param packageDir The directory to initialize the package in
-   * @param usedInFeature Optional feature flag (function packages only)
+   * @param useInFeature Optional feature flag (function packages only)
    * @returns Execution result with stdout, stderr, and parsed file list
    * @throws SfError if execution fails
    */
   public static async executeBinaryInit(
     codeType: 'script' | 'function',
     packageDir: string,
-    usedInFeature?: string
+    useInFeature?: string
   ): Promise<DatacodeInitExecutionResult> {
     try {
       const args = ['init', '--code-type', codeType];
 
-      if (usedInFeature) {
-        args.push('--used-in-feature', usedInFeature);
+      if (useInFeature) {
+        args.push('--use-in-feature', useInFeature);
       }
 
       args.push(packageDir);

test/commands/data-code-extension/init.test.ts

@@ -124,7 +124,7 @@ describe('data-code-extension init commands', () => {
       const result = await FunctionInit.run([
         '--package-dir',
         './test-function',
-        '--used-in-feature',
+        '--use-in-feature',
         'SearchIndexChunking',
       ]);
       expect(result.codeType).to.equal('function');
@@ -176,7 +176,7 @@ describe('data-code-extension init commands', () => {
       const result = await FunctionInit.run([
         '--package-dir',
         './test-function-type',
-        '--used-in-feature',
+        '--use-in-feature',
         'SearchIndexChunking',
       ]);
       expect(result.codeType).to.equal('function');
@@ -219,12 +219,12 @@ describe('data-code-extension init commands', () => {
       expect(error).to.exist;
       if (error instanceof Error) {
         // Could fail on either missing flag
-        expect(error.message).to.match(/package-dir|used-in-feature/);
+        expect(error.message).to.match(/package-dir|use-in-feature/);
       }
     }
   });
 
-  it('uses default value for used-in-feature when not provided', async () => {
+  it('uses default value for use-in-feature when not provided', async () => {
     try {
       const result = await FunctionInit.run(['--package-dir', './test-function']);
       // Should succeed with default value