@sabbir1991/wpscaffold 1.0.0

package/template/_stylelintignore

@@ -0,0 +1,11 @@
+node_modules/
+build/
+assets/build/
+vendor/
+**/*.js
+**/*.jsx
+**/*.json
+**/*.ts
+**/*.tsx
+**/*.php
+**/*.svg

package/template/composer.json

@@ -0,0 +1,35 @@
+{
+    "name": "sabbir1991/plugin-skeleton",
+    "type": "wordpress-plugin",
+    "description": "A WordPress plugin skeleton for rapid development.",
+    "license": "GPL-2.0-or-later",
+    "require": {},
+    "require-dev": {
+        "wp-coding-standards/wpcs": "^3.1",
+        "phpcompatibility/phpcompatibility-wp": "*",
+        "sirbrillig/phpcs-variable-analysis": "^2.11",
+        "brain/monkey": "^2.6",
+        "yoast/phpunit-polyfills": "^2.0",
+        "phpunit/phpunit": "^9.5 || ^10.5"
+    },
+    "autoload": {
+        "psr-4": {
+            "PluginVendor\\PluginSkeleton\\": "includes/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "PluginVendor\\PluginSkeleton\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "cs": "@php ./vendor/bin/phpcs",
+        "cs:fix": "@php ./vendor/bin/phpcbf",
+        "test": "@php ./vendor/bin/phpunit"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
+}

package/template/eslint.config.js

@@ -0,0 +1,8 @@
+const wpScriptsConfig = require( '@wordpress/scripts/config/eslint.config.cjs' );
+
+module.exports = [
+	{
+		ignores: [ 'assets/**', 'build/**', 'vendor/**', 'node_modules/**' ],
+	},
+	...wpScriptsConfig,
+];

package/template/includes/Admin/Menu.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Admin menu registration.
+ *
+ * @package PluginVendor\PluginSkeleton
+ */
+
+declare(strict_types=1);
+
+namespace PluginVendor\PluginSkeleton\Admin;
+
+use PluginVendor\PluginSkeleton\Traits\Singleton;
+
+/**
+ * Class Menu.
+ */
+class Menu {
+
+	use Singleton;
+
+	/**
+	 * Constructor.
+	 */
+	protected function __construct() {
+		$this->setup_hooks();
+	}
+
+	/**
+	 * Register WordPress hooks.
+	 *
+	 * @return void
+	 */
+	private function setup_hooks(): void {
+		add_action( 'admin_menu', [ $this, 'register_menu' ] );
+	}
+
+	/**
+	 * Register the top-level admin menu page.
+	 *
+	 * @return void
+	 */
+	public function register_menu(): void {
+		add_menu_page(
+			__( 'Plugin Skeleton', 'plugin-skeleton' ),
+			__( 'Plugin Skeleton', 'plugin-skeleton' ),
+			'manage_options',
+			'plugin-skeleton',
+			[ $this, 'render_page' ],
+			'dashicons-admin-generic',
+			'99'
+		);
+	}
+
+	/**
+	 * Render the admin page.
+	 *
+	 * @return void
+	 */
+	public function render_page(): void {
+		?>
+		<div class="wrap">
+			<h1><?php esc_html_e( 'Plugin Skeleton', 'plugin-skeleton' ); ?></h1>
+			<p><?php esc_html_e( 'Plugin Skeleton is working! Start building your plugin here.', 'plugin-skeleton' ); ?></p>
+		</div>
+		<?php
+	}
+}

package/template/includes/Assets.php

