Feature/v2 refactor and renamer

.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - 'feature/**'
+      - 'fix/**'
+  pull_request:
+
+jobs:
+  ci:
+    name: Validate, lint, test, and build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['8.3', '8.4']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: composer:v2
+          coverage: none
+
+      - name: Validate composer.json
+        run: composer validate --strict
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: composer-${{ runner.os }}-${{ matrix.php }}-${{ hashFiles('composer.lock') }}
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Install Node dependencies
+        run: npm ci
+
+      - name: Lint
+        run: composer test:lint
+
+      - name: Test
+        run: composer test:unit
+
+      - name: Check i18n text domains
+        run: composer check-i18n
+
+      - name: Build release ZIP
+        run: composer build
+
+      - name: Upload ZIP artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: framework-demo-${{ matrix.php }}
+          path: dist/*.zip

.gitignore

@@ -1,19 +1,24 @@
 
-# Composer
-vendor/*
-!vendor/.gitkeep
+# Dependencies
+/vendor/
+/vendor-prefixed/
+/node_modules/
+/build/node_modules/
 
-# dev
-bower_components
-node_modules
-npm-debug.log
-yarn-error.log
-vendor
+# Generated artifacts
+/dist/
+/release/
+/build/dist/
+/build/release/
+/*.zip
 *.map
 *.log
 reports/
-dist/
-release/
+npm-debug.log
+yarn-error.log
+.phpunit.cache/
+.phpunit.result.cache
+.phpcs-cache
 
 # Editor
 .vscode

README.md

@@ -1,42 +1,77 @@
-This is the development repository of a demo plugin for WordPress built using the Saltus Framework for WordPress.
+# Saltus Framework Demo
 
-The following are needed to work with this project:
- 1.   [Composer](https://getcomposer.org/) to manage PHP dependencies
- 2.   [Node.js](https://nodejs.org/en/) to handle release tasks using [grunt](https://gruntjs.com/)
+This is a modern demo plugin for building WordPress plugins with the Saltus Framework.
 
-## How to use this Demo Plugin to create your own:
+It shows how to register custom post types, taxonomies, admin columns, filters, meta boxes, settings pages, assets, and translations using Saltus model configuration files.
 
-1. Download, fork or clone this repository
-2. Make the necessary name changes to the folder and main file ( framework-demo.php )
-3. Edit the header of the main file, so that the plugin has the proper information
-4. Replace the text domain used by the plugin ( You can do a find/replace for `‘framework-demo’` )
-5. Replace Namespace used (optional) ( You can do a find/replace for `PluginFrameworkDemo` for example)
-6. Optionally create a git repository for your project
+## Requirements
 
-## To start development:
+- PHP 8.3 or newer
+- WordPress with Composer-installed plugin dependencies
+- Composer 2
 
-1.  Open the build folder in the terminal and run: `composer install` and `npm install`
-2.  And now the fun part: edit the files in src/models to create your own model. Check [Saltus Framework Documentation](https://github.com/SaltusDev/saltus-framework) to understand how to use models.
+## Setup
 
-We are working on providing a more simple way to start using this demo for less experienced developers.
+From the plugin directory:
 
+```bash
+composer install
+```
 
-## Available Grunt Tasks
+Then activate **Saltus Framework Demo** in WordPress.
 
-All grunt tasks run inside the build folder.
+The demo models live in `src/models`:
 
-**Main Release Tasks:**
+- `post-type-basic.php` registers a small `movie` post type.
+- `post-type-all.php` registers the larger `book` demo, including meta fields and settings.
+- `taxonomy-multiple.php` registers demo taxonomies for books and posts.
 
+## Rebrand This Demo
 
-`grunt bump` - Will do a minor increase in the plugin version
+The plugin includes a generator UI for creating your own branded copy of the demo plugin. In wp-admin, open **Tools > Rebrand This Demo** or use the **Rebrand This Demo** quick action on the plugin row.
 
+Fill in the form with the identity your new plugin should use:
 
-`grunt release` - Runs multiple tasks to prepare your plugin for release, creating in the end a release folder and zip file inside the build/release folder. These files should be ready for distribution.
+- **Plugin Name**: the public name shown in WordPress.
+- **Plugin Slug**: a lowercase folder-safe slug, such as `my-saltus-plugin`.
+- **Main Plugin File**: the main PHP file, usually matching the slug, such as `my-saltus-plugin.php`.
+- **Namespace Segment**: a PHP namespace segment like `MySaltusPlugin`.
+- **Description**: the plugin summary shown in wp-admin.
+- **Author details**: the author name and optional author/plugin URLs.
+- **Version**: a semver value such as `1.0.0`.
+- **Code Prefix**: a lowercase PHP-safe prefix like `my_saltus_plugin`.
 
+After filling in the form, choose one of two install paths:
 
-**Other Development tasks:**
-`grunt bs` - browser sync
-`grunt i18n` - internationalization
-`grunt build` - compiles files
-`grunt dev` - compiles files
-`grunt prod` - compiles files
+- **Download Rebranded Plugin ZIP**: download the ZIP, then upload it from **Plugins > Add New > Upload Plugin** and activate it.
+- **Copy & Activate Plugin**: copy the generated plugin directly into this WordPress site's plugins directory and activate it automatically.
+
+The generated plugin is a separate copy. The installed demo plugin is not modified.
+
+## Development Commands
+
+```bash
+composer validate --strict
+vendor/bin/phpcs
+vendor/bin/phpunit
+composer package
+```
+
+`composer package` creates `dist/framework-demo-<version>.zip`.
+
+`composer make-pot` uses WP-CLI to rebuild `languages/framework-demo.pot` when WP-CLI is available.
+
+## Releasing
+
+Build the release ZIP with:
+
+```bash
+composer install --no-dev --optimize-autoloader
+composer package
+```
+
+The package script excludes development-only directories such as `.git`, `node_modules`, `build`, `dist`, `release`, and reports.
+
+## Notes
+
+This repository is intentionally a demo and starter. Keep the Saltus model files that help explain framework capabilities, and delete or rename demo models when generating a production plugin.

assets/css/admin-style.css

@@ -0,0 +1,41 @@
+.framework-demo-renamer__layout {
+	display: grid;
+	grid-template-columns: minmax(0, 1fr) 360px;
+	gap: 24px;
+	align-items: start;
+	max-width: 1180px;
+}
+
+.framework-demo-renamer__form,
+.framework-demo-renamer__guide {
+	background: #fff;
+	border: 1px solid #c3c4c7;
+	box-sizing: border-box;
+	padding: 16px 20px;
+}
+
+.framework-demo-renamer__form .form-table {
+	margin-top: 0;
+}
+
+.framework-demo-renamer__guide h2 {
+	margin-top: 0;
+}
+
+.framework-demo-renamer__guide h3 {
+	margin: 18px 0 8px;
+}
+
+.framework-demo-renamer__guide ol {
+	margin-left: 20px;
+}
+
+.framework-demo-renamer__guide li {
+	margin-bottom: 8px;
+}
+
+@media (max-width: 960px) {
+	.framework-demo-renamer__layout {
+		grid-template-columns: 1fr;
+	}
+}