Merge pull request #6065 from Shopify/fix-flag-case

change camelCase flag names to kebab-case

Author: jordanverasamy

packages/cli/oclif.manifest.json

@@ -4880,21 +4880,21 @@
       "customPluginName": "@shopify/store",
       "description": "Copy data between stores, export store data to SQLite, or import data from SQLite to a store",
       "flags": {
-        "fromFile": {
+        "from-file": {
           "description": "The SQLite file to import data from.",
           "env": "SHOPIFY_FLAG_FROM_FILE",
           "hasDynamicHelp": false,
           "multiple": false,
-          "name": "fromFile",
+          "name": "from-file",
           "required": false,
           "type": "option"
         },
-        "fromStore": {
+        "from-store": {
           "description": "The source store domain to copy/export data from (e.g., source.myshopify.com).",
           "env": "SHOPIFY_FLAG_FROM_STORE",
           "hasDynamicHelp": false,
           "multiple": false,
-          "name": "fromStore",
+          "name": "from-store",
           "required": false,
           "type": "option"
         },
@@ -4937,21 +4937,21 @@
           "required": false,
           "type": "boolean"
         },
-        "toFile": {
+        "to-file": {
           "description": "The SQLite file path to export data to. Omit to auto-generate filename.",
           "env": "SHOPIFY_FLAG_TO_FILE",
           "hasDynamicHelp": false,
           "multiple": false,
-          "name": "toFile",
+          "name": "to-file",
           "required": false,
           "type": "option"
         },
-        "toStore": {
+        "to-store": {
           "description": "The target store domain to copy/import data to (e.g., target.myshopify.com).",
           "env": "SHOPIFY_FLAG_TO_STORE",
           "hasDynamicHelp": false,
           "multiple": false,
-          "name": "toStore",
+          "name": "to-store",
           "required": false,
           "type": "option"
         },

packages/features/steps/store.steps.ts

@@ -73,7 +73,7 @@ When(
   {timeout: 60 * 1000},
   async function (source: string, destination: string) {
     try {
-      const args = ['store', 'copy', '--fromStore', source, '--toStore', destination, '--mock', '--no-prompt']
+      const args = ['store', 'copy', '--from-store', source, '--to-store', destination, '--mock', '--no-prompt']
       const result = await this.execCLI(args)
       const context = storeContext
       context.operationResult = result

packages/store/src/commands/store/copy.test.ts

@@ -108,24 +108,24 @@ describe('Copy', () => {
     }
 
     test('should instantiate StoreCopyOperation for store-to-store copy', async () => {
-      await run(['--fromStore=source.myshopify.com', '--toStore=target.myshopify.com'])
+      await run(['--from-store=source.myshopify.com', '--to-store=target.myshopify.com'])
 
       expect(StoreCopyOperation).toHaveBeenCalledTimes(1)
       expect(mockExecute).toHaveBeenCalledWith('source.myshopify.com', 'target.myshopify.com', expect.any(Object))
     })
 
     test('should instantiate StoreExportOperation for store-to-file export', async () => {
-      await run(['--fromStore=source.myshopify.com', '--toFile=output.sqlite'])
+      await run(['--from-store=source.myshopify.com', '--to-file=output.sqlite'])
 
       expect(StoreExportOperation).toHaveBeenCalledTimes(1)
       expect(mockExecute).toHaveBeenCalledWith('source.myshopify.com', 'output.sqlite', expect.any(Object))
     })
 
-    test('should auto-generate toFile path when exporting without toFile parameter', async () => {
+    test('should auto-generate to-file path when exporting without to-file parameter', async () => {
       const mockDate = new Date('2024-01-01T12:00:00Z')
       vi.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
 
-      await run(['--fromStore=source.myshopify.com'])
+      await run(['--from-store=source.myshopify.com'])
 
       expect(StoreExportOperation).toHaveBeenCalledTimes(1)
       expect(mockExecute).toHaveBeenCalledWith(
@@ -135,11 +135,11 @@ describe('Copy', () => {
       )
     })
 
-    test('should sanitize domain name when auto-generating toFile path', async () => {
+    test('should sanitize domain name when auto-generating to-file path', async () => {
       const mockDate = new Date('2024-01-01T12:00:00Z')
       vi.spyOn(Date, 'now').mockReturnValue(mockDate.getTime())
 
-      await run(['--fromStore=test@store!.myshopify.com'])
+      await run(['--from-store=test@store!.myshopify.com'])
 
       expect(StoreExportOperation).toHaveBeenCalledTimes(1)
       expect(mockExecute).toHaveBeenCalledWith(
@@ -150,14 +150,14 @@ describe('Copy', () => {
     })
 
     test('should instantiate StoreImportOperation for file-to-store import', async () => {
-      await run(['--fromFile=input.sqlite', '--toStore=target.myshopify.com'])
+      await run(['--from-file=input.sqlite', '--to-store=target.myshopify.com'])
 
       expect(StoreImportOperation).toHaveBeenCalledTimes(1)
       expect(mockExecute).toHaveBeenCalledWith('input.sqlite', 'target.myshopify.com', expect.any(Object))
     })
 
-    test('should auto-generate toFile for export when only fromStore is provided', async () => {
-      await run(['--fromStore=source.myshopify.com'])
+    test('should auto-generate to-file for export when only from-store is provided', async () => {
+      await run(['--from-store=source.myshopify.com'])
 
       expect(StoreExportOperation).toHaveBeenCalledTimes(1)
       expect(mockExecute).toHaveBeenCalledWith(
@@ -168,7 +168,7 @@ describe('Copy', () => {
     })
 
     test('should show help when invalid flag combination', async () => {
-      await run(['--toFile=output.sqlite'])
+      await run(['--to-file=output.sqlite'])
 
       expect(loadHelpClass).toHaveBeenCalledWith(expect.any(Object))
       expect(mockShowHelp).toHaveBeenCalledWith(['store:copy'])
@@ -188,7 +188,7 @@ describe('Copy', () => {
     })
 
     test('should show help when mixing store and file flags', async () => {
-      await run(['--fromStore=source.myshopify.com', '--fromFile=input.sqlite', '--toStore=target.myshopify.com'])
+      await run(['--from-store=source.myshopify.com', '--from-file=input.sqlite', '--to-store=target.myshopify.com'])
 
       expect(loadHelpClass).toHaveBeenCalledWith(expect.any(Object))
       expect(mockShowHelp).toHaveBeenCalledWith(['store:copy'])
@@ -198,7 +198,7 @@ describe('Copy', () => {
     })
 
     test('should pass flags to the operation', async () => {
-      await run(['--fromStore=source.myshopify.com', '--toStore=target.myshopify.com', '--no-prompt', '--mock'])
+      await run(['--from-store=source.myshopify.com', '--to-store=target.myshopify.com', '--no-prompt', '--mock'])
 
       expect(mockExecute).toHaveBeenCalledWith(
         'source.myshopify.com',

packages/store/src/commands/store/copy.ts

@@ -32,8 +32,8 @@ export default class Copy extends BaseBDCommand {
     const bpSession = await apiClient.ensureAuthenticatedBusinessPlatform()
     const allOrgs = await apiClient.fetchOrganizations(bpSession)
 
-    const {fromStore, toStore, fromFile, _} = this.flags
-    let {toFile} = this.flags
+    const {'from-store': fromStore, 'to-store': toStore, 'from-file': fromFile} = this.flags
+    let {'to-file': toFile} = this.flags
     const operationMode = this.determineOperationMode(fromStore, toStore, fromFile, toFile)
 
     if (!operationMode) {

packages/store/src/lib/flags.ts

@@ -1,25 +1,25 @@
 import {Flags} from '@oclif/core'
 
 export const storeFlags = {
-  fromStore: Flags.string({
+  'from-store': Flags.string({
     description: 'The source store domain to copy/export data from (e.g., source.myshopify.com).',
     required: false,
     env: 'SHOPIFY_FLAG_FROM_STORE',
   }),
-  toStore: Flags.string({
+  'to-store': Flags.string({
     description: 'The target store domain to copy/import data to (e.g., target.myshopify.com).',
     required: false,
     env: 'SHOPIFY_FLAG_TO_STORE',
   }),
 }
 
 export const fileFlags = {
-  fromFile: Flags.string({
+  'from-file': Flags.string({
     description: 'The SQLite file to import data from.',
     required: false,
     env: 'SHOPIFY_FLAG_FROM_FILE',
   }),
-  toFile: Flags.string({
+  'to-file': Flags.string({
     description: 'The SQLite file path to export data to. Omit to auto-generate filename.',
     required: false,
     env: 'SHOPIFY_FLAG_TO_FILE',