Merge pull request #1 from lightspeedwp/copilot/scaffold-multi-block-plugin

WordPress multi-block plugin scaffold with CPT, taxonomies, SCF fields, and block bindings

Author: ashleyshaw

.gitignore

@@ -1,48 +1,40 @@
-# Wordpress - ignore core, configuration, examples, uploads and logs.
-# https://github.com/github/gitignore/blob/main/WordPress.gitignore
-
-# Core
-#
-# Note: if you want to stage/commit WP core files
-# you can delete this whole section/until Configuration.
-/wp-admin/
-/wp-content/index.php
-/wp-content/languages
-/wp-content/plugins/index.php
-/wp-content/themes/index.php
-/wp-includes/
-/index.php
-/license.txt
-/readme.html
-/wp-*.php
-/xmlrpc.php
-
-# Configuration
-wp-config.php
-
-# Example themes
-/wp-content/themes/twenty*/
-
-# Example plugin
-/wp-content/plugins/hello.php
-
-# Uploads
-/wp-content/uploads/
+# Dependencies
+node_modules/
+vendor/
+
+# Build output
+build/
 
 # Log files
 *.log
 
-# htaccess
-/.htaccess
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE files
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# WordPress environment
+.wp-env/
+
+# Composer lock (optional for scaffold)
+composer.lock
+
+# NPM package lock (optional for scaffold)
+package-lock.json
+
+# Local development
+.env
+.env.local
 
-# All plugins
-#
-# Note: If you wish to whitelist plugins,
-# uncomment the next line
-#/wp-content/plugins
+# Test coverage
+coverage/
+.phpunit.result.cache
 
-# All themes
-#
-# Note: If you wish to whitelist themes,
-# uncomment the next line
-#/wp-content/themes
+# Temporary files
+*.tmp
+*.temp

.wp-env.json

@@ -0,0 +1,21 @@
+{
+	"core": "WordPress/WordPress#6.5",
+	"phpVersion": "8.0",
+	"plugins": [
+		"."
+	],
+	"themes": [
+		"WordPress/theme-developer-resources#trunk"
+	],
+	"mappings": {
+		"wp-content/plugins/{{slug}}": "."
+	},
+	"config": {
+		"WP_DEBUG": true,
+		"WP_DEBUG_LOG": true,
+		"SCRIPT_DEBUG": true
+	},
+	"lifecycleScripts": {
+		"afterStart": "wp plugin activate {{slug}}"
+	}
+}

README.md