@@ -0,0 +1,140 @@
+<?php
+/**
+ * Assets class — script and style registration.
+ *
+ * @package PluginVendor\PluginSkeleton
+ */
+
+declare(strict_types=1);
+
+namespace PluginVendor\PluginSkeleton;
+
+use PluginVendor\PluginSkeleton\Traits\Singleton;
+
+/**
+ * Class Assets.
+ */
+class Assets {
+
+	use Singleton;
+
+	/* @skeleton-admin */
+	/**
+	 * Constructor.
+	 */
+	protected function __construct() {
+		$this->setup_hooks();
+	}
+
+	/**
+	 * Register WordPress hooks.
+	 *
+	 * @return void
+	 */
+	private function setup_hooks(): void {
+		add_action( 'admin_enqueue_scripts', [ $this, 'admin_scripts' ] );
+	}
+
+	/**
+	 * Register admin scripts and styles.
+	 *
+	 * @return void
+	 */
+	public function admin_scripts(): void {
+		$this->register_script( 'plugin-skeleton-admin', 'build/admin.js', [], PLUGIN_SKELETON_VERSION, true );
+		$this->register_style( 'plugin-skeleton-admin', 'build/admin.css', [], PLUGIN_SKELETON_VERSION );
+		wp_enqueue_script( 'plugin-skeleton-admin' );
+		wp_enqueue_style( 'plugin-skeleton-admin' );
+	}
+	/* @skeleton-admin-end */
+	/* @skeleton-block-only */
+	/**
+	 * Constructor — no hooks needed for block-only plugins.
+	 */
+	protected function __construct() {
+	}
+	/* @skeleton-block-only-end */
+
+	/**
+	 * Load asset metadata from generated .asset.php file.
+	 *
+	 * @param string $file Relative path under assets/.
+	 * @param array  $deps Additional dependency handles.
+	 * @param mixed  $ver  Fallback version.
+	 * @return array
+	 */
+	public function get_asset_meta( string $file, array $deps = [], $ver = false ): array {
+		$asset_meta_file = sprintf(
+			'%s/%s.asset.php',
+			untrailingslashit( PLUGIN_SKELETON_ASSET_PATH ),
+			preg_replace( '/\.[^.]+$/', '', $file )
+		);
+
+		$asset_meta = is_readable( $asset_meta_file )
+			? require $asset_meta_file
+			: [
+				'dependencies' => [],
+				'version'      => $this->get_file_version( $file, $ver ),
+			];
+
+		$asset_meta['dependencies'] = array_merge( $deps, $asset_meta['dependencies'] );
+
+		return $asset_meta;
+	}
+
+	/**
+	 * Get a file's version (filemtime or provided fallback).
+	 *
+	 * @param string $file Relative path under assets/build/.
+	 * @param mixed  $ver  Explicit version override.
+	 * @return string|false
+	 */
+	public function get_file_version( string $file, $ver = false ) {
+		if ( ! empty( $ver ) ) {
+			return $ver;
+		}
+
+		$file_path = sprintf( '%s/%s', PLUGIN_SKELETON_ASSET_PATH, $file );
+
+		return file_exists( $file_path ) ? (string) filemtime( $file_path ) : false;
+	}
+
+	/**
+	 * Register a script.
+	 *
+	 * @param string   $handle    Script handle.
+	 * @param string   $file      Path relative to assets/ (or full URL).
+	 * @param string[] $deps      Additional dependencies.
+	 * @param mixed    $ver       Version override.
+	 * @param bool     $in_footer Enqueue in footer.
+	 * @return bool
+	 */
+	public function register_script( string $handle, string $file, array $deps = [], $ver = false, bool $in_footer = true ): bool {
+		$src        = str_starts_with( $file, 'https://' ) ? $file : sprintf( '%s/%s', PLUGIN_SKELETON_ASSET_URL, $file );
+		$asset_meta = $this->get_asset_meta( $file, $deps, $ver );
+
+		return wp_register_script( $handle, $src, $asset_meta['dependencies'], $asset_meta['version'], $in_footer );
+	}
+
+	/**
+	 * Register a stylesheet.
+	 *
+	 * @param string   $handle Script handle.
+	 * @param string   $file   Path relative to assets/ (or full URL).
+	 * @param string[] $deps   Additional dependencies.
+	 * @param mixed    $ver    Version override.
+	 * @param string   $media  Media type.
+	 * @return bool
+	 */
+	public function register_style( string $handle, string $file, array $deps = [], $ver = false, string $media = 'all' ): bool {
+		if ( str_starts_with( $file, 'https://' ) ) {
+			$src = $file;
+			$ver = PLUGIN_SKELETON_VERSION;
+		} else {
+			$src = sprintf( '%s/%s', PLUGIN_SKELETON_ASSET_URL, $file );
+			$ver = $this->get_file_version( $file, $ver );
+		}
+
+		return wp_register_style( $handle, $src, $deps, $ver, $media );
+	}
+}

