From ff4e09b105c6274537b2456bac1dcd6937527a89 Mon Sep 17 00:00:00 2001
From: James Meng <james.meng@shopify.com>
Date: Wed, 11 Dec 2024 17:26:45 -0800
Subject: [PATCH] Validate that generate path points to a valid theme
 directories

---
 packages/cli/README.md                        |  9 +++--
 packages/cli/oclif.manifest.json              | 24 ++++++++++++
 .../cli/commands/theme/generate/block.test.ts | 39 +++++++++++++++++++
 .../src/cli/commands/theme/generate/block.ts  | 17 +++++++-
 .../commands/theme/generate/section.test.ts   | 39 +++++++++++++++++++
 .../cli/commands/theme/generate/section.ts    | 17 +++++++-
 .../commands/theme/generate/template.test.ts  | 39 +++++++++++++++++++
 .../cli/commands/theme/generate/template.ts   | 17 +++++++-
 8 files changed, 195 insertions(+), 6 deletions(-)
 create mode 100644 packages/theme/src/cli/commands/theme/generate/block.test.ts
 create mode 100644 packages/theme/src/cli/commands/theme/generate/section.test.ts
 create mode 100644 packages/theme/src/cli/commands/theme/generate/template.test.ts

diff --git a/packages/cli/README.md b/packages/cli/README.md
index 7b071557cf4..0e3940be1dc 100644
--- a/packages/cli/README.md
+++ b/packages/cli/README.md
@@ -1904,10 +1904,11 @@ Creates and adds a new block file to your local theme directory
 
 ```
 USAGE
-  $ shopify theme generate block [-n <value>] [--no-color] [--path <value>] [-t text|image|video|product|collection]
+  $ shopify theme generate block [-f] [-n <value>] [--no-color] [--path <value>] [-t text|image|video|product|collection]
     [--verbose]
 
 FLAGS
+  -f, --force          Overwrite existing files
   -n, --name=<value>   Name of the block
   -t, --type=<option>  Type of block to generate
                        <options: text|image|video|product|collection>
@@ -1932,10 +1933,11 @@ Creates and adds a new section file to your local theme directory
 
 ```
 USAGE
