Merge pull request #68 from WebDevStudios/feature/auto-cursor-generation

auto generate cursor rules from scripts

Author: khleomix

.gitignore

@@ -29,3 +29,6 @@ build/
 #tests
 pa11y-ci-report/
 phpcs-report.txt
+
+# cursor
+.cursor/

composer.json

@@ -38,6 +38,9 @@
     ],
     "phpcs-fix": [
       "@php vendor/bin/phpcbf --report=summary,source"
+    ],
+    "post-install-cmd": [
+      "./scripts/update-cursorrules.sh"
     ]
   },
   "version": "1.3.0"

package-lock.json

@@ -117,11 +117,12 @@
 		"lint:php": "composer run-script phpcs",
 		"lint:pkg-json": "wp-scripts lint-pkg-json",
 		"packages-update": "npx npm-check-updates -u && npm install && npm dedupe && npm audit fix",
-		"postinstall": "npx lefthook install && git config --local core.hooksPath .git/hooks",
+		"postinstall": "npx lefthook install && git config --local core.hooksPath .git/hooks && ./scripts/update-cursorrules.sh",
 		"preinstall": "npx cross-env npm_config_legacy_peer_deps=true",
 		"reset": "rm -rf node_modules vendor build blocks package-lock.json composer.lock",
 		"setup": "npm run reset && npm i && composer i && npm run build",
 		"start": "rm -rf build blocks && npx cross-env NODE_ENV=development wp-scripts start",