package/template/includes/Blocks.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Block registration.
+ *
+ * @package PluginVendor\PluginSkeleton
+ */
+
+declare(strict_types=1);
+
+namespace PluginVendor\PluginSkeleton;
+
+use PluginVendor\PluginSkeleton\Traits\Singleton;
+
+/**
+ * Class Blocks.
+ */
+class Blocks {
+
+	use Singleton;
+
+	/**
+	 * Constructor.
+	 */
+	protected function __construct() {
+		$this->setup_hooks();
+	}
+
+	/**
+	 * Register WordPress hooks.
+	 *
+	 * @return void
+	 */
+	private function setup_hooks(): void {
+		add_action( 'init', [ $this, 'register_blocks' ] );
+	}
+
+	/**
+	 * Register all plugin blocks from the build directory.
+	 *
+	 * @return void
+	 */
+	public function register_blocks(): void {
+		$build_dir = PLUGIN_SKELETON_PATH . '/build';
+
+		if ( ! is_dir( $build_dir ) ) {
+			return;
+		}
+
+		foreach ( glob( $build_dir . '/*/block.json' ) ?: [] as $block_json ) {
+			register_block_type( dirname( $block_json ) );
+		}
+	}
+}

package/template/includes/Plugin.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Main plugin class.
+ *
+ * @package PluginVendor\PluginSkeleton
+ */
+
+declare(strict_types=1);
+
+namespace PluginVendor\PluginSkeleton;
+
+/* @skeleton-admin */
+use PluginVendor\PluginSkeleton\Admin\Menu;
+/* @skeleton-admin-end */
+/* @skeleton-block */
+use PluginVendor\PluginSkeleton\Blocks;
+/* @skeleton-block-end */
+
+/**
+ * Class Plugin.
+ */
+class Plugin {
+
+	/**
+	 * Bootstrap the plugin.
+	 *
+	 * @return void
+	 */
+	public function run(): void {
+		$this->load_textdomain();
+		$this->load();
+	}
+
+	/**
+	 * Load plugin text domain.
+	 *
+	 * @return void
+	 */
+	private function load_textdomain(): void {
+		load_plugin_textdomain( 'plugin-skeleton', false, plugin_basename( PLUGIN_SKELETON_PATH ) . '/languages' );
+	}
+
+	/**
+	 * Instantiate service classes.
+	 *
+	 * @return void
+	 */
+	private function load(): void {
+		Assets::get_instance();
+		/* @skeleton-admin */
+		if ( is_admin() ) {
+			Menu::get_instance();
+		}
+		/* @skeleton-admin-end */
+		/* @skeleton-block */
+		Blocks::get_instance();
+		/* @skeleton-block-end */
+	}
+}