-  $ shopify theme generate section [-n <value>] [--no-color] [--path <value>] [-t
+  $ shopify theme generate section [-f] [-n <value>] [--no-color] [--path <value>] [-t
     featured-collection|image-with-text|rich-text|custom] [--verbose]
 
 FLAGS
+  -f, --force          Overwrite existing files
   -n, --name=<value>   Name of the section
   -t, --type=<option>  Type of section to generate
                        <options: featured-collection|image-with-text|rich-text|custom>
@@ -1961,10 +1963,11 @@ Creates and adds a new template file to your local theme directory
 
 ```
 USAGE
-  $ shopify theme generate template [-n <value>] [--no-color] [--path <value>] [-t
+  $ shopify theme generate template [-f] [-n <value>] [--no-color] [--path <value>] [-t
     product|collection|page|blog|article|custom] [--verbose]
 
 FLAGS
+  -f, --force          Overwrite existing files
   -n, --name=<value>   Name of the template
   -t, --type=<option>  Type of template to generate
                        <options: product|collection|page|blog|article|custom>
diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json
index a04a883b3ed..8cc8c081e6d 100644
--- a/packages/cli/oclif.manifest.json
+++ b/packages/cli/oclif.manifest.json
@@ -5326,6 +5326,14 @@
       "description": "Creates a new \"theme block\" (https://shopify.dev/docs/themes/architecture/blocks) in your local theme directory.\n\n  The block is created in the `blocks` directory with the basic structure needed, including schema and settings.\n\n  You can specify the type of block to generate using the `--type` flag. The block will be created with appropriate default settings based on the type.",
       "descriptionWithMarkdown": "Creates a new [theme block](https://shopify.dev/docs/themes/architecture/blocks) in your local theme directory.\n\n  The block is created in the `blocks` directory with the basic structure needed, including schema and settings.\n\n  You can specify the type of block to generate using the `--type` flag. The block will be created with appropriate default settings based on the type.",
       "flags": {
+        "force": {
+          "allowNo": false,
+          "char": "f",
+          "description": "Overwrite existing files",
+          "env": "SHOPIFY_FLAG_THEME_GENERATE_BLOCK_FORCE",
+          "name": "force",
+          "type": "boolean"
+        },
         "name": {
           "char": "n",
           "description": "Name of the block",
@@ -5396,6 +5404,14 @@
       "description": "Creates a new \"theme section\" (https://shopify.dev/docs/themes/architecture/sections) in your local theme directory.\n\n  The section is created in the `sections` directory with the basic structure needed, including schema, settings, and blocks.\n\n  You can specify the type of section to generate using the `--type` flag. The section will be created with appropriate default settings and blocks based on the type.",
       "descriptionWithMarkdown": "Creates a new [theme section](https://shopify.dev/docs/themes/architecture/sections) in your local theme directory.\n\n  The section is created in the `sections` directory with the basic structure needed, including schema, settings, and blocks.\n\n  You can specify the type of section to generate using the `--type` flag. The section will be created with appropriate default settings and blocks based on the type.",
       "flags": {
+        "force": {
+          "allowNo": false,
+          "char": "f",
+          "description": "Overwrite existing files",
+          "env": "SHOPIFY_FLAG_THEME_GENERATE_SECTION_FORCE",
+          "name": "force",
+          "type": "boolean"
+        },
         "name": {
           "char": "n",
           "description": "Name of the section",
@@ -5465,6 +5481,14 @@
       "description": "Creates a new \"theme template\" (https://shopify.dev/docs/themes/architecture/templates) in your local theme directory.\n\n  The template is created in the `templates` directory with the basic structure needed, including layout and content sections.\n\n  You can specify the type of template to generate using the `--type` flag. The template will be created with appropriate default sections based on the type.",
       "descriptionWithMarkdown": "Creates a new [theme template](https://shopify.dev/docs/themes/architecture/templates) in your local theme directory.\n\n  The template is created in the `templates` directory with the basic structure needed, including layout and content sections.\n\n  You can specify the type of template to generate using the `--type` flag. The template will be created with appropriate default sections based on the type.",
       "flags": {
+        "force": {
+          "allowNo": false,
+          "char": "f",
+          "description": "Overwrite existing files",
+          "env": "SHOPIFY_FLAG_THEME_GENERATE_TEMPLATE_FORCE",
+          "name": "force",
+          "type": "boolean"
+        },
         "name": {
           "char": "n",
           "description": "Name of the template",
diff --git a/packages/theme/src/cli/commands/theme/generate/block.test.ts b/packages/theme/src/cli/commands/theme/generate/block.test.ts
new file mode 100644
index 00000000000..000b841d073
--- /dev/null
+++ b/packages/theme/src/cli/commands/theme/generate/block.test.ts
@@ -0,0 +1,39 @@
+import GenerateBlock from './block.js'
+import {hasRequiredThemeDirectories} from '../../../utilities/theme-fs.js'
+import {describe, expect, test, vi} from 'vitest'
+import {renderWarning} from '@shopify/cli-kit/node/ui'
+import {cwd} from '@shopify/cli-kit/node/path'
+
+vi.mock('../../../utilities/theme-fs.js')
+vi.mock('@shopify/cli-kit/node/ui')
+
+describe('GenerateBlock', () => {
+  const path = cwd()
+  test('validates theme directory structure by default', async () => {
+    // Given
+    vi.mocked(hasRequiredThemeDirectories).mockResolvedValue(false)
+
+    // When
+    await GenerateBlock.run(['--path', path])
+
+    // Then
+    expect(hasRequiredThemeDirectories).toHaveBeenCalledWith(path)
+    expect(renderWarning).toHaveBeenCalledWith({
+      body: [
+        'The current directory does not contain the required theme directories (config, layout, sections, templates).',
+      ],
+    })
+  })
+
+  test('skips directory validation when force flag is used', async () => {
+    // Given
+    vi.mocked(hasRequiredThemeDirectories).mockResolvedValue(false)
+
+    // When
+    await GenerateBlock.run(['--path', path, '--force'])
+
+    // Then
+    expect(hasRequiredThemeDirectories).not.toHaveBeenCalled()
+    expect(renderWarning).not.toHaveBeenCalled()
+  })
+})
diff --git a/packages/theme/src/cli/commands/theme/generate/block.ts b/packages/theme/src/cli/commands/theme/generate/block.ts
index 3c66d8afef9..a770584e6b0 100644
--- a/packages/theme/src/cli/commands/theme/generate/block.ts
+++ b/packages/theme/src/cli/commands/theme/generate/block.ts
@@ -1,8 +1,9 @@
 import {themeFlags} from '../../../flags.js'
 import ThemeCommand from '../../../utilities/theme-command.js'
+import {hasRequiredThemeDirectories} from '../../../utilities/theme-fs.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {renderSelectPrompt, renderSuccess, renderTextPrompt} from '@shopify/cli-kit/node/ui'
+import {renderSelectPrompt, renderSuccess, renderTextPrompt, renderWarning} from '@shopify/cli-kit/node/ui'
 
 const BLOCK_TYPES = ['text', 'image', 'video', 'product', 'collection']
 
@@ -31,11 +32,25 @@ export default class GenerateBlock extends ThemeCommand {
       options: [...BLOCK_TYPES],
       env: 'SHOPIFY_FLAG_THEME_GENERATE_BLOCK_TYPE',
     }),
+    force: Flags.boolean({
+      char: 'f',
+      description: 'Overwrite existing files',
+      env: 'SHOPIFY_FLAG_THEME_GENERATE_BLOCK_FORCE',
+    }),
   }
 
   async run(): Promise<void> {
     const {flags} = await this.parse(GenerateBlock)
 
+    if (!flags.force && !(await hasRequiredThemeDirectories(flags.path))) {
+      renderWarning({
+        body: [
+          'The current directory does not contain the required theme directories (config, layout, sections, templates).',
+        ],
+      })
+      return
+    }
+
     const name =
       flags.name ??
       (await renderTextPrompt({
diff --git a/packages/theme/src/cli/commands/theme/generate/section.test.ts b/packages/theme/src/cli/commands/theme/generate/section.test.ts
new file mode 100644
index 00000000000..52c93ba77b8
--- /dev/null
+++ b/packages/theme/src/cli/commands/theme/generate/section.test.ts
@@ -0,0 +1,39 @@
+import GenerateSection from './section.js'
+import {hasRequiredThemeDirectories} from '../../../utilities/theme-fs.js'
+import {describe, expect, test, vi} from 'vitest'
+import {renderWarning} from '@shopify/cli-kit/node/ui'
+import {cwd} from '@shopify/cli-kit/node/path'
+
+vi.mock('../../../utilities/theme-fs.js')
+vi.mock('@shopify/cli-kit/node/ui')
+
+describe('GenerateSection', () => {
+  const path = cwd()
+  test('validates theme directory structure by default', async () => {
+    // Given
+    vi.mocked(hasRequiredThemeDirectories).mockResolvedValue(false)
+
+    // When
+    await GenerateSection.run(['--path', path])
+
+    // Then
+    expect(hasRequiredThemeDirectories).toHaveBeenCalledWith(path)
+    expect(renderWarning).toHaveBeenCalledWith({
+      body: [
+        'The current directory does not contain the required theme directories (config, layout, sections, templates).',
+      ],
+    })
+  })
+
+  test('skips directory validation when force flag is used', async () => {
+    // Given
+    vi.mocked(hasRequiredThemeDirectories).mockResolvedValue(false)
+
+    // When
+    await GenerateSection.run(['--path', path, '--force'])
+
+    // Then
+    expect(hasRequiredThemeDirectories).not.toHaveBeenCalled()
+    expect(renderWarning).not.toHaveBeenCalled()
+  })
+})
diff --git a/packages/theme/src/cli/commands/theme/generate/section.ts b/packages/theme/src/cli/commands/theme/generate/section.ts
index 2d3b43eb14b..aa8767bdb68 100644
--- a/packages/theme/src/cli/commands/theme/generate/section.ts
+++ b/packages/theme/src/cli/commands/theme/generate/section.ts
@@ -1,8 +1,9 @@
 import {themeFlags} from '../../../flags.js'
 import ThemeCommand from '../../../utilities/theme-command.js'
+import {hasRequiredThemeDirectories} from '../../../utilities/theme-fs.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {renderSelectPrompt, renderSuccess, renderTextPrompt} from '@shopify/cli-kit/node/ui'
+import {renderSelectPrompt, renderSuccess, renderTextPrompt, renderWarning} from '@shopify/cli-kit/node/ui'
 
 const SECTION_TYPES = ['featured-collection', 'image-with-text', 'rich-text', 'custom']
 
@@ -31,11 +32,25 @@ export default class GenerateSection extends ThemeCommand {
       options: [...SECTION_TYPES],
       env: 'SHOPIFY_FLAG_THEME_GENERATE_SECTION_TYPE',
     }),
+    force: Flags.boolean({
+      char: 'f',
+      description: 'Overwrite existing files',
+      env: 'SHOPIFY_FLAG_THEME_GENERATE_SECTION_FORCE',
+    }),
   }
 
   async run(): Promise<void> {
     const {flags} = await this.parse(GenerateSection)
 
+    if (!flags.force && !(await hasRequiredThemeDirectories(flags.path))) {
+      renderWarning({
+        body: [
+          'The current directory does not contain the required theme directories (config, layout, sections, templates).',
+        ],
+      })
+      return
+    }
+
     const name =
       flags.name ??
       (await renderTextPrompt({
diff --git a/packages/theme/src/cli/commands/theme/generate/template.test.ts b/packages/theme/src/cli/commands/theme/generate/template.test.ts
new file mode 100644
index 00000000000..f21540b7332
--- /dev/null
+++ b/packages/theme/src/cli/commands/theme/generate/template.test.ts
@@ -0,0 +1,39 @@
+import GenerateTemplate from './template.js'
+import {hasRequiredThemeDirectories} from '../../../utilities/theme-fs.js'
+import {describe, expect, test, vi} from 'vitest'
+import {renderWarning} from '@shopify/cli-kit/node/ui'
+import {cwd} from '@shopify/cli-kit/node/path'
+
+vi.mock('../../../utilities/theme-fs.js')
+vi.mock('@shopify/cli-kit/node/ui')
+
+describe('GenerateTemplate', () => {
+  const path = cwd()
+  test('validates theme directory structure by default', async () => {
+    // Given
+    vi.mocked(hasRequiredThemeDirectories).mockResolvedValue(false)
+
+    // When
+    await GenerateTemplate.run(['--path', path])
+
+    // Then
+    expect(hasRequiredThemeDirectories).toHaveBeenCalledWith(path)
+    expect(renderWarning).toHaveBeenCalledWith({
+      body: [
+        'The current directory does not contain the required theme directories (config, layout, sections, templates).',
+      ],
+    })
+  })
+
+  test('skips directory validation when force flag is used', async () => {
+    // Given
+    vi.mocked(hasRequiredThemeDirectories).mockResolvedValue(false)
+
+    // When
+    await GenerateTemplate.run(['--path', path, '--force'])
+
+    // Then
+    expect(hasRequiredThemeDirectories).not.toHaveBeenCalled()
+    expect(renderWarning).not.toHaveBeenCalled()
+  })
+})
diff --git a/packages/theme/src/cli/commands/theme/generate/template.ts b/packages/theme/src/cli/commands/theme/generate/template.ts
index 85837bda898..4e66c0abfe3 100644
--- a/packages/theme/src/cli/commands/theme/generate/template.ts
+++ b/packages/theme/src/cli/commands/theme/generate/template.ts
@@ -1,9 +1,10 @@
 import {TEMPLATE_TYPES, promptForType} from '../../../utilities/generator.js'
 import {themeFlags} from '../../../flags.js'
 import ThemeCommand from '../../../utilities/theme-command.js'
+import {hasRequiredThemeDirectories} from '../../../utilities/theme-fs.js'
 import {Flags} from '@oclif/core'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
-import {renderSuccess, renderTextPrompt} from '@shopify/cli-kit/node/ui'
+import {renderSuccess, renderTextPrompt, renderWarning} from '@shopify/cli-kit/node/ui'
 
 export default class GenerateTemplate extends ThemeCommand {
   static summary = 'Creates and adds a new template file to your local theme directory'
@@ -30,11 +31,25 @@ export default class GenerateTemplate extends ThemeCommand {
       options: [...TEMPLATE_TYPES],
       env: 'SHOPIFY_FLAG_THEME_GENERATE_TEMPLATE_TYPE',
     }),
+    force: Flags.boolean({
+      char: 'f',
+      description: 'Overwrite existing files',
+      env: 'SHOPIFY_FLAG_THEME_GENERATE_TEMPLATE_FORCE',
+    }),
   }
 
   async run(): Promise<void> {
     const {flags} = await this.parse(GenerateTemplate)
 
+    if (!flags.force && !(await hasRequiredThemeDirectories(flags.path))) {
+      renderWarning({
+        body: [
+          'The current directory does not contain the required theme directories (config, layout, sections, templates).',
+        ],
+      })
+      return
+    }
+
     const name =
       flags.name ??
       (await renderTextPrompt({