@iservice-dev/is-wp-plugin-kit 1.6.11 → 1.7.2

package/bin/commands/init.js

@@ -1,6 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
+import readline from 'node:readline';
 import { copy } from '../utils.js';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -10,17 +11,115 @@ const require = createRequire(import.meta.url);
 const selfPkg = require('../../package.json');
 
 const toolkitVersion = `^${selfPkg.version}`;
+const defaultWpVersion = '6.5';
+const defaultPhpVersion = '8.3';
+const defaultBaseVersion = '1.0.16';
 
-export function runInit() {
+function prompt(question) {
+	const rl = readline.createInterface({
+		input: process.stdin,
+		output: process.stdout,
+	});
+
+	return new Promise((resolve) => {
+		rl.question(question, (answer) => {
+			rl.close();
+			resolve(answer);
+		});
+	});
+}
+
+function isValidVersion(version) {
+	return /^\d+(\.\d+){0,2}$/.test(version);
+}
+
+async function promptVersion(question, defaultValue) {
+	while (true) {
+		const answer = await prompt(question);
+		const version = answer || defaultValue;
+		
+		if (isValidVersion(version)) {
+			return version;
+		}
+		
+		console.error(`❌ Invalid version format: "${version}". Use format like: 1.0.0, 6.5, or 8.3`);
+	}
+}
+
+export async function runInit() {
 	const root = process.cwd();
+	const folderName = path.basename(root);
+
+	// ------------------------------------------
+	// Prompts for plugin configuration
+	// ------------------------------------------
+	console.log('\n🚀 is-wp-plugin-kit initialization\n');
+
+	const pluginName = await prompt(`Plugin Name (e.g., My Awesome Plugin): `);
+	if (!pluginName) {
+		console.error('❌ Plugin Name is required!');
+		process.exit(1);
+	}
+
+	const pluginDescr = await prompt('Plugin Description (optional): ');
+
+	const pluginSlug =
+		(await prompt(
+			`Plugin Slug (default: ${folderName.toLowerCase().replace(/\s+/g, '-')}): `
+		)) || folderName.toLowerCase().replace(/\s+/g, '-');
+
+	const pluginTypeInput = await prompt(
+		'Plugin Type - [1] General (requires IS Base) or [2] Standalone (default: 1): '
+	);
+	const pluginType = pluginTypeInput === '2' ? 'standalone' : 'general';
+
+	const namespace = await prompt('Namespace (e.g., IS\\MyPlugin): ');
+	if (!namespace) {
+		console.error('❌ Namespace is required!');
+		process.exit(1);
+	}
+
+	const githubRepo = await prompt('GitHub Repository URL (e.g., https://github.com/user/repo): ');
+	if (!githubRepo) {
+		console.error('❌ GitHub Repository URL is required!');
+		process.exit(1);
+	}
+
+	const textDomain = (await prompt(`Text Domain (default: ${pluginSlug}): `)) || pluginSlug;
+	const vitePort = (await prompt('Vite Dev Port (default: 5500): ')) || '5500';
+
+	// Read correct template based on plugin type
+	const pluginRootTemplateFile = pluginType === 'standalone' ? 'plugin-root-standalone.php' : 'plugin-root.php';
+	const pluginRootTemplate = fs.readFileSync(
+		path.join(__dirname, '../../files', pluginRootTemplateFile),
+		'utf-8'
+	);
+
+	const requiredWpVersion = await promptVersion(
+		`Required WordPress version (default: ${defaultWpVersion}): `,
+		defaultWpVersion
+	);
+	const requiredPhpVersion = await promptVersion(
+		`Required PHP version (default: ${defaultPhpVersion}): `,
+		defaultPhpVersion
+	);
+	const requiredBaseVersion =
+		pluginType === 'general'
+			? await promptVersion(
+					`Required IS Base Plugin version (default: ${defaultBaseVersion}): `,
+					defaultBaseVersion
+			  )
+			: null;
+
+	console.log('\n');
 
 	// ------------------------------------------
-	// 1) .gitignore kopieren
+	// 1) copy .gitignore
 	// ------------------------------------------
 	copy('gitignore');
 
 	// ------------------------------------------
-	// 2) stylelint config erzeugen
+	// 2) create stylelint config
 	// ------------------------------------------
 	fs.writeFileSync(
 		path.join(root, '.stylelintrc.json'),
@@ -35,7 +134,7 @@ export function runInit() {
 	console.log('✓ Created .stylelintrc.json');
 
 	// ------------------------------------------
-	// 3) tsconfig erzeugen
+	// 3) create tsconfig
 	// ------------------------------------------
 	fs.writeFileSync(
 		path.join(root, 'tsconfig.json'),
@@ -51,7 +150,7 @@ export function runInit() {
 	console.log('✓ Created tsconfig.json');
 
 	// ------------------------------------------
-	// 4) oxlintrc erzeugen
+	// 4) create oxlintrc
 	// ------------------------------------------
 	fs.writeFileSync(
 		path.join(root, '.oxlintrc.json'),
@@ -66,7 +165,7 @@ export function runInit() {
 	console.log('✓ Created .oxlintrc.json');
 
 	// ------------------------------------------
-	// 5) postcss config erzeugen
+	// 5) create postcss config
 	// ------------------------------------------
 	fs.writeFileSync(
 		path.join(root, 'postcss.config.cjs'),
@@ -75,27 +174,27 @@ export function runInit() {
 	console.log('✓ Created postcss.config.cjs');
 
 	// ------------------------------------------
-	// 6) vite.config.ts erzeugen
+	// 6) create vite.config.ts
 	// ------------------------------------------
 	fs.writeFileSync(
 		path.join(root, 'vite.config.ts'),
-		`import { wpPluginKitVite } from "@iservice-dev/is-wp-plugin-kit/vite";
-
-export default wpPluginKitVite({
-  port: 5500
-});
-`
+		`
+		import { wpPluginKitVite } from "@iservice-dev/is-wp-plugin-kit/vite";
+		export default wpPluginKitVite({
+		port: ${vitePort}
+		});
+		`
 	);
 	console.log('✓ Created vite.config.ts');
 
 	// ------------------------------------------
-	// 7) package.json erzeugen (falls nicht vorhanden)
+	// 7) create package.json
 	// ------------------------------------------
 	const pkgPath = path.join(root, 'package.json');
 
 	if (!fs.existsSync(pkgPath)) {
 		const pkg = {
-			name: path.basename(root),
+			name: pluginSlug,
 			version: '1.0.0',
 			type: 'module',
 			description: 'iService WordPress Plugin',
@@ -116,7 +215,7 @@ export default wpPluginKitVite({
 	}
 
 	// ------------------------------------------
-	// 8) Ordnerstruktur erzeugen
+	// 8) create folder structure
 	// ------------------------------------------
 	const dirs = [
 		'assets/src/ts',
@@ -131,7 +230,6 @@ export default wpPluginKitVite({
 		'includes/lib/Frontend',
 	];
 
-	// Ordner die kein .gitkeep brauchen (bekommen andere Dateien)
 	const skipGitkeep = ['assets/src/l10n', 'includes/lib/Core'];
 
 	dirs.forEach((dir) => {
@@ -149,17 +247,92 @@ export default wpPluginKitVite({
 	console.log('✓ Created folder structure with .gitkeep files');
 
 	// ------------------------------------------
-	// 9) de_DE.po Template kopieren
+	// 9) copy de_DE.po template
 	// ------------------------------------------
 	copy('de_DE.po', 'assets/src/l10n/de_DE.po');
 
 	// ------------------------------------------
-	// 10) PHP Template Files kopieren
+	// 10) create GitHub Actions workflow
+	// ------------------------------------------
+	const workflowDir = path.join(root, '.github/workflows');
+	if (!fs.existsSync(workflowDir)) {
+		fs.mkdirSync(workflowDir, { recursive: true });
+	}
+
+	const deployYmlTemplate = fs.readFileSync(
+		path.join(__dirname, '../../files/deploy.yml'),
+		'utf-8'
+	);
+
+	const deployYmlContent = deployYmlTemplate.replace(/\[plugin-placehoder\]/g, pluginSlug);
+
+	fs.writeFileSync(path.join(workflowDir, 'deploy.yml'), deployYmlContent);
+	console.log('✓ Created .github/workflows/deploy.yml');
+
+	// ------------------------------------------
+	// 11) create and customize PHP template files
 	// ------------------------------------------
-	copy('Plugin.php', 'includes/lib/Core/Plugin.php');
-	copy('Config.php', 'includes/lib/Core/Config.php');
+
+	const pluginRootFile = `${pluginSlug}.php`;
+
+	const namespaceParts = namespace.split('\\').filter(Boolean);
+	const namespaceFirst = namespaceParts[0] || 'IS';
+	const namespaceSecond = namespaceParts[1] || 'Plugin';
+
+	const pluginRootContent = pluginRootTemplate
+		.replace(/\[Plugin Name Placeholder\]/g, `${pluginName}`)
+		.replace(/\[Plugin Description Placeholder\]/g, `${pluginDescr || '-'}`)
+		.replace(/\[text-domain-placeholder\]/g, `${textDomain}`)
+		.replace(/plugin_slug_placeholder/g, pluginSlug.replace(/-/g, '_'))
+		.replace(/\[NamespacePlaceholder\]/g, namespaceSecond)
+		.replace(/\\NamespacePlaceholder\\/g, `\\${namespace}\\`)
+		.replace(/define\('PLUGIN_TYPE', 'general'\);/g, `define('PLUGIN_TYPE', '${pluginType}');`)
+		.replace(/\[base-version-placeholder\]/g, `${requiredBaseVersion}`)
+		.replace(/\[wp-version-placeholder\]/g, `${requiredWpVersion}`)
+		.replace(/\[php-version-placeholder\]/g, `${requiredPhpVersion}`);
+
+	fs.writeFileSync(path.join(root, pluginRootFile), pluginRootContent);
+	console.log(`✓ Created ${pluginRootFile}`);
+
+	if (pluginType === 'general') {
+		// Plugin.php
+		const pluginPhpTemplate = fs.readFileSync(
+			path.join(__dirname, '../../files/Plugin.php'),
+			'utf-8'
+		);
+
+		const pluginPhpContent = pluginPhpTemplate
+			.replace(/NamespacePlaceholder/g, `${namespace}`)
+			.replace(/'\[github-repo-placeholder\]'/g, `'${githubRepo}'`)
+			.replace(/'\[plugin-slug-placeholder\]'/g, `'${pluginSlug}'`)
+
+		fs.writeFileSync(path.join(root, 'includes/lib/Core/Plugin.php'), pluginPhpContent);
+		console.log('✓ Created includes/lib/Core/Plugin.php');
+
+		// Config.php
+		const configPhpTemplate = fs.readFileSync(
+			path.join(__dirname, '../../files/Config.php'),
+			'utf-8'
+		);
+
+		const configPhpContent = configPhpTemplate
+			.replace(/NamespacePlaceholder/g, `${namespace}`)
+			.replace(/\[plugin-slug-placeholder\]/g, `${pluginSlug}`)
+			.replace(/\$this->vitePort = 5500;/g, `$this->vitePort = ${vitePort};`)
+
+		fs.writeFileSync(path.join(root, 'includes/lib/Core/Config.php'), configPhpContent);
+		console.log('✓ Created includes/lib/Core/Config.php');
+	} else {
+		console.log('↺ Plugin.php and Config.php skipped (standalone plugin - add your own code)');
+	}
 
 	// ------------------------------------------
 	console.log('\n🎉 Project initialized successfully!\n');
+	console.log(`Plugin: ${pluginName}`);
+	console.log(`Type: ${pluginType}`);
+	console.log(`Slug: ${pluginSlug}`);
+	console.log(`Namespace: ${namespace}`);
+	console.log(`Text Domain: ${textDomain}`);
+	console.log(`Vite Port: ${vitePort}\n`);
 	process.exit(0);
 }

package/files/Config.php

@@ -1,13 +1,11 @@
 <?php
-//TODO change namespace
-namespace IS\Template\Core;
+namespace NamespacePlaceholder\Core;
 
 use IS\Base\Core\Abstract_Config;
 
 final class Config extends Abstract_Config {
 	protected function __construct() {
-		//TODO change pluginName and port if general plugin
-		$this->pluginName = "is-template-plugin";
+		$this->pluginName = "[plugin-slug-placeholder]";
 		$this->customPrefix = "iS_";
 		$this->vitePort = 5500;
 

package/files/Plugin.php

@@ -1,6 +1,5 @@
 <?php
-//TODO change namespace
-namespace IS\Template\Core;
+namespace NamespacePlaceholder\Core;
 
 use IS\Base\Core\Updater;
 use IS\Base\Core\Auto_Instantiate;
@@ -20,15 +19,14 @@ class Plugin {
 			);
 		}
 
-		//TODO change github repo link and plugin slug
 		$updater = new Updater(
-			'https://github.com/iService-dev/is-template-plugin',
+			'[github-repo-placeholder]',
 			$file,
-			'is-template-plugin'
+			'[plugin-slug-placeholder]'
 		);
 		$updater->init();
 		
-		//TODO only needed if classes in Admin or Frontend folder
+		//TODO: Check if needed - only needed if classes in Admin or Frontend folder
 		Auto_Instantiate::instantiate_classes_static(self::$config, 'Admin');
 		Auto_Instantiate::instantiate_classes_static(self::$config, 'Frontend');
 	}

package/files/deploy.yml

@@ -0,0 +1,152 @@
+name: Build & Release WordPress Plugin
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+
+      - name: Install Node dependencies
+        run: npm ci
+
+      - name: Build assets
+        run: npm run build
+
+      - name: Check for composer.json
+        id: check_composer
+        run: |
+          if [ -f "composer.json" ]; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Composer
+        if: steps.check_composer.outputs.exists == 'true'
+        uses: php-actions/composer@v6
+        with:
+          php_version: "8.2"
+          args: --no-dev --prefer-dist --optimize-autoloader
+
+      - name: Determine new version
+        id: version
+        run: |
+          COMMIT_MSG=$(git log -1 --pretty=%B)
+
+          if [[ $COMMIT_MSG == *"[skip release]"* ]]; then
+            echo "skip=true" >> $GITHUB_OUTPUT
+            echo "Skipping release due to [skip release] in commit message"
+            exit 0
+          fi
+
+          LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
+          LATEST_VERSION=${LATEST_TAG#v}
+
+          echo "Latest version: $LATEST_VERSION"
+          echo "Commit message: $COMMIT_MSG"
+
+          IFS='.' read -r -a VERSION_PARTS <<< "$LATEST_VERSION"
+          MAJOR=${VERSION_PARTS[0]:-0}
+          MINOR=${VERSION_PARTS[1]:-0}
+          PATCH=${VERSION_PARTS[2]:-0}
+
+          if [[ $COMMIT_MSG == *"[major]"* ]]; then
+            NEW_VERSION="$((MAJOR + 1)).0.0"
+            BUMP_TYPE="major"
+          elif [[ $COMMIT_MSG == *"[minor]"* ]]; then
+            NEW_VERSION="$MAJOR.$((MINOR + 1)).0"
+            BUMP_TYPE="minor"
+          else
+            NEW_VERSION="$MAJOR.$MINOR.$((PATCH + 1))"
+            BUMP_TYPE="patch"
+          fi
+
+          NEW_TAG="v$NEW_VERSION"
+
+          echo "Version bump: $LATEST_VERSION → $NEW_VERSION ($BUMP_TYPE)"
+
+          if git rev-parse "$NEW_TAG" >/dev/null 2>&1; then
+            echo "Error: Tag $NEW_TAG already exists!"
+            exit 1
+          fi
+
+          echo "skip=false" >> $GITHUB_OUTPUT
+          echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
+          echo "tag=$NEW_TAG" >> $GITHUB_OUTPUT
+          echo "bump_type=$BUMP_TYPE" >> $GITHUB_OUTPUT
+
+      - name: Update plugin version and commit
+        if: steps.version.outputs.skip == 'false'
+        run: |
+          NEW_VERSION="${{ steps.version.outputs.version }}"
+          sed -i "s/Version: .*/Version: $NEW_VERSION/" [plugin-placehoder].php
+          echo "Updated plugin version to $NEW_VERSION"
+
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          git add [plugin-placehoder].php
+          git commit -m "Bump version to $NEW_VERSION [skip ci]" || echo "No changes to commit"
+          git push origin HEAD:main
+
+      - name: Create and push tag
+        if: steps.version.outputs.skip == 'false'
+        run: |
+          git tag -a "${{ steps.version.outputs.tag }}" -m "Release ${{ steps.version.outputs.version }} (${{ steps.version.outputs.bump_type }})"
+          git push origin "${{ steps.version.outputs.tag }}"
+
+      - name: Prepare package
+        if: steps.version.outputs.skip == 'false'
+        run: |
+          mkdir -p package/[plugin-placehoder]
+          cp [plugin-placehoder].php package/[plugin-placehoder]/
+          cp -r includes package/[plugin-placehoder]/ || true
+          mkdir -p package/[plugin-placehoder]/assets
+          cp -r assets/dist package/[plugin-placehoder]/assets/ || true
+          
+          # Only copy vendor directory if it exists
+          if [ -d "vendor" ]; then
+            cp -r vendor package/[plugin-placehoder]/
+          fi
+
+      - name: Create plugin zip
+        if: steps.version.outputs.skip == 'false'
+        run: |
+          cd package
+          zip -r [plugin-placehoder]-${{ steps.version.outputs.version }}.zip [plugin-placehoder]
+
+      - name: Create GitHub Release
+        if: steps.version.outputs.skip == 'false'
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.version.outputs.tag }}
+          name: "${{ steps.version.outputs.version }}"
+          files: package/[plugin-placehoder]-${{ steps.version.outputs.version }}.zip
+          generate_release_notes: true
+          make_latest: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Success message
+        if: steps.version.outputs.skip == 'false'
+        run: |
+          echo "✅ Successfully released version ${{ steps.version.outputs.version }}"
+          echo "📦 Plugin zip: [plugin-placehoder]-${{ steps.version.outputs.version }}.zip"
+          echo "🏷️ Tag: ${{ steps.version.outputs.tag }}"

package/files/plugin-root-standalone.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Plugin Name: [Plugin Name Placeholder]
+ * Description: [Plugin Description Placeholder]
+ * Version: 0.0.1
+ * Author: iService
+ * Requires at least: [wp-version-placeholder]
+ * Requires PHP: [php-version-placeholder]
+ * Author URI: https://iservice.at
+ * Text Domain: [text-domain-placeholder]
+ * Domain Path: /languages
+ * Update URI: false
+ */
+
+if (!defined('ABSPATH'))
+	exit;
+
+const REQUIRED_WP_VERSION = '[wp-version-placeholder]';
+const REQUIRED_PHP_VERSION = '[php-version-placeholder]';
+
+// WordPress version check
+global $wp_version;
+if (version_compare($wp_version, REQUIRED_WP_VERSION, '<')) {
+	add_action('admin_notices', function () {
+		echo '<div class="notice notice-error"><p>';
+		printf(
+			esc_html__(
+				'%1$s requires WordPress version %2$s or higher. Please update WordPress.',
+				'[text-domain-placeholder]'
+			),
+			esc_html('[Plugin Name Placeholder]'),
+			esc_html(REQUIRED_WP_VERSION)
+		);
+		echo '</p></div>';
+	});
+	add_action('admin_init', function () {
+		deactivate_plugins(plugin_basename(__FILE__));
+	});
+	return;
+}
+
+// PHP version check
+if (version_compare(PHP_VERSION, REQUIRED_PHP_VERSION, '<')) {
+	add_action('admin_notices', function () {
+		echo '<div class="notice notice-error"><p>';
+		printf(
+			esc_html__(
+				'%1$s requires PHP version %2$s or higher. You are running PHP %3$s.',
+				'[text-domain-placeholder]'
+			),
+			esc_html('[Plugin Name Placeholder]'),
+			esc_html(REQUIRED_PHP_VERSION),
+			esc_html(PHP_VERSION)
+		);
+		echo '</p></div>';
+	});
+	add_action('admin_init', function () {
+		deactivate_plugins(plugin_basename(__FILE__));
+	});
+	return;
+}

package/files/plugin-root.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Plugin Name: [Plugin Name Placeholder]
+ * Description: [Plugin Description Placeholder]
+ * Version: 0.0.1
+ * Author: iService
+ * Requires at least: [wp-version-placeholder]
+ * Requires PHP: [php-version-placeholder]
+ * Author URI: https://iservice.at
+ * Text Domain: [text-domain-placeholder]
+ * Domain Path: /languages
+ * Update URI: false
+ */
+
+if (!defined('ABSPATH'))
+	exit;
+
+define('PLUGIN_TYPE', 'general');
+
+const REQUIRED_BASE_VERSION = '[base-version-placeholder]';
+// Note: These values should match the plugin header above
+const REQUIRED_WP_VERSION = '[wp-version-placeholder]';
+const REQUIRED_PHP_VERSION = '[php-version-placeholder]';
+
+
+function plugin_slug_placeholder_bootstrap() {
+	if (file_exists(__DIR__ . '/vendor/autoload.php')) {
+		require __DIR__ . '/vendor/autoload.php';
+	}
+	require_once plugin_dir_path(__FILE__) . 'includes/autoloader.php';
+	new \IS\Autoloader(
+		'[NamespacePlaceholder]',
+		plugin_dir_path(__FILE__) . 'includes/lib'
+	);
+
+	\NamespacePlaceholder\Core\Plugin::boot(__FILE__);
+}
+
+add_action('plugins_loaded', function () {
+
+	if (!did_action('is/base/loaded')) {
+		add_action('admin_notices', function () {
+			echo '<div class="notice notice-error"><p>';
+			printf(
+				esc_html__(
+					'%s requires IS Base Plugin to be installed and activated.',
+					'[text-domain-placeholder]'
+				),
+				esc_html('[Plugin Name Placeholder]')
+			);
+			echo '</p></div>';
+		});
+		add_action('admin_init', function () {
+			deactivate_plugins(plugin_basename(__FILE__));
+		});
+		return;
+	}
+
+	if (!\IS\Base\Core\Plugin_Requirements::check_base_version(
+		REQUIRED_BASE_VERSION,
+		'[Plugin Name Placeholder]',
+		__FILE__
+	)) {
+		return;
+	}
+
+	if(!IS\Base\Core\Plugin_Requirements::check(
+		'[Plugin Name Placeholder]',
+		REQUIRED_WP_VERSION,
+		REQUIRED_PHP_VERSION,
+		__FILE__
+	)) {
+		return;
+	}
+
+	plugin_slug_placeholder_bootstrap();
+}, 20);
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iservice-dev/is-wp-plugin-kit",
-  "version": "1.6.11",
+  "version": "1.7.2",
   "description": "A toolkit for WordPress plugin development with Vite, TypeScript, and modern build tools",
   "type": "module",
   "main": "vite/index.js",