heraspec 0.1.13 → 0.1.14

package/dist/core/templates/skills/wordpress-plugin-standard/templates/plugin-main.php

@@ -1,169 +1,169 @@
-<?php
-/**
- * Plugin Name:       {{plugin_name}}
- * Description:       A high-quality WordPress plugin following WP.org standards.
- * Version:           1.0.0
- * Author:            Your Name
- * Author URI:        https://example.com
- * License:           GPL-2.0-or-later
- * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
- * Text Domain:       {{text_domain}}
- * Domain Path:       /languages
- *
- * @package           {{namespace}}
- */
-
-// If this file is called directly, abort.
-if ( ! defined( 'ABSPATH' ) ) {
-	exit;
-}
-
-/**
- * The core plugin class.
- */
-class {{namespace}}\Main {
-
-	/**
-	 * Instance of this class.
-	 *
-	 * @var object
-	 */
-	protected static $instance = null;
-
-	/**
-	 * Initialize the plugin.
-	 */
-	public function __construct() {
-		$this->define_constants();
-		$this->includes();
-		$this->init_hooks();
-	}
-
-	/**
-	 * Return an instance of this class.
-	 */
-	public static function get_instance() {
-		if ( null === self::$instance ) {
-			self::$instance = new self();
-		}
-		return self::$instance;
-	}
-
-	/**
-	 * Define constants.
-	 */
-	private function define_constants() {
-		define( '{{prefix|upper}}VERSION', '1.0.0' );
-		define( '{{prefix|upper}}PATH', plugin_dir_path( __FILE__ ) );
-		define( '{{prefix|upper}}URL', plugin_dir_url( __FILE__ ) );
-	}
-
-	/**
-	 * Include required files.
-	 */
-	private function includes() {
-		// Include admin classes, helpers, etc.
-	}
-
-	/**
-	 * Initialize hooks.
-	 */
-	private function init_hooks() {
-		add_action( 'admin_menu', [ $this, 'add_menu_pages' ] );
-		add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_admin_assets' ] );
-		
-		// Activation / Deactivation hooks
-		register_activation_hook( __FILE__, [ $this, 'activate' ] );
-		register_deactivation_hook( __FILE__, [ $this, 'deactivate' ] );
-	}
-
-	/**
-	 * Add Admin Menu Pages.
-	 */
-	public function add_menu_pages() {
-		add_menu_page(
-			__( '{{plugin_name}}', '{{text_domain}}' ),
-			__( '{{plugin_name}}', '{{text_domain}}' ),
-			'manage_options',
-			'{{plugin_slug}}',
-			[ $this, 'render_dashboard_page' ],
-			'dashicons-admin-generic',
-			100
-		);
-
-		add_submenu_page(
-			'{{plugin_slug}}',
-			__( 'Dashboard', '{{text_domain}}' ),
-			__( 'Dashboard', '{{text_domain}}' ),
-			'manage_options',
-			'{{plugin_slug}}',
-			[ $this, 'render_dashboard_page' ]
-		);
-
-		add_submenu_page(
-			'{{plugin_slug}}',
-			__( 'Settings', '{{text_domain}}' ),
-			__( 'Settings', '{{text_domain}}' ),
-			'manage_options',
-			'{{plugin_slug}}-settings',
-			[ $this, 'render_settings_page' ]
-		);
-	}
-
-	/**
-	 * Enqueue Admin Assets.
-	 */
-	public function enqueue_admin_assets( $hook ) {
-		// Only load on our plugin pages
-		if ( strpos( $hook, '{{plugin_slug}}' ) === false ) {
-			return;
-		}
-
-		wp_enqueue_style( '{{plugin_slug}}-admin', {{prefix|upper}}URL . 'assets/css/admin.css', [], {{prefix|upper}}VERSION );
-		wp_enqueue_script( '{{plugin_slug}}-admin', {{prefix|upper}}URL . 'assets/js/admin.js', [ 'jquery' ], {{prefix|upper}}VERSION, true );
-		
-		wp_localize_script( '{{plugin_slug}}-admin', '{{prefix}}params', [
-			'ajax_url' => admin_url( 'admin-ajax.php' ),
-			'nonce'    => wp_create_nonce( '{{prefix}}nonce' ),
-		]);
-	}
-
-	/**
-	 * Render Dashboard Page.
-	 */
-	public function render_dashboard_page() {
-		// Include template file
-		include {{prefix|upper}}PATH . 'templates/admin-dashboard.php';
-	}
-
-	/**
-	 * Render Settings Page.
-	 */
-	public function render_settings_page() {
-		// Include template file
-		include {{prefix|upper}}PATH . 'templates/admin-settings.php';
-	}
-
-	/**
-	 * Activation logic.
-	 */
-	public function activate() {
-		// Setup database tables, default options, etc.
-	}
-
-	/**
-	 * Deactivation logic.
-	 */
-	public function deactivate() {
-		// Clear scheduled tasks, etc.
-	}
-}
-
-/**
- * Initialize the plugin.
- */
-function {{prefix}}init() {
-	return {{namespace}}\Main::get_instance();
-}
-
-add_action( 'plugins_loaded', '{{prefix}}init' );
+<?php
+/**
+ * Plugin Name:       {{plugin_name}}
+ * Description:       A high-quality WordPress plugin following WP.org standards.
+ * Version:           1.0.0
+ * Author:            Your Name
+ * Author URI:        https://example.com
+ * License:           GPL-2.0-or-later
+ * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
+ * Text Domain:       {{text_domain}}
+ * Domain Path:       /languages
+ *
+ * @package           {{namespace}}
+ */
+
+// If this file is called directly, abort.
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/**
+ * The core plugin class.
+ */
+class {{namespace}}\Main {
+
+	/**
+	 * Instance of this class.
+	 *
+	 * @var object
+	 */
+	protected static $instance = null;
+
+	/**
+	 * Initialize the plugin.
+	 */
+	public function __construct() {
+		$this->define_constants();
+		$this->includes();
+		$this->init_hooks();
+	}
+
+	/**
+	 * Return an instance of this class.
+	 */
+	public static function get_instance() {
+		if ( null === self::$instance ) {
+			self::$instance = new self();
+		}
+		return self::$instance;
+	}
+
+	/**
+	 * Define constants.
+	 */
+	private function define_constants() {
+		define( '{{prefix|upper}}VERSION', '1.0.0' );
+		define( '{{prefix|upper}}PATH', plugin_dir_path( __FILE__ ) );
+		define( '{{prefix|upper}}URL', plugin_dir_url( __FILE__ ) );
+	}
+
+	/**
+	 * Include required files.
+	 */
+	private function includes() {
+		// Include admin classes, helpers, etc.
+	}
+
+	/**
+	 * Initialize hooks.
+	 */
+	private function init_hooks() {
+		add_action( 'admin_menu', [ $this, 'add_menu_pages' ] );
+		add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_admin_assets' ] );
+		
+		// Activation / Deactivation hooks
+		register_activation_hook( __FILE__, [ $this, 'activate' ] );
+		register_deactivation_hook( __FILE__, [ $this, 'deactivate' ] );
+	}
+
+	/**
+	 * Add Admin Menu Pages.
+	 */
+	public function add_menu_pages() {
+		add_menu_page(
+			__( '{{plugin_name}}', '{{text_domain}}' ),
+			__( '{{plugin_name}}', '{{text_domain}}' ),
+			'manage_options',
+			'{{plugin_slug}}',
+			[ $this, 'render_dashboard_page' ],
+			'dashicons-admin-generic',
+			100
+		);
+
+		add_submenu_page(
+			'{{plugin_slug}}',
+			__( 'Dashboard', '{{text_domain}}' ),
+			__( 'Dashboard', '{{text_domain}}' ),
+			'manage_options',
+			'{{plugin_slug}}',
+			[ $this, 'render_dashboard_page' ]
+		);
+
+		add_submenu_page(
+			'{{plugin_slug}}',
+			__( 'Settings', '{{text_domain}}' ),
+			__( 'Settings', '{{text_domain}}' ),
+			'manage_options',
+			'{{plugin_slug}}-settings',
+			[ $this, 'render_settings_page' ]
+		);
+	}
+
+	/**
+	 * Enqueue Admin Assets.
+	 */
+	public function enqueue_admin_assets( $hook ) {
+		// Only load on our plugin pages
+		if ( strpos( $hook, '{{plugin_slug}}' ) === false ) {
+			return;
+		}
+
+		wp_enqueue_style( '{{plugin_slug}}-admin', {{prefix|upper}}URL . 'assets/css/admin.css', [], {{prefix|upper}}VERSION );
+		wp_enqueue_script( '{{plugin_slug}}-admin', {{prefix|upper}}URL . 'assets/js/admin.js', [ 'jquery' ], {{prefix|upper}}VERSION, true );
+		
+		wp_localize_script( '{{plugin_slug}}-admin', '{{prefix}}params', [
+			'ajax_url' => admin_url( 'admin-ajax.php' ),
+			'nonce'    => wp_create_nonce( '{{prefix}}nonce' ),
+		]);
+	}
+
+	/**
+	 * Render Dashboard Page.
+	 */
+	public function render_dashboard_page() {
+		// Include template file
+		include {{prefix|upper}}PATH . 'templates/admin-dashboard.php';
+	}
+
+	/**
+	 * Render Settings Page.
+	 */
+	public function render_settings_page() {
+		// Include template file
+		include {{prefix|upper}}PATH . 'templates/admin-settings.php';
+	}
+
+	/**
+	 * Activation logic.
+	 */
+	public function activate() {
+		// Setup database tables, default options, etc.
+	}
+
+	/**
+	 * Deactivation logic.
+	 */
+	public function deactivate() {
+		// Clear scheduled tasks, etc.
+	}
+}
+
+/**
+ * Initialize the plugin.
+ */
+function {{prefix}}init() {
+	return {{namespace}}\Main::get_instance();
+}
+
+add_action( 'plugins_loaded', '{{prefix}}init' );