package/template/includes/Traits/Singleton.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Singleton trait.
+ *
+ * @package PluginVendor\PluginSkeleton
+ */
+
+declare(strict_types=1);
+
+namespace PluginVendor\PluginSkeleton\Traits;
+
+trait Singleton {
+
+	/**
+	 * Protected constructor — override in child class to hook actions/filters.
+	 */
+	protected function __construct() {
+	}
+
+	/**
+	 * Prevent cloning.
+	 */
+	final protected function __clone() {
+	}
+
+	/**
+	 * Return the singleton instance.
+	 *
+	 * @param mixed ...$args Constructor arguments.
+	 * @return static
+	 */
+	final public static function get_instance( ...$args ) {
+		static $instances = [];
+
+		$called_class = get_called_class();
+		$key          = $called_class . maybe_serialize( $args );
+
+		if ( ! isset( $instances[ $key ] ) ) {
+			$instances[ $key ] = new $called_class( ...$args );
+
+			do_action( sprintf( 'plugin_skeleton_singleton_init_%s', $called_class ) ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+		}
+
+		return $instances[ $key ];
+	}
+}

package/template/lefthook.yml

@@ -0,0 +1,13 @@
+pre-commit:
+  commands:
+    lint-js:
+      glob: "src/**/*.js"
+      run: npm run lint:js
+    lint-css:
+      glob: "src/**/*.scss"
+      run: npm run lint:css
+    lint-php:
+      glob:
+        - "*.php"
+        - "includes/**/*.php"
+      run: npm run lint:php

package/template/phpcs.xml.dist

@@ -0,0 +1,42 @@
+<?xml version="1.0" ?>
+<ruleset name="Plugin Skeleton Coding Standards">
+    <config name="minimum_supported_wp_version" value="6.4" />
+    <config name="testVersion" value="8.1-"/>
+    <rule ref="PHPCompatibilityWP"/>
+
+    <file>includes</file>
+    <file>plugin-skeleton.php</file>
+
+    <arg value="ps"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+
+    <rule ref="WordPress-Core">
+        <exclude name="Universal.Arrays.DisallowShortArraySyntax" />
+        <exclude name="Universal.Operators.DisallowShortTernary" />
+    </rule>
+
+    <rule ref="WordPress-Docs">
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+
+    <rule ref="WordPress-Extra">
+        <exclude name="WordPress.Files.FileName" />
+        <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase" />
+    </rule>
+
+    <rule ref="WordPress.WP.I18n">
+        <properties>
+            <property name="text_domain" type="array">
+                <element value="plugin-skeleton" />
+            </property>
+        </properties>
+    </rule>
+
+    <rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis" />
+
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+    <exclude-pattern>*/node_modules/*</exclude-pattern>
+    <exclude-pattern>*/assets/*</exclude-pattern>
+    <exclude-pattern>*/build/*</exclude-pattern>
+</ruleset>

package/template/phpunit.xml.dist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    bootstrap="tests/bootstrap.php"
+    cacheResultFile=".phpunit.result.cache"
+    colors="true"
+>
+    <testsuites>
+        <testsuite name="unit">
+            <directory suffix="Test.php">tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">includes</directory>
+        </include>
+    </source>
+</phpunit>

package/template/plugin-skeleton.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Plugin Name: Plugin Skeleton
+ * Plugin URI: https://github.com/sabbir1991/plugin-skeleton
+ * Description: A WordPress plugin skeleton for rapid development.
+ * Version: 1.0.0
+ * Author: Your Name
+ * Author URI: https://yoursite.com
+ * License: GPL-2.0-or-later
+ * Text Domain: plugin-skeleton
+ * Domain Path: /languages
+ *
+ * @package PluginVendor\PluginSkeleton
+ */
+
+declare(strict_types=1);
+
+namespace PluginVendor\PluginSkeleton;
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+define( 'PLUGIN_SKELETON_VERSION', '1.0.0' );
+define( 'PLUGIN_SKELETON_PATH', untrailingslashit( plugin_dir_path( __FILE__ ) ) );
+define( 'PLUGIN_SKELETON_URL', untrailingslashit( plugin_dir_url( __FILE__ ) ) );
+define( 'PLUGIN_SKELETON_ASSET_PATH', untrailingslashit( PLUGIN_SKELETON_PATH . '/assets' ) );
+define( 'PLUGIN_SKELETON_ASSET_URL', untrailingslashit( PLUGIN_SKELETON_URL . '/assets' ) );
+
+$autoload_file = __DIR__ . '/vendor/autoload.php';
+
+if ( ! file_exists( $autoload_file ) ) {
+	add_action(
+		'admin_notices',
+		function () {
+			echo '<div class="error"><p>' . esc_html__( 'Plugin Skeleton: Run composer install to load dependencies.', 'plugin-skeleton' ) . '</p></div>';
+		}
+	);
+	return;
+}
+
+require_once $autoload_file;
+
+/**
+ * Get the main Plugin instance.
+ *
+ * @return Plugin
+ */
+function plugin_skeleton(): Plugin {
+	static $plugin;
+
+	if ( null === $plugin ) {
+		$plugin = new Plugin();
+	}
+
+	return $plugin;
+}
+
+add_action(
+	'plugins_loaded',
+	function () {
+		plugin_skeleton()->run();
+	}
+);

package/template/readme.txt

@@ -0,0 +1,25 @@
+=== Plugin Skeleton ===
+Contributors: yourname
+Tags: wordpress, plugin
+Requires at least: 6.4
+Tested up to: 7.0
+Stable tag: 1.0.0
+Requires PHP: 8.1
+License: GPLv2 or later
+License URI: https://www.gnu.org/licenses/gpl-2.0.html
+
+A WordPress plugin skeleton for rapid development.
+
+== Description ==
+
+A WordPress plugin skeleton for rapid development.
+
+== Installation ==
+
+1. Upload the plugin files to `/wp-content/plugins/plugin-skeleton/`.
+2. Activate the plugin through the Plugins screen in WordPress.
+
+== Changelog ==
+
+= 1.0.0 =
+* Initial release.

package/template/src/block/block.json

@@ -0,0 +1,17 @@
+{
+	"$schema": "https://schemas.wp.org/trunk/block.json",
+	"apiVersion": 3,
+	"name": "plugin-skeleton/plugin-skeleton",
+	"version": "1.0.0",
+	"title": "Plugin Skeleton Block",
+	"category": "widgets",
+	"description": "A WordPress plugin skeleton for rapid development.",
+	"supports": {
+		"html": false
+	},
+	"textdomain": "plugin-skeleton",
+	"editorScript": "file:./index.js",
+	"style": "file:./style-index.css",
+	"render": "file:./render.php",
+	"viewScript": "file:./view.js"
+}

package/template/src/block/edit.js

@@ -0,0 +1,17 @@
+/**
+ * Block editor component for Plugin Skeleton.
+ */
+
+import { useBlockProps } from '@wordpress/block-editor';
+import { __ } from '@wordpress/i18n';
+
+/**
+ * Edit component rendered in the block editor.
+ */
+export default function Edit() {
+	return (
+		<div { ...useBlockProps() }>
+			<p>{ __( 'Edit view.', 'plugin-skeleton' ) }</p>
+		</div>
+	);
+}

package/template/src/block/index.js

@@ -0,0 +1,13 @@
+/**
+ * Block registration for Plugin Skeleton.
+ */
+
+import { registerBlockType } from '@wordpress/blocks';
+import './style.scss';
+import Edit from './edit';
+import metadata from './block.json';
+
+registerBlockType( metadata.name, {
+	edit: Edit,
+	save: () => null,
+} );

package/template/src/block/render.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * Block render template for Plugin Skeleton.
+ *
+ * @package PluginVendor\PluginSkeleton
+ * @var array    $attributes Block attributes.
+ * @var string   $content    Inner block content.
+ * @var WP_Block $block      Block instance.
+ */
+?>
+<div <?php echo get_block_wrapper_attributes(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>>
+	<p><?php esc_html_e( 'Plugin Skeleton block.', 'plugin-skeleton' ); ?></p>
+</div>

package/template/src/block/style.scss

@@ -0,0 +1,8 @@
+/**
+ * Block styles for Plugin Skeleton.
+ * Applied in both editor and frontend.
+ */
+
+.wp-block-plugin-skeleton-plugin-skeleton {
+	// Block styles here.
+}

package/template/src/block/view.js

@@ -0,0 +1,5 @@
+/**
+ * Frontend view script for Plugin Skeleton block.
+ */
+
+// Frontend interaction goes here.

package/template/src/global/css/admin.scss

@@ -0,0 +1,8 @@
+/**
+ * Admin styles for Plugin Skeleton.
+ */
+
+// Your admin styles here.
+.plugin-skeleton-admin {
+	// styles
+}