You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| scf-fields.instructions.md | Custom field development with SCF |
131
+
132
+
---
133
+
84
134
# {{name}} Multi-Block Plugin Instructions
85
135
86
136
You are an expert WordPress multi-block plugin developer working on {{name}}, a modern WordPress multi-block plugin scaffold with custom post types, taxonomies, and SCF field integration.
|[scf-fields.instructions.md](./scf-fields.instructions.md)| 19.8KB | Custom field development | When creating custom fields functionality |
150
-
|[reporting.instructions.md](./reporting.instructions.md)| 19.0KB | Reporting and documentation standards | When creating reports or documentation |
150
+
|[reporting.instructions.md](./reporting.instructions.md)| 19.0KB | Reporting and analysis documentation standards | When creating reports or documentation |
151
151
152
152
**Total Special Topics:** 4 files (~67KB)
153
153
@@ -348,28 +348,28 @@ Found an issue with an instruction file?
348
348
<summary>Click to expand full alphabetical listing</summary>
349
349
350
350
1.[_index.instructions.md](./_index.instructions.md) — This file
I'll help you generate a new WordPress multi-block plugin with custom post types, taxonomies, and Secure Custom Fields integration. This is a comprehensive scaffold for complex WordPress applications.
8
8
9
-
## 🔍 Repository Context Detection
9
+
## 🔍 Step 1: Repository Context Detection
10
10
11
11
**First, I need to understand your setup:**
12
12
13
13
Are you running this generator:
14
14
15
15
1.**In the `lightspeedwp/multi-block-plugin-scaffold` repository?**
16
-
- If YES → The plugin will be generated in an `output-plugin/` folder (excluded from git)
16
+
- If YES → The plugin will be generated in `generated-plugins/<slug>/` folder (excluded from git)
17
17
- This folder is for testing and development only
18
18
- You'll manually move the generated plugin to where you need it
19
+
- Use **Generator Mode** (default)
19
20
20
21
2.**In a NEW repository (created from the scaffold template)?**
21
22
- If YES → The generator will replace all mustache variables IN-PLACE in your current repository
22
23
- This will transform the scaffold INTO your actual plugin
23
-
- This action modifies your repository permanently (use `--in-place` mode)
24
+
- This action modifies your repository permanently
25
+
- Use **Template Mode** (`--in-place` flag)
24
26
25
27
**Please indicate which scenario applies to you before we proceed.**
26
28
27
-
## Quick Start Options
29
+
---
30
+
31
+
## 📋 Step 2: Configuration File Check
32
+
33
+
**Do you have a plugin configuration file?**
34
+
35
+
### ✅ YES - I Have a Config File
36
+
37
+
If you have a `plugin-config.json` file (or similar), I'll help you validate and use it:
28
38
29
-
### Option 1: Use Configuration File (Fastest)
39
+
1.**Provide the file path** to your configuration file
40
+
2.**I will validate it** against the schema (`.github/schemas/plugin-config.schema.json`)
41
+
3.**Review validation results:**
42
+
- ✅ If valid → Ask if you want to override any values → Generate plugin
43
+
- ❌ If invalid → Show errors → Offer to fix or use wizard
30
44
31
-
If you already have a configuration file that follows the schema (`.github/schemas/plugin-config.schema.json`), you can bypass the wizard entirely:
45
+
**Would you like to override any configuration values?**
46
+
- If YES → I'll ask which values you want to change
47
+
- If NO → I'll generate using your config file as-is
If you prefer step-by-step guidance, continue with the information gathering process below.
116
+
**Which wizard would you prefer?**
117
+
- Type **"simple"** for Simple Wizard
118
+
- Type **"advanced"** for Advanced Wizard
74
119
75
120
---
76
121
77
-
## Information Gathering Process
122
+
## 🧙 Interactive Wizard: Information Gathering
123
+
124
+
*(This section applies when using the Simple or Advanced Wizard)*
125
+
126
+
This scaffold requires detailed planning due to its complexity. I'll gather information in multiple stages to ensure your plugin is properly configured.
78
127
79
-
This scaffold requires more detailed planning due to its complexity. I'll gather information in multiple stages to ensure your plugin is properly configured.
128
+
**Wizard Types:**
129
+
-**Simple Wizard**: Covers Stages 1-5 with smart defaults
130
+
-**Advanced Wizard**: Covers all stages + additional variables (100+ total)
80
131
81
132
---
82
133
@@ -243,9 +294,21 @@ Which blocks should be created?
243
294
244
295
---
245
296
246
-
## Let's Begin!
297
+
## 🚀 Let's Begin!
298
+
299
+
**First, answer these two questions:**
300
+
301
+
1.**Repository Context**: Are you in the scaffold repo or a new repo?
302
+
- Type **"scaffold"** for Generator Mode (creates `generated-plugins/<slug>/`)
303
+
- Type **"new"** for Template Mode (modifies current directory with `--in-place`)
304
+
305
+
2.**Configuration File**: Do you have a plugin-config.json file?
306
+
- Type **"yes"** and provide the file path
307
+
- Type **"no"** to use the wizard
308
+
309
+
---
247
310
248
-
**Please provide your answers for Stage 1:**
311
+
**If using the wizard, provide your answers for Stage 1:**
249
312
250
313
1. Plugin Name:
251
314
2. Plugin Slug:
@@ -370,7 +433,6 @@ The plugin will automatically declare SCF as a dependency using the WordPress 6.
0 commit comments