+		"update-cursorrules": "./scripts/update-cursorrules.sh",
 		"version-update": "dotenv node updateVersion.js"
 	},
 	"lint-staged": {

package.json

@@ -0,0 +1,123 @@
+# Scripts Directory
+
+This directory contains utility scripts for the WDS Block Theme project.
+
+## update-cursorrules.sh
+
+This script automatically extracts the PHP version from `composer.json` and updates the Cursor rules files in the `.cursor/rules/` directory to ensure Cursor uses the correct PHP version for code analysis and suggestions.
+
+### Features
+
+- **Automatic PHP Version Detection**: Uses `jq` to parse `composer.json` and extract the PHP version
+- **Multiple Version Sources**: Checks multiple locations in composer.json:
+  - `config.platform.php` (preferred)
+  - `require-dev.php`
+  - `require.php`
+- **Version String Cleaning**: Removes version constraints (>=, ^, ~, etc.) to get the base version
+- **Modern Cursor Rules Structure**: Creates separate `.mdc` files in `.cursor/rules/` directory:
+  - `dependency-management.mdc` - PHP version and package management
+  - `development-workflow.mdc` - Project structure and workflow
+  - `javascript-standards.mdc` - Frontend development standards
+  - `php-code-standards.mdc` - Comprehensive PHP coding standards
+  - `theme-development.mdc` - WordPress theme development guidelines
+
+### Prerequisites
+
+- `jq` must be installed on your system
+  - macOS: `brew install jq`
+  - Ubuntu/Debian: `sudo apt-get install jq`
+  - Windows: Download from https://stedolan.github.io/jq/download/
+
+### Usage
+
+#### Manual Execution
+```bash
+./scripts/update-cursorrules.sh
+```
+
+#### Via NPM Script
+```bash
+npm run update-cursorrules
+```
+
+#### Automatic Execution
+The script runs automatically after:
+- `npm install` (via postinstall script)
+- `composer install` (via post-install-cmd script)
+
+### Output
+
+The script creates/updates files in `.cursor/rules/` directory:
+
+```
+.cursor/rules/
+├── dependency-management.mdc    # PHP version and package management
+├── development-workflow.mdc     # Project structure and workflow
+├── javascript-standards.mdc     # Frontend development standards
+├── php-code-standards.mdc       # Comprehensive PHP coding standards
+└── theme-development.mdc        # WordPress theme development guidelines
+```
+
+Each file contains specific guidelines for different aspects of development:
+
+#### dependency-management.mdc
+- PHP version configuration (automatically updated)
+- Package management guidelines
+- Development environment setup
+- Build process instructions
+
+#### development-workflow.mdc
+- Project structure overview
+- Code standards and quality assurance
+- Testing and error handling
+- Performance optimization
+
+#### javascript-standards.mdc
+- Modern JavaScript (ES6+) standards
+- Block development guidelines
+- Code style and documentation
+- Testing and build processes
+
+#### php-code-standards.mdc
+- WordPress PHP Coding Standards (WPCS)
+- Code style and naming conventions
+- Security and performance guidelines
+- Testing and error handling
+- Database best practices
+
+#### theme-development.mdc
+- WordPress block theme standards
+- Theme structure and setup
+- Block patterns and templates
+- Internationalization and accessibility
+- Performance optimization
+
+### Error Handling
+
+The script includes comprehensive error handling:
+- Checks for `jq` installation
+- Validates `composer.json` exists
+- Provides helpful error messages if PHP version cannot be extracted
+- Uses colored output for better readability
+
+### Integration
+
+This script is integrated into the project's build process:
+
+1. **NPM Integration**: Added to `package.json` postinstall script
+2. **Composer Integration**: Added to `composer.json` post-install-cmd script
+3. **Manual Script**: Available as `npm run update-cursorrules`
+
+### Benefits
+
+- **Consistent PHP Version**: Ensures Cursor always uses the correct PHP version
+- **Organized Rules**: Separates concerns into focused rule files
+- **Automatic Updates**: No manual intervention required
+- **Project-Specific Rules**: Tailored to WordPress block theme development
+- **Modern PHP Features**: Leverages PHP 8.2+ features in suggestions
+- **WordPress Standards**: Includes WordPress-specific coding guidelines
+- **Comprehensive Coverage**: Covers all aspects of theme development
+
+## test-update-cursorrules.sh
+
+This script is used to test the extraction and update logic for the Cursor rules automation.

scripts/README.md

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# Test script to verify PHP version extraction from different composer.json formats
+
+set -e
+
+# Colors for output
+GREEN='\033[0;32m'
+RED='\033[0;31m'
+NC='\033[0m' # No Color
+
+print_test() {
+    echo -e "${GREEN}[TEST]${NC} $1"
+}
+
+print_result() {
+    if [ $1 -eq 0 ]; then
+        echo -e "${GREEN}[PASS]${NC} $2"
+    else
+        echo -e "${RED}[FAIL]${NC} $2"
+    fi
+}
+
+# Test 1: Platform config format (current format)
+print_test "Testing platform config format..."
+echo '{"config": {"platform": {"php": "8.2"}}}' > test-composer.json
+PHP_VERSION=$(jq -r '.config.platform.php // empty' test-composer.json 2>/dev/null)
+PHP_VERSION=$(echo "$PHP_VERSION" | sed 's/[^0-9.]//g')
+if [ "$PHP_VERSION" = "8.2" ]; then
+    print_result 0 "Platform config format works"
+else
+    print_result 1 "Platform config format failed: got $PHP_VERSION"
+fi
+
+# Test 2: Require-dev format
+print_test "Testing require-dev format..."
+echo '{"require-dev": {"php": ">=8.2"}}' > test-composer.json
+PHP_VERSION=$(jq -r '.require-dev.php // empty' test-composer.json 2>/dev/null)
+PHP_VERSION=$(echo "$PHP_VERSION" | sed 's/[^0-9.]//g')
+if [ "$PHP_VERSION" = "8.2" ]; then
+    print_result 0 "Require-dev format works"
+else
+    print_result 1 "Require-dev format failed: got $PHP_VERSION"
+fi
+
+# Test 3: Require format
+print_test "Testing require format..."
+echo '{"require": {"php": "^8.2.0"}}' > test-composer.json
+PHP_VERSION=$(jq -r '.require.php // empty' test-composer.json 2>/dev/null)
+PHP_VERSION=$(echo "$PHP_VERSION" | sed 's/[^0-9.]//g')
+if [ "$PHP_VERSION" = "8.2.0" ]; then
+    print_result 0 "Require format works"
+else
+    print_result 1 "Require format failed: got $PHP_VERSION"
+fi
+
+# Test 4: Simple version constraint
+print_test "Testing simple version constraint..."
+echo '{"require": {"php": "~8.2.0"}}' > test-composer.json
+PHP_VERSION=$(jq -r '.require.php // empty' test-composer.json 2>/dev/null)
+PHP_VERSION=$(echo "$PHP_VERSION" | sed 's/[^0-9.]//g')
+if [ "$PHP_VERSION" = "8.2.0" ]; then
+    print_result 0 "Simple version constraint works"
+else
+    print_result 1 "Simple version constraint failed: got $PHP_VERSION"
+fi
+
+# Cleanup
+rm -f test-composer.json
+
+print_test "All tests completed!"