package/dist/core/templates/skills/wordpress-plugin-standard/templates/readme.txt

@@ -1,41 +1,41 @@
-=== {{plugin_name}} ===
-Contributors: yourname
-Tags: wordpress, plugin, standard
-Requires at least: 6.0
-Tested up to: 6.4
-Requires PHP: 7.4
-Stable tag: 1.0.0
-License: GPLv2 or later
-License URI: https://www.gnu.org/licenses/gpl-2.0.html
-
-{{plugin_name}} is a high-quality WordPress plugin built with HeraSpec.
-
-== Description ==
-
-Describe your plugin features here.
-
-== Installation ==
-
-1. Upload the plugin files to the `/wp-content/plugins/{{plugin_slug}}` directory.
-2. Activate the plugin through the 'Plugins' screen in WordPress.
-3. Go to {{plugin_name}} -> Settings to configure.
-
-== Frequently Asked Questions ==
-
-= Is this plugin free? =
-
-Yes!
-
-== Screenshots ==
-
-1. Dashboard view.
-
-== Changelog ==
-
-= 1.0.0 =
-* Initial release.
-
-== Upgrade Notice ==
-
-= 1.0.0 =
-* First version.
+=== {{plugin_name}} ===
+Contributors: yourname
+Tags: wordpress, plugin, standard
+Requires at least: 6.0
+Tested up to: 6.4
+Requires PHP: 7.4
+Stable tag: 1.0.0
+License: GPLv2 or later
+License URI: https://www.gnu.org/licenses/gpl-2.0.html
+
+{{plugin_name}} is a high-quality WordPress plugin built with HeraSpec.
+
+== Description ==
+
+Describe your plugin features here.
+
+== Installation ==
+
+1. Upload the plugin files to the `/wp-content/plugins/{{plugin_slug}}` directory.
+2. Activate the plugin through the 'Plugins' screen in WordPress.
+3. Go to {{plugin_name}} -> Settings to configure.
+
+== Frequently Asked Questions ==
+
+= Is this plugin free? =
+
+Yes!
+
+== Screenshots ==
+
+1. Dashboard view.
+
+== Changelog ==
+
+= 1.0.0 =
+* Initial release.
+
+== Upgrade Notice ==
+
+= 1.0.0 =
+* First version.