@@ -1 +1,179 @@
-# multi-block-plugin-scaffold
+# {{name}}
+
+{{description}}
+
+## Description
+
+A multi-block WordPress plugin scaffold with support for:
+
+- **Multiple Gutenberg blocks** (Card, Collection, Slider, Featured)
+- **Custom Post Types** with block templates
+- **Custom Taxonomies**
+- **Custom Fields** via Secure Custom Fields (SCF) with repeater support
+- **Block Patterns** and Template Parts
+- **Block Bindings** for dynamic content
+- **Shared React components** (Slider, PostSelector, Gallery, etc.)
+
+## Requirements
+
+- WordPress 6.5+
+- PHP 8.0+
+- Node.js 18+
+- [Secure Custom Fields](https://wordpress.org/plugins/secure-custom-fields/) plugin
+
+## Installation
+
+1. Clone this repository to your WordPress plugins directory:
+   ```bash
+   cd wp-content/plugins/
+   git clone https://github.com/{{author}}/{{slug}}.git
+   ```
+
+2. Install dependencies:
+   ```bash
+   cd {{slug}}
+   npm install
+   composer install
+   ```
+
+3. Build the plugin:
+   ```bash
+   npm run build
+   ```
+
+4. Activate the plugin in WordPress admin.
+
+## Development
+
+### Start development server
+
+```bash
+npm start
+```
+
+### Build for production
+
+```bash
+npm run build
+```
+
+### Linting
+
+```bash
+npm run lint:js
+npm run lint:css
+composer phpcs
+```
+
+### Testing
+
+```bash
+# JavaScript tests
+npm run test:unit
+
+# PHP tests
+composer test
+
+# E2E tests (requires wp-env)
+npm run test:e2e
+```
+
+### Local development with wp-env
+
+```bash
+npx @wordpress/env start
+```
+
+## Structure
+
+```
+{{slug}}/
+├── {{slug}}.php          # Main plugin file
+├── uninstall.php         # Cleanup on uninstall
+├── inc/                  # PHP classes
+│   ├── class-post-types.php
+│   ├── class-taxonomies.php
+│   ├── class-fields.php
+│   ├── class-repeater-fields.php
+│   ├── class-block-bindings.php
+│   ├── class-block-templates.php
+│   └── class-patterns.php
+├── src/                  # Source files
+│   ├── blocks/           # Block source
+│   │   ├── {{slug}}-card/
+│   │   ├── {{slug}}-collection/
+│   │   ├── {{slug}}-slider/
+│   │   └── {{slug}}-featured/
+│   ├── components/       # Shared components
+│   ├── hooks/            # Custom hooks
+│   └── utils/            # Utilities
+├── patterns/             # Block patterns
+├── templates/            # Block templates
+├── parts/                # Template parts
+└── tests/                # Test files
+```
+
+## Blocks
+
+### {{name}} Card
+
+Display a single post in a card layout.
+
+### {{name}} Collection
+
+Display a collection of posts with:
+- Grid, list, or slider layout
+- Taxonomy filtering
+- Featured posts filter
+- Pagination support
+
+### {{name}} Slider
+
+Display posts or custom slides in a carousel with:
+- Autoplay
+- Navigation dots and arrows
+- Touch/swipe support
+- Keyboard navigation
+
+### Featured {{name_plural}}
+
+Highlight featured posts with:
+- Grid layout
+- Featured-first layout
+- Hero layout
+
+## Custom Fields (SCF)
+
+The plugin registers the following custom fields:
+
+- **Subtitle** - Text field
+- **Featured** - True/False toggle
+- **Gallery** - Image gallery
+- **Related Posts** - Post relationship
+- **Slides** - Repeater field for slider content
+- **Sections** - Flexible content for page sections
+
+## Block Bindings
+
+Use the `{{namespace}}/fields` binding source to display field values:
+
+```html
+<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"{{namespace}}/fields","args":{"key":"{{slug}}_subtitle"}}}}} -->
+<p></p>
+<!-- /wp:paragraph -->
+```
+
+## Mustache Variables
+
+This scaffold uses Mustache-style variables for customization:
+
+| Variable | Description |
+|----------|-------------|
+| `{{slug}}` | Plugin slug (kebab-case) |
+| `{{name}}` | Plugin display name |
+| `{{namespace}}` | Plugin namespace |
+| `{{textdomain}}` | Text domain |
+
+## License
+
+{{license}}

bin/build.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+
+/**
+ * Build script for {{name}}.
+ *
+ * @package {{namespace}}
+ */
+
+const { execSync } = require( 'child_process' );
+const path = require( 'path' );
+const fs = require( 'fs' );
+
+const rootDir = path.resolve( __dirname, '..' );
+
+console.log( '🚀 Building {{name}}...\n' );
+
+// Clean build directory.
+const buildDir = path.join( rootDir, 'build' );
+if ( fs.existsSync( buildDir ) ) {
+	fs.rmSync( buildDir, { recursive: true } );
+}
+
+// Run webpack build.
+try {
+	execSync( 'npm run build', {
+		cwd: rootDir,
+		stdio: 'inherit',
+	} );
+} catch ( error ) {
+	console.error( '❌ Build failed:', error.message );
+	process.exit( 1 );
+}
+
+console.log( '\n✅ Build complete!' );