package/dist/core/templates/skills/wordpress-plugin-standard/templates/uninstall.php

@@ -1,21 +1,21 @@
-<?php
-/**
- * Fired when the plugin is uninstalled.
- *
- * @package {{namespace}}
- */
-
-// If uninstall not called from WordPress, then exit.
-if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
-	exit;
-}
-
-/**
- * Clean up plugin data.
- */
-delete_option( '{{prefix}}version' );
-delete_option( '{{prefix}}api_key' );
-
-// Delete custom tables if any...
-// global $wpdb;
-// $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}your_table_name" );
+<?php
+/**
+ * Fired when the plugin is uninstalled.
+ *
+ * @package {{namespace}}
+ */
+
+// If uninstall not called from WordPress, then exit.
+if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
+	exit;
+}
+
+/**
+ * Clean up plugin data.
+ */
+delete_option( '{{prefix}}version' );
+delete_option( '{{prefix}}api_key' );
+
+// Delete custom tables if any...
+// global $wpdb;
+// $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}your_table_name" );

package/dist/core/templates/skills/wordpress-plugin-standard-skill.md

@@ -1,100 +1,100 @@
-# Skill: WordPress Plugin Standard (WP.org Compliant)
-
-This skill guides the creation of a high-quality, secure, and WordPress.org compliant plugin. It focuses on adherence to the Plugin Check (PCP) requirements and provides a robust structure including admin interfaces.
-
-## Purpose
-Standardize WordPress plugin development to ensure acceptance into the official repository, maximize security, and promote maintainability through strict separation of concerns.
-
-## Required Variables
-- `{{plugin_name}}`: Human-readable name (e.g., My Awesome Plugin).
-- `{{plugin_slug}}`: Unique slug (e.g., my-awesome-plugin).
-- `{{namespace}}`: PHP Namespace (e.g., PolyXGO\MyPlugin).
-- `{{prefix}}`: Unique prefix for functions/variables (e.g., pxmp_).
-- `{{text_domain}}`: I18n text domain (usually same as plugin slug).
-
-## Core Requirements (WordPress.org & PCP)
-
-### 1. Security & Protection
-- **Direct Access**: Use `if ( ! defined( 'ABSPATH' ) ) exit;` at the top of every PHP file.
-- **Nonces**: Verify nonces for all form submissions and AJAX requests.
-- **Validation & Sanitization**: Sanitize all inputs (`sanitize_text_field`, `absint`, etc.) and validate data before processing.
-- **Escaping**: Escape all outputs strictly based on context (`esc_html`, `esc_attr`, `wp_kses`, etc.).
-- **Capabilities**: Explicitly check user capabilities (`current_user_can`) for all admin actions.
-
-### 2. Code Organization & Standards
-- **Naming**: Use the `{{prefix}}` for all global functions, variables, and constants.
-- **Namespace**: Use PSR-4 namespacing (`{{namespace}}`) to avoid class collisions.
-- **Separation of Concerns**: Keep CSS and JS in separate files. AVOID inline styles or scripts unless dynamically generated values are required (use `wp_localize_script` or `wp_add_inline_style` only when necessary).
-- **No Prohibited Constructs**: Never use `eval()`, `base64_decode()` for obfuscation, or short tags (`<?`).
-
-### 3. Required Components
-- **Main Plugin File**: Must contain the required header comment.
-- **`readme.txt`**: Standard WordPress.org format.
-- **Admin Interface**:
-  - A top-level or sub-menu item for the **Dashboard**.
-  - A dedicated **Settings** page for configuration.
-- **Uninstallation**: Provide an `uninstall.php` file to clean up data (options, tables) when the plugin is deleted.
-
-## Implementation Steps
-
-### Step 1: Initialize Main Structure
-1. Create the main plugin file `{{plugin_slug}}.php` with the correct header.
-2. Initialize the main class with a singleton or static instance.
-3. Hook into `plugins_loaded` to start the plugin logic.
-
-### Step 2: Register Admin Menu
-1. Hook into `admin_menu`.
-2. Add a menu page and a sub-page for Settings.
-3. Enqueue admin-specific assets (CSS/JS) only on plugin pages.
-
-### Step 3: Integrate UI/UX Skill
-When designing the Dashboard or Settings page:
-1. **Call Skill**: Use `(skill: ui-ux)` to define the design language.
-2. **Apply Styles**: Use the colors, typography, and spacing defined by the `ui-ux` skill result.
-3. Write styles in `assets/admin.css`.
-
-### Step 4: Handle Data Persistence
-1. Use the Options API (`get_option`, `update_option`) for settings.
-2. Ensure all data saved to the database is sanitized.
-3. Ensure all data retrieved from the database is escaped on output.
-
-## Standards and Rules
-
-### The Prefixing Rule
-Every global identifier MUST start with `{{prefix}}`.
-- ✅ `{{prefix}}get_settings()`
-- ❌ `get_settings()`
-
-### The "No Inline" Rule
-- CSS must be in `assets/css/admin.css`.
-- JS must be in `assets/js/admin.js`.
-- Use `wp_enqueue_style` and `wp_enqueue_script` correctly.
-
-### The "Smart Flush" Rule (Friendly URLs)
-If the plugin uses custom post types or custom permalink structures, you MUST implement a "Queue & Flush" mechanism to update rewrite rules automatically. **NEVER** call `flush_rewrite_rules()` on every page load or `init` hook directly without a condition.
-
-**Implementation Pattern:**
-1.  **Queue Flush**: When settings verify (e.g., via `update_option` hook), set a temporary flag.
-    ```php
-    add_action('update_option_{{prefix}}permalink_settings', function($old, $new) {
-        update_option('{{prefix}}flush_rewrite_flag', true);
-    }, 10, 2);
-    ```
-2.  **Execute Flush**: On the next `admin_init`, check and flush.
-    ```php
-    add_action('admin_init', function() {
-        if (get_option('{{prefix}}flush_rewrite_flag')) {
-            flush_rewrite_rules();
-            delete_option('{{prefix}}flush_rewrite_flag');
-        }
-    });
-    ```
-
-## Templates
-- [plugin-main.php](templates/plugin-main.php)
-- [admin-dashboard.php](templates/admin-dashboard.php)
-- [admin-settings.php](templates/admin-settings.php)
-- [readme.txt](templates/readme.txt)
-- [uninstall.php](templates/uninstall.php)
-- [assets/admin-css.css](templates/assets/admin-css.css)
-- [assets/admin-js.js](templates/assets/admin-js.js)
+# Skill: WordPress Plugin Standard (WP.org Compliant)
+
+This skill guides the creation of a high-quality, secure, and WordPress.org compliant plugin. It focuses on adherence to the Plugin Check (PCP) requirements and provides a robust structure including admin interfaces.
+
+## Purpose
+Standardize WordPress plugin development to ensure acceptance into the official repository, maximize security, and promote maintainability through strict separation of concerns.
+
+## Required Variables
+- `{{plugin_name}}`: Human-readable name (e.g., My Awesome Plugin).
+- `{{plugin_slug}}`: Unique slug (e.g., my-awesome-plugin).
+- `{{namespace}}`: PHP Namespace (e.g., PolyXGO\MyPlugin).
+- `{{prefix}}`: Unique prefix for functions/variables (e.g., pxmp_).
+- `{{text_domain}}`: I18n text domain (usually same as plugin slug).
+
+## Core Requirements (WordPress.org & PCP)
+
+### 1. Security & Protection
+- **Direct Access**: Use `if ( ! defined( 'ABSPATH' ) ) exit;` at the top of every PHP file.
+- **Nonces**: Verify nonces for all form submissions and AJAX requests.
+- **Validation & Sanitization**: Sanitize all inputs (`sanitize_text_field`, `absint`, etc.) and validate data before processing.
+- **Escaping**: Escape all outputs strictly based on context (`esc_html`, `esc_attr`, `wp_kses`, etc.).
+- **Capabilities**: Explicitly check user capabilities (`current_user_can`) for all admin actions.
+
+### 2. Code Organization & Standards
+- **Naming**: Use the `{{prefix}}` for all global functions, variables, and constants.
+- **Namespace**: Use PSR-4 namespacing (`{{namespace}}`) to avoid class collisions.
+- **Separation of Concerns**: Keep CSS and JS in separate files. AVOID inline styles or scripts unless dynamically generated values are required (use `wp_localize_script` or `wp_add_inline_style` only when necessary).
+- **No Prohibited Constructs**: Never use `eval()`, `base64_decode()` for obfuscation, or short tags (`<?`).
+
+### 3. Required Components
+- **Main Plugin File**: Must contain the required header comment.
+- **`readme.txt`**: Standard WordPress.org format.
+- **Admin Interface**:
+  - A top-level or sub-menu item for the **Dashboard**.
+  - A dedicated **Settings** page for configuration.
+- **Uninstallation**: Provide an `uninstall.php` file to clean up data (options, tables) when the plugin is deleted.
+
+## Implementation Steps
+
+### Step 1: Initialize Main Structure
+1. Create the main plugin file `{{plugin_slug}}.php` with the correct header.
+2. Initialize the main class with a singleton or static instance.
+3. Hook into `plugins_loaded` to start the plugin logic.
+
+### Step 2: Register Admin Menu
+1. Hook into `admin_menu`.
+2. Add a menu page and a sub-page for Settings.
+3. Enqueue admin-specific assets (CSS/JS) only on plugin pages.
+
+### Step 3: Integrate UI/UX Skill
+When designing the Dashboard or Settings page:
+1. **Call Skill**: Use `(skill: ui-ux)` to define the design language.
+2. **Apply Styles**: Use the colors, typography, and spacing defined by the `ui-ux` skill result.
+3. Write styles in `assets/admin.css`.
+
+### Step 4: Handle Data Persistence
+1. Use the Options API (`get_option`, `update_option`) for settings.
+2. Ensure all data saved to the database is sanitized.
+3. Ensure all data retrieved from the database is escaped on output.
+
+## Standards and Rules
+
+### The Prefixing Rule
+Every global identifier MUST start with `{{prefix}}`.
+- ✅ `{{prefix}}get_settings()`
+- ❌ `get_settings()`
+
+### The "No Inline" Rule
+- CSS must be in `assets/css/admin.css`.
+- JS must be in `assets/js/admin.js`.
+- Use `wp_enqueue_style` and `wp_enqueue_script` correctly.
+
+### The "Smart Flush" Rule (Friendly URLs)
+If the plugin uses custom post types or custom permalink structures, you MUST implement a "Queue & Flush" mechanism to update rewrite rules automatically. **NEVER** call `flush_rewrite_rules()` on every page load or `init` hook directly without a condition.
+
+**Implementation Pattern:**
+1.  **Queue Flush**: When settings verify (e.g., via `update_option` hook), set a temporary flag.
+    ```php
+    add_action('update_option_{{prefix}}permalink_settings', function($old, $new) {
+        update_option('{{prefix}}flush_rewrite_flag', true);
+    }, 10, 2);
+    ```
+2.  **Execute Flush**: On the next `admin_init`, check and flush.
+    ```php
+    add_action('admin_init', function() {
+        if (get_option('{{prefix}}flush_rewrite_flag')) {
+            flush_rewrite_rules();
+            delete_option('{{prefix}}flush_rewrite_flag');
+        }
+    });
+    ```
+
+## Templates
+- [plugin-main.php](templates/plugin-main.php)
+- [admin-dashboard.php](templates/admin-dashboard.php)
+- [admin-settings.php](templates/admin-settings.php)
+- [readme.txt](templates/readme.txt)
+- [uninstall.php](templates/uninstall.php)
+- [assets/admin-css.css](templates/assets/admin-css.css)
+- [assets/admin-js.js](templates/assets/admin-js.js)