Compare commits
28 Commits
df7f303ffb
...
bugfix/ci-
| Author | SHA1 | Date | |
|---|---|---|---|
| fdebfcb986 | |||
| 7eb7aedc39 | |||
| 9cddf28c09 | |||
| a1e5b166ff | |||
| 79829ddce0 | |||
| ef43525c4a | |||
| 708acc39de | |||
| 40f6f596fa | |||
| 0b17fe8ad9 | |||
| a8f968562c | |||
| 595855ce10 | |||
| 1d41af86c3 | |||
| a6db436a48 | |||
| 4a817ab231 | |||
| 1f96fe9965 | |||
| 5d148f8af9 | |||
| 0e906eb981 | |||
| 02a635f72c | |||
| 6625e8ca4a | |||
| 52632ec322 | |||
| 1c1980bb22 | |||
| 41724f72c0 | |||
| 58f5f8f71b | |||
| a9d9c69b65 | |||
| b58036f3f5 | |||
| 3f695bb003 | |||
| 340628877c | |||
| 6684375ea3 |
@@ -8,8 +8,13 @@ This document provides guidance for AI assistants to help with code review for t
|
||||
|
||||
Before submitting code for review, test it with WordPress Playground:
|
||||
|
||||
* [ ] Test in single site environment: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=5)
|
||||
* [ ] Test in multisite environment: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=18)
|
||||
* [ ] Test in single site environment:
|
||||
[Open in WordPress Playground][playground-single]
|
||||
* [ ] Test in multisite environment:
|
||||
[Open in WordPress Playground][playground-multisite]
|
||||
|
||||
[playground-single]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=5
|
||||
[playground-multisite]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=18
|
||||
* [ ] Verify plugin functionality works in both environments
|
||||
* [ ] Check for any JavaScript errors in the browser console
|
||||
* [ ] Run Cypress tests locally: `npm run test:playground:single` and `npm run test:playground:multisite`
|
||||
@@ -257,10 +262,20 @@ In function `handle_remove_reference()`:
|
||||
3. The success message should be translatable:
|
||||
```php
|
||||
// Change this:
|
||||
add_settings_error('fpden', 'fpden_removed', 'Plugin reference removed successfully.', 'updated');
|
||||
add_settings_error(
|
||||
'fpden',
|
||||
'fpden_removed',
|
||||
'Plugin reference removed successfully.',
|
||||
'updated'
|
||||
);
|
||||
|
||||
// To this:
|
||||
add_settings_error('fpden', 'fpden_removed', __('Plugin reference removed successfully.', 'fix-plugin-does-not-exist-notices'), 'updated');
|
||||
add_settings_error(
|
||||
'fpden',
|
||||
'fpden_removed',
|
||||
__( 'Plugin reference removed successfully.', 'fix-plugin-does-not-exist-notices' ),
|
||||
'updated'
|
||||
);
|
||||
```
|
||||
```
|
||||
|
||||
|
||||
@@ -23,34 +23,39 @@ AI assistants can directly monitor GitHub Actions workflows using the GitHub API
|
||||
|
||||
This helps identify failures and diagnose issues:
|
||||
|
||||
```
|
||||
```text
|
||||
github-api /repos/{owner}/{repo}/actions/runs
|
||||
```
|
||||
|
||||
#### Step-by-Step Process
|
||||
|
||||
1. **Get Recent Workflow Runs**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/runs
|
||||
```
|
||||
|
||||
2. **Filter for Failed Runs**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/runs?status=failure
|
||||
```
|
||||
|
||||
3. **Get Details for a Specific Run**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/runs/{run_id}
|
||||
```
|
||||
|
||||
4. **Get Jobs for a Workflow Run**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/runs/{run_id}/jobs
|
||||
```
|
||||
|
||||
5. **Analyze Job Logs** (if accessible via API):
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/jobs/{job_id}/logs
|
||||
```
|
||||
|
||||
@@ -61,6 +66,7 @@ github-api /repos/{owner}/{repo}/actions/runs
|
||||
**Error**: `Missing download info for actions/upload-artifact@v3`
|
||||
|
||||
**Solution**: Update to the latest version of the action:
|
||||
|
||||
```yaml
|
||||
uses: actions/upload-artifact@v4
|
||||
```
|
||||
@@ -70,6 +76,7 @@ uses: actions/upload-artifact@v4
|
||||
**Error**: `The current host is 127.0.0.1:8888, but WordPress multisites do not support custom ports.`
|
||||
|
||||
**Solution**: Use port 80 for multisite environments:
|
||||
|
||||
```yaml
|
||||
npx @wp-playground/cli server --blueprint playground/multisite-blueprint.json --port 80 --login &
|
||||
```
|
||||
@@ -79,6 +86,7 @@ npx @wp-playground/cli server --blueprint playground/multisite-blueprint.json --
|
||||
**Error**: Invalid path syntax for artifacts
|
||||
|
||||
**Solution**: Use multi-line format for better readability:
|
||||
|
||||
```yaml
|
||||
path: |
|
||||
cypress/videos
|
||||
@@ -90,6 +98,7 @@ path: |
|
||||
**Problem**: Redundant workflow runs when multiple commits land quickly
|
||||
|
||||
**Solution**: Add concurrency control to cancel in-progress runs:
|
||||
|
||||
```yaml
|
||||
concurrency:
|
||||
group: playground-tests-${{ github.ref }}
|
||||
@@ -125,16 +134,19 @@ npm run test:playground:multisite
|
||||
### Capturing and Analyzing Test Output
|
||||
|
||||
1. **Run Tests with Output Capture**:
|
||||
|
||||
```bash
|
||||
npm run test:single > test-output.log 2>&1
|
||||
```
|
||||
|
||||
2. **Analyze Output for Errors**:
|
||||
|
||||
```bash
|
||||
cat test-output.log | grep -i 'error\|fail\|exception'
|
||||
```
|
||||
|
||||
3. **Parse Structured Test Results** (if available):
|
||||
|
||||
```bash
|
||||
cat cypress/results/results.json
|
||||
```
|
||||
@@ -146,6 +158,7 @@ npm run test:playground:multisite
|
||||
**Error**: `The current host is 127.0.0.1:8888, but WordPress multisites do not support custom ports.`
|
||||
|
||||
**Solution**: Modify the port in the blueprint or test configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"features": {
|
||||
@@ -159,6 +172,7 @@ npm run test:playground:multisite
|
||||
**Error**: `Timed out retrying after 4000ms: expected '<body...>' to have class 'wp-admin'`
|
||||
|
||||
**Solution**: Update selectors to be more robust and handle login states:
|
||||
|
||||
```javascript
|
||||
cy.get('body').then(($body) => {
|
||||
if ($body.hasClass('login')) {
|
||||
@@ -199,16 +213,19 @@ npm run lint:css
|
||||
### Parsing Code Quality Tool Output
|
||||
|
||||
1. **Run Code Quality Check**:
|
||||
|
||||
```bash
|
||||
composer run phpcs > phpcs-output.log 2>&1
|
||||
```
|
||||
|
||||
2. **Analyze Output for Errors**:
|
||||
|
||||
```bash
|
||||
cat phpcs-output.log | grep -i 'ERROR\|WARNING'
|
||||
```
|
||||
|
||||
3. **Automatically Fix Issues** (when possible):
|
||||
|
||||
```bash
|
||||
composer run phpcbf
|
||||
```
|
||||
@@ -221,13 +238,13 @@ AI assistants can check these comments to identify and address issues.
|
||||
|
||||
#### Accessing PR Comments via GitHub API
|
||||
|
||||
```
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/pulls/{pull_number}/comments
|
||||
```
|
||||
|
||||
#### Accessing PR Review Comments
|
||||
|
||||
```
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/pulls/{pull_number}/reviews
|
||||
```
|
||||
|
||||
@@ -236,7 +253,8 @@ github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/pulls/{pul
|
||||
CodeRabbit provides AI-powered code review comments via the GitHub API.
|
||||
|
||||
1. **Get PR Comments**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/pulls/{pull_number}/comments
|
||||
```
|
||||
|
||||
@@ -254,12 +272,14 @@ CodeRabbit provides AI-powered code review comments via the GitHub API.
|
||||
These tools provide automated code quality checks and post results as PR comments.
|
||||
|
||||
1. **Check PR Status Checks**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/commits/{sha}/check-runs
|
||||
```
|
||||
|
||||
2. **Get Detailed Reports** (if available via API):
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/commits/{sha}/check-runs/{id}
|
||||
```
|
||||
|
||||
@@ -275,7 +295,8 @@ These tools provide automated code quality checks and post results as PR comment
|
||||
SonarCloud provides detailed code quality and security analysis.
|
||||
|
||||
1. **Check SonarCloud Status**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/commits/{sha}/check-runs?check_name=SonarCloud
|
||||
```
|
||||
|
||||
@@ -293,6 +314,7 @@ SonarCloud provides detailed code quality and security analysis.
|
||||
**Error**: `ERROR: Expected snake_case for function name, but found camelCase`
|
||||
|
||||
**Solution**: Rename functions to follow snake_case convention:
|
||||
|
||||
```php
|
||||
// Before
|
||||
function getPluginVersion() { ... }
|
||||
@@ -306,6 +328,7 @@ function get_plugin_version() { ... }
|
||||
**Error**: `ERROR: Missing doc comment for function`
|
||||
|
||||
**Solution**: Add proper docblocks:
|
||||
|
||||
```php
|
||||
/**
|
||||
* Get the plugin version.
|
||||
@@ -332,7 +355,8 @@ function get_plugin_version() { ... }
|
||||
#### Extracting Actionable Items from PR Comments
|
||||
|
||||
1. **Collect All Feedback**:
|
||||
```
|
||||
|
||||
```text
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/pulls/{number}/comments
|
||||
github-api /repos/wpallstars/wp-plugin-starter-template-for-ai-coding/pulls/{number}/reviews
|
||||
```
|
||||
@@ -364,28 +388,14 @@ function get_plugin_version() { ... }
|
||||
|
||||
### Complete Feedback Loop System
|
||||
|
||||
```
|
||||
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
|
||||
│ │ │ │ │ │
|
||||
│ Code Changes │────▶│ Local Testing │────▶│ GitHub Actions │
|
||||
│ │ │ │ │ │
|
||||
└────────┬────────┘ └────────┬────────┘ └────────┬────────┘
|
||||
│ │ │
|
||||
│ │ │
|
||||
│ │ │
|
||||
┌────────▼────────┐ ┌────────▼────────┐ ┌────────▼────────┐
|
||||
│ │ │ │ │ │
|
||||
│ AI Assistant │◀────│ Error Analysis │◀────│ Status Check │
|
||||
│ │ │ │ │ │
|
||||
└────────┬────────┘ └─────────────────┘ └─────────────────┘
|
||||
│
|
||||
│
|
||||
│
|
||||
┌────────▼────────┐ ┌─────────────────┐
|
||||
│ │ │ │
|
||||
│ Fix Generation │────▶│ Human Review │ (only when necessary)
|
||||
│ │ │ │
|
||||
└─────────────────┘ └─────────────────┘
|
||||
```text
|
||||
Code Changes ──► Local Testing ──► GitHub Actions
|
||||
│ │ │
|
||||
▼ ▼ ▼
|
||||
AI Assistant ◀── Error Analysis ◀── Status Check
|
||||
│
|
||||
▼
|
||||
Fix Generation ──► Human Review (only when necessary)
|
||||
```
|
||||
|
||||
### Key Components
|
||||
@@ -409,7 +419,7 @@ These can be directly accessed and processed.
|
||||
|
||||
#### Example CodeRabbit Feedback
|
||||
|
||||
```
|
||||
```text
|
||||
coderabbitai bot left a comment
|
||||
Actionable comments posted: 1
|
||||
|
||||
@@ -438,14 +448,14 @@ These tools provide structured feedback that can be systematically addressed.
|
||||
|
||||
#### Example SonarCloud Feedback
|
||||
|
||||
```
|
||||
```text
|
||||
SonarCloud Quality Gate failed
|
||||
- 3 Bugs
|
||||
- 5 Code Smells
|
||||
- 1 Security Hotspot
|
||||
```
|
||||
|
||||
#### Processing Steps
|
||||
#### SonarCloud Processing Steps
|
||||
|
||||
1. **Access Detailed Reports**:
|
||||
* Use the SonarCloud API or web interface
|
||||
@@ -485,6 +495,78 @@ When consulting humans, provide:
|
||||
4. **Specific Questions**: Ask targeted questions rather than open-ended ones
|
||||
5. **Recommendations**: Suggest possible solutions for approval
|
||||
|
||||
## Contributing to External Repositories
|
||||
|
||||
When issues are caused by bugs or missing features in external dependencies or GitHub Actions,
|
||||
AI assistants can contribute fixes upstream.
|
||||
|
||||
### Workflow for External Contributions
|
||||
|
||||
1. **Clone the Repository Locally**:
|
||||
|
||||
```bash
|
||||
cd ~/Git
|
||||
git clone https://github.com/owner/repo.git
|
||||
cd repo
|
||||
git checkout -b feature/descriptive-branch-name
|
||||
```
|
||||
|
||||
2. **Make Changes and Commit**:
|
||||
|
||||
```bash
|
||||
# Make your changes
|
||||
git add -A
|
||||
git commit -m "Descriptive commit message
|
||||
|
||||
Detailed explanation of what the change does and why.
|
||||
|
||||
Fixes #issue-number"
|
||||
```
|
||||
|
||||
3. **Fork and Push**:
|
||||
|
||||
```bash
|
||||
# Create a fork (if not already forked)
|
||||
gh repo fork owner/repo --clone=false --remote=true
|
||||
|
||||
# Add fork as remote
|
||||
git remote add fork https://github.com/your-username/repo.git
|
||||
|
||||
# Push to fork
|
||||
git push fork feature/descriptive-branch-name
|
||||
```
|
||||
|
||||
4. **Create Pull Request**:
|
||||
|
||||
```bash
|
||||
gh pr create \
|
||||
--repo owner/repo \
|
||||
--head your-username:feature/descriptive-branch-name \
|
||||
--title "Clear, descriptive title" \
|
||||
--body "## Summary
|
||||
|
||||
Description of changes...
|
||||
|
||||
Fixes #issue-number"
|
||||
```
|
||||
|
||||
### Best Practices for External Contributions
|
||||
|
||||
* Always clone to `~/Git/` for consistency
|
||||
* Check existing issues and PRs before starting work
|
||||
* Follow the project's contribution guidelines
|
||||
* Keep changes focused and minimal
|
||||
* Include tests if the project has a test suite
|
||||
* Reference the issue number in commits and PR description
|
||||
|
||||
### Local Repository Management
|
||||
|
||||
Keep cloned repositories in `~/Git/` organized:
|
||||
|
||||
* `~/Git/wp-plugin-starter-template-for-ai-coding/` - Main project
|
||||
* `~/Git/wp-performance-action/` - Forked for contributions
|
||||
* Other cloned repos as needed
|
||||
|
||||
## Conclusion
|
||||
|
||||
This error checking and feedback loop system creates a comprehensive framework for AI-driven development.
|
||||
|
||||
14
.eslintrc.js
14
.eslintrc.js
@@ -16,9 +16,23 @@ module.exports = {
|
||||
sourceType: 'module'
|
||||
},
|
||||
rules: {
|
||||
'comma-dangle': ['error', 'never'],
|
||||
'no-console': 'warn',
|
||||
'no-unused-vars': 'warn'
|
||||
},
|
||||
overrides: [
|
||||
{
|
||||
// cypress.config.js uses CommonJS (require/module.exports).
|
||||
// Override sourceType to 'script' so ESLint does not flag require as undefined.
|
||||
files: ['cypress.config.js', 'cypress.config.cjs'],
|
||||
parserOptions: {
|
||||
sourceType: 'script'
|
||||
},
|
||||
env: {
|
||||
node: true
|
||||
}
|
||||
}
|
||||
],
|
||||
globals: {
|
||||
cy: 'readonly',
|
||||
Cypress: 'readonly',
|
||||
|
||||
24
.github/workflows/code-quality.yml
vendored
24
.github/workflows/code-quality.yml
vendored
@@ -1,8 +1,10 @@
|
||||
name: Code Quality
|
||||
|
||||
on:
|
||||
# Only run on push to main (not feature branches) to avoid duplicate runs.
|
||||
# Feature branches get CI via pull_request trigger.
|
||||
push:
|
||||
branches: [ main, feature/* ]
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
workflow_dispatch:
|
||||
@@ -25,12 +27,9 @@ jobs:
|
||||
tools: composer:v2
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress
|
||||
|
||||
- name: Install WordPress Coding Standards
|
||||
run: |
|
||||
composer require --dev wp-coding-standards/wpcs dealerdirect/phpcodesniffer-composer-installer
|
||||
vendor/bin/phpcs --config-set installed_paths vendor/wp-coding-standards/wpcs
|
||||
uses: ramsey/composer-install@83af392bf5f031813d25e6fe4cd626cdba9a2df6 # v2.2.0
|
||||
with:
|
||||
composer-options: "--prefer-dist --no-progress"
|
||||
|
||||
- name: Run PHPCS
|
||||
run: composer phpcs
|
||||
@@ -57,10 +56,9 @@ jobs:
|
||||
tools: composer:v2, phpstan
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress
|
||||
|
||||
- name: Install PHPStan WordPress stubs
|
||||
run: composer require --dev szepeviktor/phpstan-wordpress
|
||||
uses: ramsey/composer-install@83af392bf5f031813d25e6fe4cd626cdba9a2df6 # v2.2.0
|
||||
with:
|
||||
composer-options: "--prefer-dist --no-progress"
|
||||
|
||||
- name: Run PHPStan
|
||||
run: composer phpstan
|
||||
@@ -81,7 +79,9 @@ jobs:
|
||||
tools: composer:v2, phpmd
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress
|
||||
uses: ramsey/composer-install@83af392bf5f031813d25e6fe4cd626cdba9a2df6 # v2.2.0
|
||||
with:
|
||||
composer-options: "--prefer-dist --no-progress"
|
||||
|
||||
- name: Run PHPMD
|
||||
run: composer phpmd
|
||||
|
||||
4
.github/workflows/phpunit.yml
vendored
4
.github/workflows/phpunit.yml
vendored
@@ -1,8 +1,10 @@
|
||||
name: PHPUnit Tests
|
||||
|
||||
on:
|
||||
# Only run on push to main (not feature branches) to avoid duplicate runs.
|
||||
# Feature branches get CI via pull_request trigger.
|
||||
push:
|
||||
branches: [ main, feature/* ]
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
workflow_dispatch:
|
||||
|
||||
10
.github/workflows/playground-tests.yml
vendored
10
.github/workflows/playground-tests.yml
vendored
@@ -8,8 +8,10 @@ name: WordPress Playground Tests
|
||||
# npm run playground:start:multisite
|
||||
|
||||
on:
|
||||
# Only run on push to main (not feature branches) to avoid duplicate runs.
|
||||
# Feature branches get CI via pull_request trigger.
|
||||
push:
|
||||
branches: [ main, feature/* ]
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
workflow_dispatch:
|
||||
@@ -248,7 +250,11 @@ jobs:
|
||||
name: WordPress Performance Tests
|
||||
runs-on: ubuntu-latest
|
||||
needs: code-quality
|
||||
# Allow failures since performance tests can be flaky in CI environments
|
||||
# DISABLED: Performance tests are flaky in CI due to Lighthouse/Playwright resource constraints.
|
||||
# The wp-performance-action uses WordPress Playground internally and Lighthouse for metrics,
|
||||
# which requires significant resources and is not reliable in shared CI runners.
|
||||
# Run performance tests locally or on dedicated infrastructure for accurate results.
|
||||
if: false
|
||||
continue-on-error: true
|
||||
|
||||
steps:
|
||||
|
||||
7
.github/workflows/release.yml
vendored
7
.github/workflows/release.yml
vendored
@@ -34,7 +34,12 @@ jobs:
|
||||
echo "VERSION=$VERSION" >> $GITHUB_ENV
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --no-dev --optimize-autoloader
|
||||
run: |
|
||||
for i in 1 2 3; do
|
||||
composer install --no-dev --optimize-autoloader --prefer-dist && break
|
||||
echo "Composer install attempt $i failed, retrying in 15s..."
|
||||
sleep 15
|
||||
done
|
||||
|
||||
- name: Create build directory
|
||||
run: |
|
||||
|
||||
21
.github/workflows/tests.yml
vendored
21
.github/workflows/tests.yml
vendored
@@ -28,17 +28,13 @@ jobs:
|
||||
extensions: mbstring, intl, zip
|
||||
tools: composer:v2
|
||||
|
||||
- name: Clear Composer Cache
|
||||
run: composer clear-cache
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress
|
||||
uses: ramsey/composer-install@83af392bf5f031813d25e6fe4cd626cdba9a2df6 # v2.2.0
|
||||
with:
|
||||
composer-options: "--prefer-dist --no-progress"
|
||||
|
||||
# - name: Debug test file content
|
||||
# run: echo "--- Debugging tests/test-admin.php lines 75-95 ---" && sed -n '75,95p' tests/test-admin.php && echo "--- End Debugging ---"
|
||||
|
||||
# - name: Run tests
|
||||
# run: ./vendor/bin/phpunit
|
||||
- name: Run tests
|
||||
run: ./vendor/bin/phpunit
|
||||
|
||||
code-style:
|
||||
name: Code Style
|
||||
@@ -57,11 +53,10 @@ jobs:
|
||||
extensions: mbstring, intl, zip
|
||||
tools: composer:v2, phpcs
|
||||
|
||||
- name: Clear Composer Cache
|
||||
run: composer clear-cache
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress
|
||||
uses: ramsey/composer-install@83af392bf5f031813d25e6fe4cd626cdba9a2df6 # v2.2.0
|
||||
with:
|
||||
composer-options: "--prefer-dist --no-progress"
|
||||
|
||||
- name: Run PHPCS
|
||||
run: composer run phpcs
|
||||
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -62,3 +62,7 @@ temp/
|
||||
# Test Coverage
|
||||
coverage/
|
||||
.phpunit.result.cache
|
||||
.agents/loop-state/
|
||||
|
||||
# Local tool configs
|
||||
.superset/
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
{
|
||||
"MD004": {
|
||||
"style": "asterisk"
|
||||
},
|
||||
"MD012": false,
|
||||
"MD022": false,
|
||||
"MD031": false,
|
||||
|
||||
@@ -67,7 +67,7 @@ if ($condition) {
|
||||
### Documentation
|
||||
|
||||
* All classes, methods, and functions should be documented using PHPDoc
|
||||
* Include a description, parameters, return values, and exceptions
|
||||
* Include descriptions of parameters, return values, and any exceptions thrown
|
||||
|
||||
```php
|
||||
/**
|
||||
@@ -271,7 +271,7 @@ To ensure your code passes the quality checks from these tools, follow these gui
|
||||
3. **Using AI Assistants with Code Quality Tools**
|
||||
* When you receive feedback from code quality tools, you can use AI assistants to help address the issues
|
||||
* Copy the output from the code quality tool and paste it into your AI assistant chat
|
||||
* Ask the AI to help you understand and resolve the issues
|
||||
* Request the AI's assistance to interpret and resolve the reported issues
|
||||
* Example prompt:
|
||||
|
||||
```text
|
||||
|
||||
@@ -6,11 +6,11 @@ Thank you for considering contributing to this project! This document provides g
|
||||
|
||||
By participating in this project, you agree to abide by our code of conduct:
|
||||
|
||||
- Be respectful and inclusive
|
||||
- Be patient and welcoming
|
||||
- Be considerate
|
||||
- Be collaborative
|
||||
- Be open-minded
|
||||
* Be respectful and inclusive
|
||||
* Be patient and welcoming
|
||||
* Be considerate
|
||||
* Be collaborative
|
||||
* Be open-minded
|
||||
|
||||
## How to Contribute
|
||||
|
||||
@@ -26,12 +26,12 @@ If you find a bug, please report it by creating an issue on GitHub:
|
||||
|
||||
Please include:
|
||||
|
||||
- A clear, descriptive title
|
||||
- Steps to reproduce the bug
|
||||
- Expected behavior
|
||||
- Actual behavior
|
||||
- Screenshots (if applicable)
|
||||
- Your environment (WordPress version, PHP version, browser, etc.)
|
||||
* A clear, descriptive title
|
||||
* Steps to reproduce the bug
|
||||
* Expected behavior
|
||||
* Actual behavior
|
||||
* Screenshots (if applicable)
|
||||
* Your environment (WordPress version, PHP version, browser, etc.)
|
||||
|
||||
### Suggesting Enhancements
|
||||
|
||||
@@ -45,10 +45,10 @@ If you have an idea for an enhancement:
|
||||
|
||||
Please include:
|
||||
|
||||
- A clear, descriptive title
|
||||
- A detailed description of the enhancement
|
||||
- Why this enhancement would be useful
|
||||
- Any relevant examples or mockups
|
||||
* A clear, descriptive title
|
||||
* A detailed description of the enhancement
|
||||
* Why this enhancement would be useful
|
||||
* Any relevant examples or mockups
|
||||
|
||||
### Pull Requests
|
||||
|
||||
@@ -72,33 +72,33 @@ If you want to contribute code:
|
||||
|
||||
#### Pull Request Guidelines
|
||||
|
||||
- Follow the coding standards (see [Coding Standards](Coding-Standards))
|
||||
- Write tests for your changes
|
||||
- Update documentation as needed
|
||||
- Keep pull requests focused on a single change
|
||||
- Write a clear, descriptive title and description
|
||||
- Reference any related issues
|
||||
- Ensure your code passes the automated code quality checks (see below)
|
||||
* Follow the coding standards (see [Coding Standards](Coding-Standards))
|
||||
* Write tests for your changes
|
||||
* Update documentation as needed
|
||||
* Keep pull requests focused on a single change
|
||||
* Write a clear, descriptive title and description
|
||||
* Reference any related issues
|
||||
* Ensure your code passes the automated code quality checks (see below)
|
||||
|
||||
#### Code Quality Tools
|
||||
|
||||
This project uses several automated code quality tools to ensure high standards. These tools are free for public repositories and will automatically analyze your code when you create a pull request:
|
||||
|
||||
1. **CodeRabbit**: AI-powered code review tool
|
||||
- [Website](https://www.coderabbit.ai/)
|
||||
- Provides automated feedback on pull requests
|
||||
* [Website](https://www.coderabbit.ai/)
|
||||
* Provides automated feedback on pull requests
|
||||
|
||||
2. **CodeFactor**: Continuous code quality monitoring
|
||||
- [Website](https://www.codefactor.io/)
|
||||
- Provides a grade for your codebase
|
||||
* [Website](https://www.codefactor.io/)
|
||||
* Provides a grade for your codebase
|
||||
|
||||
3. **Codacy**: Code quality and static analysis
|
||||
- [Website](https://www.codacy.com/)
|
||||
- Identifies issues related to code style, security, and performance
|
||||
* [Website](https://www.codacy.com/)
|
||||
* Identifies issues related to code style, security, and performance
|
||||
|
||||
4. **SonarCloud**: Code quality and security analysis
|
||||
- [Website](https://sonarcloud.io/)
|
||||
- Provides detailed analysis of code quality and security
|
||||
* [Website](https://sonarcloud.io/)
|
||||
* Provides detailed analysis of code quality and security
|
||||
|
||||
#### Using AI Assistants with Code Quality Tools
|
||||
|
||||
@@ -106,7 +106,7 @@ When you receive feedback from these code quality tools, you can use AI assistan
|
||||
|
||||
1. Copy the output from the code quality tool
|
||||
2. Paste it into your AI assistant chat
|
||||
3. Ask the AI to help you understand and resolve the issues
|
||||
3. Request the AI's assistance to interpret and resolve the reported issues
|
||||
4. Apply the suggested fixes
|
||||
5. Commit the changes and verify that the issues are resolved
|
||||
|
||||
@@ -143,7 +143,7 @@ To ensure your code meets the quality standards, run these commands before submi
|
||||
* Check JavaScript coding standards: `npm run lint:js`
|
||||
* Check CSS coding standards: `npm run lint:css`
|
||||
|
||||
These checks will help identify and fix issues before they are caught by the automated code quality tools in the pull request process.
|
||||
These checks will assist in identifying and resolving issues before they are caught by the automated code quality tools in the pull request process.
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -17,13 +17,17 @@ It uses WebAssembly, which means:
|
||||
|
||||
The easiest way to test our plugin with WordPress Playground is to use the online version:
|
||||
|
||||
1. Single site testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=2)
|
||||
1. Single site testing: [Open in WordPress Playground][playground-single]
|
||||
|
||||
2. Multisite testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=2)
|
||||
2. Multisite testing: [Open in WordPress Playground][playground-multisite]
|
||||
|
||||
These links automatically set up WordPress with multisite enabled and WP_DEBUG enabled.
|
||||
[playground-single]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=2
|
||||
[playground-multisite]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=2
|
||||
|
||||
Both the Plugin Toggle and Kadence Blocks plugins are pre-activated.
|
||||
Both links automatically set up WordPress with WP_DEBUG enabled and the Plugin Toggle and
|
||||
Kadence Blocks plugins pre-installed and activated.
|
||||
|
||||
The multisite link additionally enables WordPress multisite and network-activates both plugins.
|
||||
|
||||
## WP-CLI Commands for WordPress Playground
|
||||
|
||||
@@ -98,14 +102,14 @@ In a WordPress multisite environment, there are two ways to activate plugins:
|
||||
1. **Network Activation**: Activates a plugin for all sites in the network
|
||||
* In the WordPress admin, go to Network Admin > Plugins
|
||||
* Click "Network Activate" under the plugin
|
||||
* Or use WP-CLI: `wp plugin install plugin-name --activate-network`
|
||||
* Or use WP-CLI: `wp plugin activate plugin-name --network`
|
||||
|
||||
2. **Per-Site Activation**: Activates a plugin for a specific site
|
||||
* In the WordPress admin, go to the specific site's admin area
|
||||
* Go to Plugins and activate the plugin for that site only
|
||||
* Or use WP-CLI: `wp plugin activate plugin-name --url=site-url`
|
||||
|
||||
Our multisite blueprint uses network activation for the Plugin Toggle plugin as an example.
|
||||
Our multisite blueprint uses network activation for both the Plugin Toggle and Kadence Blocks plugins.
|
||||
|
||||
## Running Tests with WordPress Playground
|
||||
|
||||
@@ -117,8 +121,8 @@ We have two blueprints for testing:
|
||||
To run tests with WordPress Playground:
|
||||
|
||||
1. Open the appropriate WordPress Playground link:
|
||||
* [Single site](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=2)
|
||||
* [Multisite](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=2)
|
||||
* [Single site][playground-single]
|
||||
* [Multisite][playground-multisite]
|
||||
|
||||
2. Test the plugin manually in the browser
|
||||
|
||||
@@ -128,7 +132,8 @@ We've also included HTML files that embed WordPress Playground:
|
||||
|
||||
1. Open `playground/index.html` in your browser for single site testing
|
||||
2. Open `playground/multisite.html` in your browser for multisite testing
|
||||
3. Open `playground/test.html` in your browser for a unified interface with buttons to switch between single site and multisite
|
||||
3. Open `playground/test.html` in your browser for a unified interface with buttons
|
||||
to switch between single site and multisite
|
||||
|
||||
You can serve these files locally with a simple HTTP server:
|
||||
|
||||
@@ -169,7 +174,9 @@ This will start a local WordPress instance with your plugin installed and activa
|
||||
|
||||
You can customize the blueprints to suit your testing needs.
|
||||
|
||||
See the [WordPress Playground Blueprints documentation](https://wordpress.github.io/wordpress-playground/blueprints/) for details.
|
||||
See the [WordPress Playground Blueprints documentation][blueprints-docs] for details.
|
||||
|
||||
[blueprints-docs]: https://wordpress.github.io/wordpress-playground/blueprints/
|
||||
|
||||
## WordPress Playground JavaScript API
|
||||
|
||||
|
||||
@@ -134,9 +134,12 @@ WordPress Playground runs WordPress entirely in the browser using WebAssembly. T
|
||||
|
||||
The easiest way to test our plugin with WordPress Playground is to use the online version:
|
||||
|
||||
1. Single site testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=2)
|
||||
1. Single site testing: [Open in WordPress Playground][playground-single]
|
||||
|
||||
2. Multisite testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=2)
|
||||
2. Multisite testing: [Open in WordPress Playground][playground-multisite]
|
||||
|
||||
[playground-single]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=2
|
||||
[playground-multisite]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/multisite-blueprint.json&_t=2
|
||||
|
||||
These links automatically set up WordPress with multisite enabled and WP_DEBUG enabled.
|
||||
|
||||
@@ -148,7 +151,8 @@ We've also included HTML files that embed WordPress Playground:
|
||||
|
||||
1. Open `playground/index.html` in your browser for single site testing
|
||||
2. Open `playground/multisite.html` in your browser for multisite testing
|
||||
3. Open `playground/test.html` in your browser for a unified interface with buttons to switch between single site and multisite
|
||||
3. Open `playground/test.html` in your browser for a unified interface with buttons
|
||||
to switch between single site and multisite
|
||||
|
||||
You can serve these files locally with a simple HTTP server:
|
||||
|
||||
|
||||
25
AGENTS.md
25
AGENTS.md
@@ -99,17 +99,23 @@ For local testing with WordPress Playground, LocalWP, and wp-env, see **@.agents
|
||||
|
||||
When working in a multi-repository workspace, follow these guidelines to avoid confusion:
|
||||
|
||||
1. **Verify Repository Context**: Always check which repository you're currently working in before making any changes or recommendations.
|
||||
1. **Verify Repository Context**: Always check which repository you're currently working in
|
||||
before making any changes or recommendations.
|
||||
|
||||
2. **Limit Code Search Scope**: When searching for code or functionality, explicitly limit your search to the current repository.
|
||||
2. **Limit Code Search Scope**: When searching for code or functionality,
|
||||
explicitly limit your search to the current repository.
|
||||
|
||||
3. **Don't Assume Features**: Never assume that features present in one repository should be implemented in another. Each repository has its own specific purpose and feature set.
|
||||
3. **Don't Assume Features**: Never assume that features present in one repository
|
||||
should be implemented in another. Each repository has its own specific purpose and feature set.
|
||||
|
||||
4. **Repository-Specific Documentation**: Documentation should only reflect the actual features and functionality of the current repository.
|
||||
4. **Repository-Specific Documentation**: Documentation should only reflect the actual features
|
||||
and functionality of the current repository.
|
||||
|
||||
5. **Cross-Repository Inspiration**: If you want to implement a feature inspired by another repository, explicitly mention that it's a new feature being added, not an existing one.
|
||||
5. **Cross-Repository Inspiration**: If you want to implement a feature inspired by another
|
||||
repository, explicitly mention that it's a new feature being added, not an existing one.
|
||||
|
||||
6. **Verify Before Implementation**: Before implementing or documenting a feature, verify that it actually exists in the current repository by checking the codebase.
|
||||
6. **Verify Before Implementation**: Before implementing or documenting a feature, verify that
|
||||
it actually exists in the current repository by checking the codebase.
|
||||
|
||||
7. **Consistent Markdown Formatting**: Always use asterisks (*) for bullet points in Markdown files, not hyphens (-).
|
||||
|
||||
@@ -161,7 +167,9 @@ When working with this repository, remember these preferences:
|
||||
3. Keep code modular and maintainable
|
||||
4. Reference these preferences in future interactions
|
||||
|
||||
This ensures consistency across coding sessions and reduces the need for developers to repeatedly explain their preferences.
|
||||
This ensures consistency across coding sessions.
|
||||
|
||||
It reduces the need for developers to repeatedly explain their preferences.
|
||||
|
||||
## Autonomous CI/CD and Error Handling
|
||||
|
||||
@@ -175,7 +183,8 @@ As an AI assistant, you should:
|
||||
4. **Verify Solutions**: Ensure fixes pass all tests and quality checks
|
||||
5. **Document Resolutions**: Update documentation with solutions for future reference
|
||||
|
||||
For detailed instructions on establishing feedback loops and error checking processes, see **@.agents/error-checking-feedback-loops.md**.
|
||||
For detailed instructions on feedback loops and error checking, see
|
||||
**@.agents/error-checking-feedback-loops.md**.
|
||||
|
||||
### When to Consult Humans
|
||||
|
||||
|
||||
119
README.md
119
README.md
@@ -1,6 +1,33 @@
|
||||
# WordPress Plugin Starter Template for AI Coding
|
||||
|
||||
[](https://www.gnu.org/licenses/gpl-2.0.html) [](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/workflows/tests.yml) [](https://wordpress.org/about/requirements/) [](https://wordpress.org/about/requirements/) [](https://wordpress.org/plugins/your-plugin-slug/) [](https://wordpress.org/plugins/your-plugin-slug/reviews/) [](https://wordpress.org/plugins/your-plugin-slug/) [](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/releases) [](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/issues) [](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/graphs/contributors) [](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki)  [](https://www.codefactor.io/repository/github/wpallstars/wp-plugin-starter-template-for-ai-coding) [](https://sonarcloud.io/summary/new_code?id=wpallstars_wp-plugin-starter-template-for-ai-coding) [](https://sonarcloud.io/summary/new_code?id=wpallstars_wp-plugin-starter-template-for-ai-coding) [](https://sonarcloud.io/summary/new_code?id=wpallstars_wp-plugin-starter-template-for-ai-coding) [](https://sonarcloud.io/summary/new_code?id=wpallstars_wp-plugin-starter-template-for-ai-coding) [](https://sonarcloud.io/summary/new_code?id=wpallstars_wp-plugin-starter-template-for-ai-coding) [](https://app.codacy.com/gh/wpallstars/wp-plugin-starter-template-for-ai-coding/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
|
||||
[![License][badge-license]][url-license]
|
||||
[![Build Status][badge-build]][url-build]
|
||||
[![Requires PHP][badge-php]][url-requirements]
|
||||
[![Requires WordPress][badge-wp]][url-requirements]
|
||||
[![Wiki][badge-wiki]][url-wiki]
|
||||
[![CodeRabbit Reviews][badge-coderabbit]][url-coderabbit]
|
||||
[![CodeFactor][badge-codefactor]][url-codefactor]
|
||||
[![Quality Gate Status][badge-sonar-gate]][url-sonar]
|
||||
[![Codacy Badge][badge-codacy]][url-codacy]
|
||||
|
||||
[badge-license]: https://img.shields.io/badge/license-GPL--2.0%2B-blue.svg
|
||||
[badge-build]: https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/workflows/tests.yml/badge.svg
|
||||
[badge-php]: https://img.shields.io/badge/php-%3E%3D%207.4-blue.svg
|
||||
[badge-wp]: https://img.shields.io/badge/WordPress-%3E%3D%205.0-blue.svg
|
||||
[badge-wiki]: https://img.shields.io/badge/documentation-wiki-blue.svg
|
||||
[badge-coderabbit]: https://img.shields.io/coderabbit/prs/github/wpallstars/wp-plugin-starter-template-for-ai-coding?labelColor=171717&color=FF570A&label=CodeRabbit+Reviews
|
||||
[badge-codefactor]: https://www.codefactor.io/repository/github/wpallstars/wp-plugin-starter-template-for-ai-coding/badge
|
||||
[badge-sonar-gate]: https://sonarcloud.io/api/project_badges/measure?project=wpallstars_wp-plugin-starter-template-for-ai-coding&metric=alert_status
|
||||
[badge-codacy]: https://app.codacy.com/project/badge/Grade/905754fd010b481490b496fb800e6144
|
||||
|
||||
[url-license]: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
[url-build]: https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/actions/workflows/tests.yml
|
||||
[url-requirements]: https://wordpress.org/about/requirements/
|
||||
[url-wiki]: https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/wiki
|
||||
[url-coderabbit]: https://coderabbit.ai
|
||||
[url-codefactor]: https://www.codefactor.io/repository/github/wpallstars/wp-plugin-starter-template-for-ai-coding
|
||||
[url-sonar]: https://sonarcloud.io/summary/new_code?id=wpallstars_wp-plugin-starter-template-for-ai-coding
|
||||
[url-codacy]: https://app.codacy.com/gh/wpallstars/wp-plugin-starter-template-for-ai-coding/dashboard
|
||||
|
||||
A comprehensive starter template for WordPress plugins with best practices for AI-assisted development.
|
||||
|
||||
@@ -64,16 +91,18 @@ In most AI IDEs, you can pin these files to ensure they're considered in each me
|
||||
|
||||
To get started with this template, follow these steps:
|
||||
|
||||
1. In your terminal, navigate to the folder you keep you Git repositories (eg: `~/Git/`), then clone this repository to your local machine:
|
||||
1. Navigate to your Git repositories folder (e.g., `~/Git/`), then clone:
|
||||
```bash
|
||||
git clone https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git
|
||||
```
|
||||
|
||||
2. Open the [Starter Prompt](.wiki/Starter-Prompt.md) file and follow the instructions to customize the template for your plugin.
|
||||
2. Open the [Starter Prompt](.wiki/Starter-Prompt.md) file and follow the instructions
|
||||
to customize the template for your plugin.
|
||||
|
||||
3. Add the AGENTS.md file and .agents/ directory to your AI IDE chat context.
|
||||
|
||||
4. Use an AI assistant like GitHub Copilot, Claude, or ChatGPT to help you customize the template by providing the prompt from the Starter Prompt file.
|
||||
4. Use an AI assistant like GitHub Copilot, Claude, or ChatGPT to help customize
|
||||
the template by providing the prompt from the Starter Prompt file.
|
||||
|
||||
### Development Environment
|
||||
|
||||
@@ -111,9 +140,14 @@ The template includes multiple testing approaches:
|
||||
|
||||
Test your plugin directly in the browser without any local setup:
|
||||
|
||||
1. Single site testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=5)
|
||||
1. Single site testing:
|
||||
[Open in WordPress Playground][playground-single-readme]
|
||||
|
||||
2. Multisite testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=18)
|
||||
2. Multisite testing:
|
||||
[Open in WordPress Playground][playground-multisite-readme]
|
||||
|
||||
[playground-single-readme]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=5
|
||||
[playground-multisite-readme]: https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=18
|
||||
|
||||
For more details, see the [Playground Testing](.wiki/Playground-Testing.md) documentation.
|
||||
|
||||
@@ -197,7 +231,11 @@ This template includes functionality that allows users to choose where they want
|
||||
|
||||
### How do I customize this template for my plugin?
|
||||
|
||||
See the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions on customizing this template for your specific plugin needs. Make sure to add the AGENTS.md file and .agents/ directory to your AI IDE chat context for the best results.
|
||||
See the [Starter Prompt](.wiki/Starter-Prompt.md) file for detailed instructions on
|
||||
customizing this template for your specific plugin needs.
|
||||
|
||||
Make sure to add the AGENTS.md file and .agents/ directory to your AI IDE chat context
|
||||
for the best results.
|
||||
|
||||
### What files do I need to update with my plugin information?
|
||||
|
||||
@@ -229,7 +267,8 @@ This will create a ZIP file that you can install in WordPress.
|
||||
|
||||
### How do I add custom functionality to my plugin?
|
||||
|
||||
Customize the includes/core.php file to implement your core functionality and the admin/lib/admin.php file for admin-specific functionality.
|
||||
Customize the `includes/core.php` file to implement your core functionality and the
|
||||
`admin/lib/admin.php` file for admin-specific functionality.
|
||||
|
||||
### Is this template compatible with WordPress multisite?
|
||||
|
||||
@@ -240,7 +279,7 @@ We have a testing framework that allows you to verify functionality in both envi
|
||||
You can test multisite compatibility in two ways:
|
||||
|
||||
1. Using WordPress Playground (no Docker required):
|
||||
* [Open Multisite in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=18)
|
||||
* [Open Multisite in WordPress Playground][playground-multisite-readme]
|
||||
|
||||
2. Using wp-env (requires Docker):
|
||||
```bash
|
||||
@@ -261,7 +300,10 @@ If you need help with this template, there are several ways to get support:
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
1. Fork the repository on [GitHub](https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/) or [Gitea](https://gitea.wpallstars.com/wpallstars/wp-plugin-starter-template-for-ai-coding/)
|
||||
1. Fork the repository on [GitHub][repo-github] or [Gitea][repo-gitea]
|
||||
|
||||
[repo-github]: https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding/
|
||||
[repo-gitea]: https://gitea.wpallstars.com/wpallstars/wp-plugin-starter-template-for-ai-coding/
|
||||
2. Create your feature branch: `git checkout -b feature/amazing-feature`
|
||||
3. Commit your changes: `git commit -m 'Add some amazing feature'`
|
||||
4. Push to the branch: `git push origin feature/amazing-feature`
|
||||
@@ -271,7 +313,10 @@ For more detailed information, see the [Contributing Guide](.wiki/Contributing.m
|
||||
|
||||
### Code Quality Tools
|
||||
|
||||
This project uses several automated code quality tools to ensure high standards. These tools are free for public repositories and should be integrated into any new repositories based on this template:
|
||||
This project uses several automated code quality tools to ensure high standards.
|
||||
|
||||
These tools are free for public repositories and should be integrated into any new
|
||||
repositories based on this template:
|
||||
|
||||
1. **CodeRabbit**: AI-powered code review tool
|
||||
* [Website](https://www.coderabbit.ai/)
|
||||
@@ -291,7 +336,9 @@ This project uses several automated code quality tools to ensure high standards.
|
||||
3. Go to your project settings > Integrations > Project API
|
||||
4. Generate a project API token
|
||||
5. Add the token as a secret named `CODACY_PROJECT_TOKEN` in your GitHub repository settings
|
||||
6. Note: Codacy tokens are project-specific, so they need to be added at the repository level. However, you can use GitHub Actions to securely pass these tokens between repositories if needed.
|
||||
6. Note: Codacy tokens are project-specific, so they need to be added at the
|
||||
repository level. You can use GitHub Actions to securely pass tokens
|
||||
between repositories if needed.
|
||||
|
||||
4. **SonarCloud**: Code quality and security analysis
|
||||
* [Website](https://sonarcloud.io/)
|
||||
@@ -302,7 +349,8 @@ This project uses several automated code quality tools to ensure high standards.
|
||||
2. Create a new organization or use an existing one
|
||||
3. Add your repository to SonarCloud
|
||||
4. Generate a token in SonarCloud (Account > Security > Tokens)
|
||||
5. Add the token as a secret named `SONAR_TOKEN` in your GitHub repository or organization settings (see "GitHub Secrets Management" section below)
|
||||
5. Add the token as a secret named `SONAR_TOKEN` in your GitHub repository or
|
||||
organization settings (see "GitHub Secrets Management" section below)
|
||||
|
||||
5. **PHP_CodeSniffer (PHPCS)**: PHP code style checker
|
||||
* Enforces WordPress Coding Standards
|
||||
@@ -328,11 +376,12 @@ When you receive feedback from these code quality tools, you can use AI assistan
|
||||
|
||||
1. Copy the output from the code quality tool
|
||||
2. Paste it into your AI assistant chat
|
||||
3. Ask the AI to help you understand and resolve the issues
|
||||
3. Request the AI's assistance to interpret and resolve the reported issues
|
||||
4. Apply the suggested fixes
|
||||
5. Commit the changes and verify that the issues are resolved
|
||||
|
||||
For more information on coding standards and how to pass code quality checks, see the [Coding Standards Guide](.wiki/Coding-Standards.md).
|
||||
For more information on coding standards and how to pass code quality checks,
|
||||
see the [Coding Standards Guide](.wiki/Coding-Standards.md).
|
||||
|
||||
### GitHub Secrets Management
|
||||
|
||||
@@ -350,7 +399,8 @@ GitHub offers three levels of secrets management, each with different scopes and
|
||||
* Available at: Repository > Settings > Secrets and variables > Actions
|
||||
* Scope: Limited to a single repository
|
||||
* Benefits: Repository-specific, higher isolation
|
||||
* Recommended for: `CODACY_PROJECT_TOKEN` and other repository-specific credentials or tokens that shouldn't be shared
|
||||
* Recommended for: `CODACY_PROJECT_TOKEN` and other repository-specific credentials
|
||||
or tokens that shouldn't be shared
|
||||
|
||||
3. **Environment Secrets**:
|
||||
* Available at: Repository > Settings > Environments > (select environment) > Environment secrets
|
||||
@@ -358,7 +408,12 @@ GitHub offers three levels of secrets management, each with different scopes and
|
||||
* Benefits: Environment-specific, can have approval requirements
|
||||
* Recommended for: Deployment credentials that vary between environments
|
||||
|
||||
For code quality tools like SonarCloud, organization secrets are recommended if you have multiple repositories that use these tools. This approach reduces management overhead and ensures consistent configuration across projects. For Codacy, since tokens are project-specific, they should be set at the repository level.
|
||||
For code quality tools like SonarCloud, organization secrets are recommended if you have
|
||||
multiple repositories that use these tools.
|
||||
|
||||
This approach reduces management overhead and ensures consistent configuration across
|
||||
projects. For Codacy, since tokens are project-specific, they should be set at the
|
||||
repository level.
|
||||
|
||||
### Local Environment Setup for Code Quality Tools
|
||||
|
||||
@@ -464,13 +519,16 @@ To run code quality tools locally before committing to GitHub:
|
||||
|
||||
For more detailed instructions, see the [Code Quality Setup Guide](docs/code-quality-setup.md).
|
||||
|
||||
By running these tools locally, you can identify and fix issues before pushing your code to GitHub, ensuring smoother CI/CD workflows.
|
||||
By running these tools locally, you can identify and fix issues before pushing your code
|
||||
to GitHub, ensuring smoother CI/CD workflows.
|
||||
|
||||
## Developers
|
||||
|
||||
### AI-Powered Development
|
||||
|
||||
This repository is configured to work with various AI-powered development tools. You can use any of the following AI IDEs to contribute to this project:
|
||||
This repository is configured to work with various AI-powered development tools.
|
||||
|
||||
You can use any of the following AI IDEs to contribute to this project:
|
||||
|
||||
* [Augment Code](https://www.augmentcode.com/) - AI-powered coding assistant
|
||||
* [Bolt](https://www.bolt.new/) - AI-powered code editor
|
||||
@@ -487,9 +545,11 @@ The repository includes configuration files for all these tools to ensure a cons
|
||||
|
||||
### Git Updater Integration
|
||||
|
||||
This template is designed to work seamlessly with the Git Updater plugin for updates from GitHub and Gitea. To ensure proper integration:
|
||||
This template is designed to work seamlessly with the Git Updater plugin for updates from
|
||||
GitHub and Gitea. To ensure proper integration:
|
||||
|
||||
1. **Required Headers**: The plugin includes specific headers in the main plugin file that Git Updater uses to determine update sources and branches:
|
||||
1. **Required Headers**: The plugin includes specific headers in the main plugin file
|
||||
that Git Updater uses to determine update sources and branches:
|
||||
```php
|
||||
* GitHub Plugin URI: wpallstars/wp-plugin-starter-template-for-ai-coding
|
||||
* GitHub Branch: main
|
||||
@@ -500,13 +560,17 @@ This template is designed to work seamlessly with the Git Updater plugin for upd
|
||||
* Gitea Branch: main
|
||||
```
|
||||
|
||||
2. **Tagging Releases**: When creating a new release, always tag it with the 'v' prefix (e.g., `v0.1.2`) to ensure GitHub Actions can create the proper release assets.
|
||||
2. **Tagging Releases**: When creating a new release, always tag it with the 'v' prefix
|
||||
(e.g., `v0.1.2`) to ensure GitHub Actions can create the proper release assets.
|
||||
|
||||
3. **GitHub Actions**: The repository includes a GitHub Actions workflow that automatically builds the plugin and creates a release with the .zip file when a new tag is pushed.
|
||||
3. **GitHub Actions**: The repository includes a GitHub Actions workflow that automatically
|
||||
builds the plugin and creates a release with the .zip file when a new tag is pushed.
|
||||
|
||||
4. **Update Source Selection**: The template includes a feature that allows users to choose their preferred update source (WordPress.org, GitHub, or Gitea).
|
||||
4. **Update Source Selection**: The template includes a feature that allows users to choose
|
||||
their preferred update source (WordPress.org, GitHub, or Gitea).
|
||||
|
||||
For more information on Git Updater integration, see the [Git Updater Required Headers documentation](https://git-updater.com/knowledge-base/required-headers/).
|
||||
For more information on Git Updater integration, see the
|
||||
[Git Updater Required Headers documentation](https://git-updater.com/knowledge-base/required-headers/).
|
||||
|
||||
## Changelog
|
||||
|
||||
@@ -603,4 +667,7 @@ This project is licensed under the GPL-2.0+ License - see the [LICENSE](LICENSE)
|
||||
|
||||
## Credits
|
||||
|
||||
This template is based on the experience gained from developing the ["Fix 'Plugin file does not exist' Notices"](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices) plugin by WPALLSTARS.
|
||||
This template is based on the experience gained from developing the
|
||||
["Fix 'Plugin file does not exist' Notices"][fix-plugin-notices] plugin by WPALLSTARS.
|
||||
|
||||
[fix-plugin-notices]: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
|
||||
@@ -6,140 +6,140 @@
|
||||
|
||||
/* General Admin Styles */
|
||||
.wpst-admin-page {
|
||||
max-width: 1200px;
|
||||
margin: 20px auto;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 1px 3px rgb(0 0 0 / 10%);
|
||||
max-width: 1200px;
|
||||
margin: 20px auto;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 1px 3px rgb(0 0 0 / 10%);
|
||||
}
|
||||
|
||||
.wpst-admin-header {
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 20px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 20px;
|
||||
padding-bottom: 20px;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
.wpst-admin-header h1 {
|
||||
margin-top: 0;
|
||||
color: #23282d;
|
||||
margin-top: 0;
|
||||
color: #23282d;
|
||||
}
|
||||
|
||||
/* Admin Form Styles */
|
||||
.wpst-form-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
.wpst-form-table th {
|
||||
text-align: left;
|
||||
padding: 15px 10px 15px 0;
|
||||
width: 200px;
|
||||
vertical-align: top;
|
||||
text-align: left;
|
||||
padding: 15px 10px 15px 0;
|
||||
width: 200px;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.wpst-form-table td {
|
||||
padding: 15px 0;
|
||||
vertical-align: middle;
|
||||
padding: 15px 0;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.wpst-form-table input[type="text"],
|
||||
.wpst-form-table input[type="number"],
|
||||
.wpst-form-table select,
|
||||
.wpst-form-table textarea {
|
||||
width: 400px;
|
||||
max-width: 100%;
|
||||
width: 400px;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.wpst-form-table textarea {
|
||||
min-height: 100px;
|
||||
min-height: 100px;
|
||||
}
|
||||
|
||||
.wpst-form-description {
|
||||
color: #666;
|
||||
font-style: italic;
|
||||
margin-top: 5px;
|
||||
color: #666;
|
||||
font-style: italic;
|
||||
margin-top: 5px;
|
||||
}
|
||||
|
||||
/* Admin Notices */
|
||||
.wpst-notice {
|
||||
padding: 10px 15px;
|
||||
margin: 15px 0;
|
||||
border-radius: 3px;
|
||||
border-left: 4px solid #00a0d2;
|
||||
background: #f7fcff;
|
||||
padding: 10px 15px;
|
||||
margin: 15px 0;
|
||||
border-radius: 3px;
|
||||
border-left: 4px solid #00a0d2;
|
||||
background: #f7fcff;
|
||||
}
|
||||
|
||||
.wpst-notice.success {
|
||||
border-left-color: #46b450;
|
||||
background: #ecf7ed;
|
||||
border-left-color: #46b450;
|
||||
background: #ecf7ed;
|
||||
}
|
||||
|
||||
.wpst-notice.error {
|
||||
border-left-color: #dc3232;
|
||||
background: #fbeaea;
|
||||
border-left-color: #dc3232;
|
||||
background: #fbeaea;
|
||||
}
|
||||
|
||||
.wpst-notice.warning {
|
||||
border-left-color: #ffb900;
|
||||
background: #fff8e5;
|
||||
border-left-color: #ffb900;
|
||||
background: #fff8e5;
|
||||
}
|
||||
|
||||
/* Admin Cards */
|
||||
.wpst-card-container {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
margin: 0 -10px;
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
margin: 0 -10px;
|
||||
}
|
||||
|
||||
.wpst-card {
|
||||
flex: 1 0 300px;
|
||||
margin: 10px;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px rgb(0 0 0 / 10%);
|
||||
flex: 1 0 300px;
|
||||
margin: 10px;
|
||||
padding: 20px;
|
||||
background: #fff;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px rgb(0 0 0 / 10%);
|
||||
}
|
||||
|
||||
.wpst-card-header {
|
||||
margin-bottom: 15px;
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 15px;
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
.wpst-card-title {
|
||||
margin: 0;
|
||||
font-size: 16px;
|
||||
font-weight: 600;
|
||||
margin: 0;
|
||||
font-size: 16px;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.wpst-card-content {
|
||||
margin-bottom: 15px;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
.wpst-card-footer {
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* Responsive Styles */
|
||||
@media screen and (width <= 782px) {
|
||||
.wpst-form-table th {
|
||||
width: 100%;
|
||||
display: block;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
@media screen and (max-width: 782px) {
|
||||
.wpst-form-table th {
|
||||
width: 100%;
|
||||
display: block;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
.wpst-form-table td {
|
||||
width: 100%;
|
||||
display: block;
|
||||
}
|
||||
.wpst-form-table td {
|
||||
width: 100%;
|
||||
display: block;
|
||||
}
|
||||
|
||||
.wpst-form-table input[type="text"],
|
||||
.wpst-form-table input[type="number"],
|
||||
.wpst-form-table select,
|
||||
.wpst-form-table textarea {
|
||||
width: 100%;
|
||||
}
|
||||
.wpst-form-table input[type="text"],
|
||||
.wpst-form-table input[type="number"],
|
||||
.wpst-form-table select,
|
||||
.wpst-form-table textarea {
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,138 +6,138 @@
|
||||
|
||||
/* Modal Styles */
|
||||
.wpst-modal {
|
||||
display: none;
|
||||
position: fixed;
|
||||
z-index: 100000;
|
||||
left: 0;
|
||||
top: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
overflow: auto;
|
||||
background-color: rgb(0 0 0 / 40%);
|
||||
display: none;
|
||||
position: fixed;
|
||||
z-index: 100000;
|
||||
left: 0;
|
||||
top: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
overflow: auto;
|
||||
background-color: rgb(0 0 0 / 40%);
|
||||
}
|
||||
|
||||
.wpst-modal-content {
|
||||
position: relative;
|
||||
background-color: #fefefe;
|
||||
margin: 10% auto;
|
||||
padding: 20px;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 4px 8px rgb(0 0 0 / 10%);
|
||||
width: 500px;
|
||||
max-width: 90%;
|
||||
position: relative;
|
||||
background-color: #fefefe;
|
||||
margin: 10% auto;
|
||||
padding: 20px;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 4px 8px rgb(0 0 0 / 10%);
|
||||
width: 500px;
|
||||
max-width: 90%;
|
||||
}
|
||||
|
||||
.wpst-modal-header {
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 15px;
|
||||
padding-bottom: 15px;
|
||||
border-bottom: 1px solid #eee;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
.wpst-modal-title {
|
||||
margin: 0;
|
||||
font-size: 18px;
|
||||
font-weight: 600;
|
||||
margin: 0;
|
||||
font-size: 18px;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.wpst-modal-close {
|
||||
position: absolute;
|
||||
top: 10px;
|
||||
right: 15px;
|
||||
font-size: 20px;
|
||||
font-weight: 700;
|
||||
color: #666;
|
||||
cursor: pointer;
|
||||
position: absolute;
|
||||
top: 10px;
|
||||
right: 15px;
|
||||
font-size: 20px;
|
||||
font-weight: 700;
|
||||
color: #666;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.wpst-modal-close:hover,
|
||||
.wpst-modal-close:focus {
|
||||
color: #000;
|
||||
text-decoration: none;
|
||||
color: #000;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.wpst-modal-body {
|
||||
margin-bottom: 20px;
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.wpst-modal-footer {
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid #eee;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* Source Selection Styles */
|
||||
.wpst-source-options {
|
||||
margin: 15px 0;
|
||||
margin: 15px 0;
|
||||
}
|
||||
|
||||
.wpst-source-option {
|
||||
display: block;
|
||||
margin-bottom: 10px;
|
||||
padding: 10px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
cursor: pointer;
|
||||
display: block;
|
||||
margin-bottom: 10px;
|
||||
padding: 10px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.wpst-source-option:hover {
|
||||
background-color: #f9f9f9;
|
||||
background-color: #f9f9f9;
|
||||
}
|
||||
|
||||
.wpst-source-option.selected {
|
||||
border-color: #0073aa;
|
||||
background-color: #f0f6fc;
|
||||
border-color: #0073aa;
|
||||
background-color: #f0f6fc;
|
||||
}
|
||||
|
||||
.wpst-source-option input[type="radio"] {
|
||||
margin-right: 10px;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
.wpst-source-option-label {
|
||||
font-weight: 600;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.wpst-source-option-description {
|
||||
margin-top: 5px;
|
||||
color: #666;
|
||||
font-size: 13px;
|
||||
margin-top: 5px;
|
||||
color: #666;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
/* Loading Indicator */
|
||||
.wpst-loading {
|
||||
display: inline-block;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border: 2px solid rgb(0 0 0 / 10%);
|
||||
border-radius: 50%;
|
||||
border-top-color: #0073aa;
|
||||
animation: wpst-spin 1s ease-in-out infinite;
|
||||
margin-right: 10px;
|
||||
vertical-align: middle;
|
||||
display: inline-block;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border: 2px solid rgb(0 0 0 / 10%);
|
||||
border-radius: 50%;
|
||||
border-top-color: #0073aa;
|
||||
animation: wpst-spin 1s ease-in-out infinite;
|
||||
margin-right: 10px;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
@keyframes wpst-spin {
|
||||
to {
|
||||
transform: rotate(360deg);
|
||||
}
|
||||
to {
|
||||
transform: rotate(360deg);
|
||||
}
|
||||
}
|
||||
|
||||
/* Message Styles */
|
||||
.wpst-modal-message {
|
||||
padding: 10px;
|
||||
margin: 10px 0;
|
||||
border-radius: 3px;
|
||||
display: none;
|
||||
padding: 10px;
|
||||
margin: 10px 0;
|
||||
border-radius: 3px;
|
||||
display: none;
|
||||
}
|
||||
|
||||
.wpst-modal-message.success {
|
||||
background-color: #ecf7ed;
|
||||
border: 1px solid #46b450;
|
||||
color: #2a6f31;
|
||||
background-color: #ecf7ed;
|
||||
border: 1px solid #46b450;
|
||||
color: #2a6f31;
|
||||
}
|
||||
|
||||
.wpst-modal-message.error {
|
||||
background-color: #fbeaea;
|
||||
border: 1px solid #dc3232;
|
||||
color: #8a1f1f;
|
||||
background-color: #fbeaea;
|
||||
border: 1px solid #dc3232;
|
||||
color: #8a1f1f;
|
||||
}
|
||||
|
||||
@@ -105,10 +105,16 @@
|
||||
* @param {string} message Notice message
|
||||
*/
|
||||
showNotice: function (type, message) {
|
||||
const $notice = $( '<div class="wpst-notice ' + type + '"><p>' + message + '</p></div>' );
|
||||
const allowedTypes = [ 'success', 'error', 'warning' ];
|
||||
const safeType = allowedTypes.includes( type ) ? type : 'error';
|
||||
const $p = $( '<p>' );
|
||||
const $notice = $( '<div>' ).addClass( 'wpst-notice ' + safeType ).append( $p );
|
||||
|
||||
// Set message as plain text to prevent XSS.
|
||||
$p.text( message );
|
||||
|
||||
// Add notice to the page.
|
||||
$( '.wpst-notices' ).html( $notice );
|
||||
$( '.wpst-notices' ).empty().append( $notice );
|
||||
|
||||
// Automatically remove notice after 5 seconds.
|
||||
setTimeout(
|
||||
|
||||
@@ -153,8 +153,8 @@
|
||||
showMessage: function (type, message) {
|
||||
const $message = this.$modal.find( '.wpst-modal-message' );
|
||||
|
||||
// Set message content and type.
|
||||
$message.html( message ).removeClass( 'success error' ).addClass( type ).show();
|
||||
// Set message as plain text to prevent XSS, then apply type class.
|
||||
$message.text( message ).removeClass( 'success error' ).addClass( type ).show();
|
||||
|
||||
// Hide message after a delay for success messages.
|
||||
if (type === 'success') {
|
||||
|
||||
@@ -12,11 +12,22 @@ if ( ! defined( 'ABSPATH' ) ) {
|
||||
?>
|
||||
|
||||
<!-- Update Source Modal -->
|
||||
<div id="wpst-update-source-modal" class="wpst-modal">
|
||||
<div
|
||||
id="wpst-update-source-modal"
|
||||
class="wpst-modal"
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-labelledby="wpst-update-source-modal-title"
|
||||
tabindex="-1"
|
||||
>
|
||||
<div class="wpst-modal-content">
|
||||
<div class="wpst-modal-header">
|
||||
<h2 class="wpst-modal-title"><?php esc_html_e( 'Select Update Source', 'wp-plugin-starter-template' ); ?></h2>
|
||||
<span class="wpst-modal-close">×</span>
|
||||
<h2 id="wpst-update-source-modal-title" class="wpst-modal-title"><?php esc_html_e( 'Select Update Source', 'wp-plugin-starter-template' ); ?></h2>
|
||||
<button
|
||||
type="button"
|
||||
class="wpst-modal-close"
|
||||
aria-label="<?php esc_attr_e( 'Close dialog', 'wp-plugin-starter-template' ); ?>"
|
||||
>×</button>
|
||||
</div>
|
||||
|
||||
<div class="wpst-modal-body">
|
||||
|
||||
@@ -17,15 +17,19 @@ WP_TESTS_DIR=${WP_TESTS_DIR-/tmp/wordpress-tests-lib}
|
||||
WP_CORE_DIR=${WP_CORE_DIR-/tmp/wordpress/}
|
||||
|
||||
download() {
|
||||
if command -v curl > /dev/null; then
|
||||
curl -s "$1" > "$2";
|
||||
elif command -v wget > /dev/null; then
|
||||
wget -nv -O "$2" "$1"
|
||||
fi
|
||||
if command -v curl >/dev/null 2>&1; then
|
||||
curl -fsSL "$1" -o "$2"
|
||||
elif command -v wget >/dev/null 2>&1; then
|
||||
wget -qO "$2" "$1"
|
||||
else
|
||||
echo "Error: Neither curl nor wget is installed" >&2
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+\-(beta|RC)[0-9]+$ ]]; then
|
||||
WP_BRANCH=${WP_VERSION%\-*}
|
||||
WP_TESTS_TAG="branches/$WP_BRANCH"
|
||||
elif [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then
|
||||
WP_TESTS_TAG="branches/$WP_VERSION"
|
||||
elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then
|
||||
@@ -40,27 +44,38 @@ elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
|
||||
else
|
||||
# http serves a single offer, whereas https serves multiple. we only want one
|
||||
download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
|
||||
grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json
|
||||
LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//')
|
||||
LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//' | head -1)
|
||||
if [[ -z "$LATEST_VERSION" ]]; then
|
||||
echo "Latest WordPress version could not be found"
|
||||
exit 1
|
||||
fi
|
||||
WP_TESTS_TAG="tags/$LATEST_VERSION"
|
||||
fi
|
||||
|
||||
# Derive a git ref from WP_TESTS_TAG by stripping the SVN-style prefix.
|
||||
# WP_TESTS_TAG uses "tags/X.Y.Z", "branches/X.Y", or "trunk".
|
||||
# git clone --branch requires the bare ref name ("X.Y.Z", "X.Y", or "trunk").
|
||||
if [[ "$WP_TESTS_TAG" == tags/* ]]; then
|
||||
GIT_REF="${WP_TESTS_TAG#tags/}"
|
||||
elif [[ "$WP_TESTS_TAG" == branches/* ]]; then
|
||||
GIT_REF="${WP_TESTS_TAG#branches/}"
|
||||
else
|
||||
GIT_REF="$WP_TESTS_TAG"
|
||||
fi
|
||||
|
||||
set -ex
|
||||
|
||||
install_wp() {
|
||||
|
||||
if [ -d "$WP_CORE_DIR" ]; then
|
||||
return;
|
||||
return
|
||||
fi
|
||||
|
||||
mkdir -p "$WP_CORE_DIR"
|
||||
|
||||
if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then
|
||||
mkdir -p "$WP_CORE_DIR"
|
||||
download https://wordpress.org/nightly-builds/wordpress-latest.zip "$WP_CORE_DIR/wordpress-nightly.zip"
|
||||
download https://wordpress.org/nightly-builds/wordpress-latest.zip "$WP_CORE_DIR/wordpress-nightly.zip"
|
||||
unzip -q "$WP_CORE_DIR/wordpress-nightly.zip" -d "$WP_CORE_DIR"
|
||||
rm "$WP_CORE_DIR/wordpress-nightly.zip"
|
||||
else
|
||||
@@ -71,6 +86,7 @@ install_wp() {
|
||||
if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then
|
||||
LATEST_VERSION=${WP_VERSION%??}
|
||||
else
|
||||
# shellcheck disable=SC2001
|
||||
VERSION_ESCAPED=$(echo "$WP_VERSION" | sed 's/\./\\\\./g')
|
||||
LATEST_VERSION=$(grep -o '"version":"'"$VERSION_ESCAPED"'[^"]*' "$WP_CORE_DIR/wp-latest.json" | sed 's/"version":"//' | head -1)
|
||||
fi
|
||||
@@ -82,7 +98,7 @@ install_wp() {
|
||||
else
|
||||
local ARCHIVE_NAME="wordpress-$WP_VERSION"
|
||||
fi
|
||||
download https://wordpress.org/"${ARCHIVE_NAME}".tar.gz "$WP_CORE_DIR/wordpress.tar.gz"
|
||||
download https://wordpress.org/"${ARCHIVE_NAME}".tar.gz "$WP_CORE_DIR/wordpress.tar.gz"
|
||||
tar --strip-components=1 -zxmf "$WP_CORE_DIR/wordpress.tar.gz" -C "$WP_CORE_DIR"
|
||||
rm "$WP_CORE_DIR/wordpress.tar.gz"
|
||||
fi
|
||||
@@ -101,12 +117,21 @@ install_test_suite() {
|
||||
# set up testing suite if it doesn't yet exist
|
||||
if [ ! -d "$WP_TESTS_DIR" ]; then
|
||||
mkdir -p "$WP_TESTS_DIR"
|
||||
git clone --quiet --depth=1 https://github.com/WordPress/wordpress-develop.git /tmp/wordpress-develop
|
||||
if ! git clone --quiet --depth=1 --branch "$GIT_REF" https://github.com/WordPress/wordpress-develop.git /tmp/wordpress-develop; then
|
||||
echo "Error: Failed to clone wordpress-develop at branch/tag $GIT_REF" >&2
|
||||
exit 1
|
||||
fi
|
||||
if [ -d /tmp/wordpress-develop/tests/phpunit/includes ]; then
|
||||
cp -r /tmp/wordpress-develop/tests/phpunit/includes "$WP_TESTS_DIR/"
|
||||
if ! cp -r /tmp/wordpress-develop/tests/phpunit/includes "$WP_TESTS_DIR/"; then
|
||||
echo "Error: Failed to copy phpunit includes to $WP_TESTS_DIR" >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
if [ -d /tmp/wordpress-develop/tests/phpunit/data ]; then
|
||||
cp -r /tmp/wordpress-develop/tests/phpunit/data "$WP_TESTS_DIR/"
|
||||
if ! cp -r /tmp/wordpress-develop/tests/phpunit/data "$WP_TESTS_DIR/"; then
|
||||
echo "Error: Failed to copy phpunit data to $WP_TESTS_DIR" >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
@@ -116,15 +141,15 @@ install_test_suite() {
|
||||
else
|
||||
download https://raw.githubusercontent.com/WordPress/wordpress-develop/master/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
fi
|
||||
WP_CORE_DIR=$(echo "$WP_CORE_DIR" | sed "s:/\+$::")
|
||||
sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
WP_CORE_DIR="${WP_CORE_DIR%/}"
|
||||
sed "$ioption" "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed "$ioption" "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed "$ioption" "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed "$ioption" "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed "$ioption" "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
|
||||
if [ "$MULTISITE" = "true" ]; then
|
||||
sed $ioption "s:// define( 'WP_TESTS_MULTISITE', true );:define( 'WP_TESTS_MULTISITE', true );:" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
sed "$ioption" "s:// define( 'WP_TESTS_MULTISITE', true );:define( 'WP_TESTS_MULTISITE', true );:" "$WP_TESTS_DIR"/wp-tests-config.php
|
||||
fi
|
||||
fi
|
||||
|
||||
@@ -132,27 +157,27 @@ install_test_suite() {
|
||||
|
||||
install_db() {
|
||||
|
||||
if [ ${SKIP_DB_CREATE} = "true" ]; then
|
||||
if [ "${SKIP_DB_CREATE}" = "true" ]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
local PARTS
|
||||
IFS=':' read -ra PARTS <<< "$DB_HOST"
|
||||
local DB_HOSTNAME=${PARTS[0]};
|
||||
local DB_SOCK_OR_PORT=${PARTS[1]};
|
||||
IFS=':' read -ra PARTS <<<"$DB_HOST"
|
||||
local DB_HOSTNAME=${PARTS[0]}
|
||||
local DB_SOCK_OR_PORT=${PARTS[1]}
|
||||
local EXTRA=""
|
||||
|
||||
if [ -n "$DB_HOSTNAME" ] ; then
|
||||
if [ -n "$DB_HOSTNAME" ]; then
|
||||
if [[ $DB_SOCK_OR_PORT =~ ^[0-9]+$ ]]; then
|
||||
EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp"
|
||||
elif [ -n "$DB_SOCK_OR_PORT" ] ; then
|
||||
elif [ -n "$DB_SOCK_OR_PORT" ]; then
|
||||
EXTRA=" --socket=$DB_SOCK_OR_PORT"
|
||||
elif [ -n "$DB_HOSTNAME" ] ; then
|
||||
elif [ -n "$DB_HOSTNAME" ]; then
|
||||
EXTRA=" --host=$DB_HOSTNAME --protocol=tcp"
|
||||
fi
|
||||
fi
|
||||
|
||||
mysqladmin create "$DB_NAME" --user="$DB_USER" --password="$DB_PASS"$EXTRA || true
|
||||
mysqladmin create "$DB_NAME" --user="$DB_USER" --password="$DB_PASS""$EXTRA" || true
|
||||
}
|
||||
|
||||
install_wp
|
||||
|
||||
@@ -5,122 +5,138 @@ chmod +x "$0"
|
||||
|
||||
# Check if environment type is provided
|
||||
if [ -z "$1" ]; then
|
||||
echo "Usage: $0 [single|multisite|playground-single|playground-multisite]"
|
||||
exit 1
|
||||
echo "Usage: $0 [single|multisite|playground-single|playground-multisite]"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
ENV_TYPE=$1
|
||||
|
||||
# Function to check if a command exists
|
||||
command_exists() {
|
||||
command -v "$1" &> /dev/null
|
||||
command -v "$1" &>/dev/null
|
||||
return $?
|
||||
}
|
||||
|
||||
# PID of the background Python HTTP server (set when started).
|
||||
PYTHON_PID=""
|
||||
|
||||
# Function to clean up resources on exit.
|
||||
cleanup() {
|
||||
if [ -n "$PYTHON_PID" ]; then
|
||||
echo "Stopping Python HTTP server (PID: $PYTHON_PID)..."
|
||||
kill "$PYTHON_PID" 2>/dev/null || true
|
||||
fi
|
||||
return 0
|
||||
}
|
||||
|
||||
# Trap EXIT, INT, and TERM so the server is always stopped on script exit.
|
||||
trap cleanup EXIT INT TERM
|
||||
|
||||
# Function to install wp-env if needed
|
||||
install_wp_env() {
|
||||
if ! command_exists wp-env; then
|
||||
echo "wp-env is not installed. Installing..."
|
||||
npm install -g @wordpress/env
|
||||
fi
|
||||
if ! command_exists wp-env; then
|
||||
echo "wp-env is not installed. Installing..."
|
||||
npm install -g @wordpress/env
|
||||
fi
|
||||
}
|
||||
|
||||
# Function to install wp-playground if needed
|
||||
install_wp_playground() {
|
||||
# Check if we have a local installation
|
||||
if [ ! -d "node_modules/@wp-playground" ]; then
|
||||
echo "WordPress Playground is not installed locally. Installing..."
|
||||
npm install --save-dev @wp-playground/client @wp-playground/blueprints
|
||||
fi
|
||||
# Check if we have a local installation
|
||||
if [ ! -d "node_modules/@wp-playground" ]; then
|
||||
echo "WordPress Playground is not installed locally. Installing..."
|
||||
npm install --save-dev @wp-playground/client @wp-playground/blueprints
|
||||
fi
|
||||
}
|
||||
|
||||
if [ "$ENV_TYPE" == "single" ]; then
|
||||
echo "Setting up single site environment..."
|
||||
echo "Setting up single site environment..."
|
||||
|
||||
# Install wp-env if needed
|
||||
install_wp_env
|
||||
# Install wp-env if needed
|
||||
install_wp_env
|
||||
|
||||
# Start the environment
|
||||
wp-env start
|
||||
# Start the environment
|
||||
wp-env start
|
||||
|
||||
# Wait for WordPress to be ready with a timeout
|
||||
MAX_ATTEMPTS=30
|
||||
ATTEMPT=0
|
||||
echo "Waiting for WordPress to be ready..."
|
||||
until wp-env run cli wp core is-installed || [ $ATTEMPT -ge $MAX_ATTEMPTS ]; do
|
||||
ATTEMPT=$((ATTEMPT+1))
|
||||
echo "Attempt $ATTEMPT/$MAX_ATTEMPTS..."
|
||||
sleep 2
|
||||
done
|
||||
# Wait for WordPress to be ready with a timeout
|
||||
MAX_ATTEMPTS=30
|
||||
ATTEMPT=0
|
||||
echo "Waiting for WordPress to be ready..."
|
||||
until wp-env run cli wp core is-installed || [ $ATTEMPT -ge $MAX_ATTEMPTS ]; do
|
||||
ATTEMPT=$((ATTEMPT + 1))
|
||||
echo "Attempt $ATTEMPT/$MAX_ATTEMPTS..."
|
||||
sleep 2
|
||||
done
|
||||
|
||||
if [ $ATTEMPT -ge $MAX_ATTEMPTS ]; then
|
||||
echo "Timed out waiting for WordPress to be ready."
|
||||
exit 1
|
||||
fi
|
||||
if [ $ATTEMPT -ge $MAX_ATTEMPTS ]; then
|
||||
echo "Timed out waiting for WordPress to be ready."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Activate our plugin
|
||||
if ! wp-env run cli wp plugin activate wp-plugin-starter-template-for-ai-coding; then
|
||||
echo "Failed to activate plugin. Exiting."
|
||||
exit 1
|
||||
fi
|
||||
# Activate our plugin
|
||||
if ! wp-env run cli wp plugin activate wp-plugin-starter-template-for-ai-coding; then
|
||||
echo "Failed to activate plugin. Exiting."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "WordPress Single Site environment is ready!"
|
||||
echo "Site: http://localhost:8888"
|
||||
echo "Admin login: admin / password"
|
||||
echo "WordPress Single Site environment is ready!"
|
||||
echo "Site: http://localhost:8888"
|
||||
echo "Admin login: admin / password"
|
||||
|
||||
elif [ "$ENV_TYPE" == "multisite" ]; then
|
||||
echo "Setting up multisite environment..."
|
||||
echo "Setting up multisite environment..."
|
||||
|
||||
# Install wp-env if needed
|
||||
install_wp_env
|
||||
# Install wp-env if needed
|
||||
install_wp_env
|
||||
|
||||
# Start the environment with multisite configuration
|
||||
wp-env start --config=.wp-env.multisite.json
|
||||
# Start the environment with multisite configuration
|
||||
wp-env start --config=.wp-env.multisite.json
|
||||
|
||||
# Wait for WordPress to be ready with a timeout
|
||||
MAX_ATTEMPTS=30
|
||||
ATTEMPT=0
|
||||
echo "Waiting for WordPress to be ready..."
|
||||
until wp-env run cli wp core is-installed || [ $ATTEMPT -ge $MAX_ATTEMPTS ]; do
|
||||
ATTEMPT=$((ATTEMPT+1))
|
||||
echo "Attempt $ATTEMPT/$MAX_ATTEMPTS..."
|
||||
sleep 2
|
||||
done
|
||||
# Wait for WordPress to be ready with a timeout
|
||||
MAX_ATTEMPTS=30
|
||||
ATTEMPT=0
|
||||
echo "Waiting for WordPress to be ready..."
|
||||
until wp-env run cli wp core is-installed || [ $ATTEMPT -ge $MAX_ATTEMPTS ]; do
|
||||
ATTEMPT=$((ATTEMPT + 1))
|
||||
echo "Attempt $ATTEMPT/$MAX_ATTEMPTS..."
|
||||
sleep 2
|
||||
done
|
||||
|
||||
if [ $ATTEMPT -ge $MAX_ATTEMPTS ]; then
|
||||
echo "Timed out waiting for WordPress to be ready."
|
||||
exit 1
|
||||
fi
|
||||
if [ $ATTEMPT -ge $MAX_ATTEMPTS ]; then
|
||||
echo "Timed out waiting for WordPress to be ready."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Create a test site
|
||||
if ! wp-env run cli wp site create --slug=testsite --title="Test Site" --email=admin@example.com; then
|
||||
echo "Failed to create test site. Exiting."
|
||||
exit 1
|
||||
fi
|
||||
# Create a test site
|
||||
if ! wp-env run cli wp site create --slug=testsite --title="Test Site" --email=admin@example.com; then
|
||||
echo "Failed to create test site. Exiting."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Network activate our plugin
|
||||
if ! wp-env run cli wp plugin activate wp-plugin-starter-template-for-ai-coding --network; then
|
||||
echo "Failed to activate plugin. Exiting."
|
||||
exit 1
|
||||
fi
|
||||
# Network activate our plugin
|
||||
if ! wp-env run cli wp plugin activate wp-plugin-starter-template-for-ai-coding --network; then
|
||||
echo "Failed to activate plugin. Exiting."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "WordPress Multisite environment is ready!"
|
||||
echo "Main site: http://localhost:8888"
|
||||
echo "Test site: http://localhost:8888/testsite"
|
||||
echo "Admin login: admin / password"
|
||||
echo "WordPress Multisite environment is ready!"
|
||||
echo "Main site: http://localhost:8888"
|
||||
echo "Test site: http://localhost:8888/testsite"
|
||||
echo "Admin login: admin / password"
|
||||
|
||||
elif [ "$ENV_TYPE" == "playground-single" ]; then
|
||||
echo "Setting up WordPress Playground single site environment..."
|
||||
echo "Setting up WordPress Playground single site environment..."
|
||||
|
||||
# Install wp-playground if needed
|
||||
install_wp_playground
|
||||
# Install wp-playground if needed
|
||||
install_wp_playground
|
||||
|
||||
# Create plugin zip
|
||||
echo "Creating plugin zip..."
|
||||
mkdir -p dist
|
||||
zip -r dist/plugin.zip . -x "node_modules/*" "dist/*" ".git/*"
|
||||
# Create plugin zip
|
||||
echo "Creating plugin zip..."
|
||||
mkdir -p dist
|
||||
zip -r dist/plugin.zip . -x "node_modules/*" "dist/*" ".git/*"
|
||||
|
||||
# Update blueprint to use local plugin
|
||||
cat > playground/blueprint.json << EOF
|
||||
# Update blueprint to use local plugin
|
||||
cat >playground/blueprint.json <<EOF
|
||||
{
|
||||
"landingPage": "/wp-admin/",
|
||||
"preferredVersions": {
|
||||
@@ -148,46 +164,48 @@ elif [ "$ENV_TYPE" == "playground-single" ]; then
|
||||
}
|
||||
EOF
|
||||
|
||||
# Start WordPress Playground
|
||||
echo "Starting WordPress Playground..."
|
||||
if command_exists python3; then
|
||||
python3 -m http.server 8888 --directory playground &
|
||||
echo "Opening WordPress Playground in your browser..."
|
||||
if command_exists open; then
|
||||
open http://localhost:8888/index.html
|
||||
elif command_exists xdg-open; then
|
||||
xdg-open http://localhost:8888/index.html
|
||||
elif command_exists start; then
|
||||
start http://localhost:8888/index.html
|
||||
else
|
||||
echo "Please open http://localhost:8888/index.html in your browser"
|
||||
fi
|
||||
else
|
||||
echo "Python3 is not installed. Please open playground/index.html in your browser."
|
||||
fi
|
||||
# Start WordPress Playground
|
||||
echo "Starting WordPress Playground..."
|
||||
if command_exists python3; then
|
||||
python3 -m http.server 8888 --directory playground &
|
||||
PYTHON_PID=$!
|
||||
echo "Started Python HTTP server with PID: $PYTHON_PID"
|
||||
echo "Opening WordPress Playground in your browser..."
|
||||
if command_exists open; then
|
||||
open http://localhost:8888/index.html
|
||||
elif command_exists xdg-open; then
|
||||
xdg-open http://localhost:8888/index.html
|
||||
elif command_exists start; then
|
||||
start http://localhost:8888/index.html
|
||||
else
|
||||
echo "Please open http://localhost:8888/index.html in your browser"
|
||||
fi
|
||||
else
|
||||
echo "Python3 is not installed. Please open playground/index.html in your browser."
|
||||
fi
|
||||
|
||||
# Wait for WordPress Playground to be ready
|
||||
echo "Waiting for WordPress Playground to be ready..."
|
||||
sleep 5
|
||||
# Wait for WordPress Playground to be ready
|
||||
echo "Waiting for WordPress Playground to be ready..."
|
||||
sleep 5
|
||||
|
||||
echo "WordPress Playground Single Site environment is ready!"
|
||||
echo "Site: http://localhost:8888"
|
||||
echo "Admin login: admin / password"
|
||||
echo "Press Ctrl+C to stop the server when done."
|
||||
echo "WordPress Playground Single Site environment is ready!"
|
||||
echo "Site: http://localhost:8888"
|
||||
echo "Admin login: admin / password"
|
||||
echo "Press Ctrl+C to stop the server when done."
|
||||
|
||||
elif [ "$ENV_TYPE" == "playground-multisite" ]; then
|
||||
echo "Setting up WordPress Playground multisite environment..."
|
||||
echo "Setting up WordPress Playground multisite environment..."
|
||||
|
||||
# Install wp-playground if needed
|
||||
install_wp_playground
|
||||
# Install wp-playground if needed
|
||||
install_wp_playground
|
||||
|
||||
# Create plugin zip
|
||||
echo "Creating plugin zip..."
|
||||
mkdir -p dist
|
||||
zip -r dist/plugin.zip . -x "node_modules/*" "dist/*" ".git/*"
|
||||
# Create plugin zip
|
||||
echo "Creating plugin zip..."
|
||||
mkdir -p dist
|
||||
zip -r dist/plugin.zip . -x "node_modules/*" "dist/*" ".git/*"
|
||||
|
||||
# Update blueprint to use local plugin
|
||||
cat > playground/multisite-blueprint.json << EOF
|
||||
# Update blueprint to use local plugin
|
||||
cat >playground/multisite-blueprint.json <<EOF
|
||||
{
|
||||
"landingPage": "/wp-admin/network/",
|
||||
"preferredVersions": {
|
||||
@@ -255,35 +273,37 @@ elif [ "$ENV_TYPE" == "playground-multisite" ]; then
|
||||
}
|
||||
EOF
|
||||
|
||||
# Start WordPress Playground
|
||||
echo "Starting WordPress Playground..."
|
||||
if command_exists python3; then
|
||||
python3 -m http.server 8888 --directory playground &
|
||||
echo "Opening WordPress Playground in your browser..."
|
||||
if command_exists open; then
|
||||
open http://localhost:8888/multisite.html
|
||||
elif command_exists xdg-open; then
|
||||
xdg-open http://localhost:8888/multisite.html
|
||||
elif command_exists start; then
|
||||
start http://localhost:8888/multisite.html
|
||||
else
|
||||
echo "Please open http://localhost:8888/multisite.html in your browser"
|
||||
fi
|
||||
else
|
||||
echo "Python3 is not installed. Please open playground/multisite.html in your browser."
|
||||
fi
|
||||
# Start WordPress Playground
|
||||
echo "Starting WordPress Playground..."
|
||||
if command_exists python3; then
|
||||
python3 -m http.server 8888 --directory playground &
|
||||
PYTHON_PID=$!
|
||||
echo "Started Python HTTP server with PID: $PYTHON_PID"
|
||||
echo "Opening WordPress Playground in your browser..."
|
||||
if command_exists open; then
|
||||
open http://localhost:8888/multisite.html
|
||||
elif command_exists xdg-open; then
|
||||
xdg-open http://localhost:8888/multisite.html
|
||||
elif command_exists start; then
|
||||
start http://localhost:8888/multisite.html
|
||||
else
|
||||
echo "Please open http://localhost:8888/multisite.html in your browser"
|
||||
fi
|
||||
else
|
||||
echo "Python3 is not installed. Please open playground/multisite.html in your browser."
|
||||
fi
|
||||
|
||||
# Wait for WordPress Playground to be ready
|
||||
echo "Waiting for WordPress Playground to be ready..."
|
||||
sleep 5
|
||||
# Wait for WordPress Playground to be ready
|
||||
echo "Waiting for WordPress Playground to be ready..."
|
||||
sleep 5
|
||||
|
||||
echo "WordPress Playground Multisite environment is ready!"
|
||||
echo "Main site: http://localhost:8888"
|
||||
echo "Test site: http://localhost:8888/testsite"
|
||||
echo "Admin login: admin / password"
|
||||
echo "Press Ctrl+C to stop the server when done."
|
||||
echo "WordPress Playground Multisite environment is ready!"
|
||||
echo "Main site: http://localhost:8888"
|
||||
echo "Test site: http://localhost:8888/testsite"
|
||||
echo "Admin login: admin / password"
|
||||
echo "Press Ctrl+C to stop the server when done."
|
||||
|
||||
else
|
||||
echo "Invalid environment type. Use 'single', 'multisite', 'playground-single', or 'playground-multisite'."
|
||||
exit 1
|
||||
echo "Invalid environment type. Use 'single', 'multisite', 'playground-single', or 'playground-multisite'."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
81
build.sh
81
build.sh
@@ -1,13 +1,14 @@
|
||||
#!/bin/bash
|
||||
set -euo pipefail
|
||||
|
||||
# WordPress Plugin Build Script
|
||||
# This script creates a clean build of the plugin for distribution
|
||||
|
||||
# Check if version is provided
|
||||
if [ -z "$1" ]; then
|
||||
echo "❌ Error: Version number is required"
|
||||
echo "Usage: ./build.sh <version>"
|
||||
exit 1
|
||||
echo "❌ Error: Version number is required"
|
||||
echo "Usage: ./build.sh <version>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
VERSION=$1
|
||||
@@ -22,15 +23,15 @@ mkdir -p "$BUILD_DIR"
|
||||
|
||||
# Run code quality checks
|
||||
echo "Running code quality checks..."
|
||||
if command -v composer &> /dev/null; then
|
||||
echo "Running PHPCS..."
|
||||
composer run phpcs || { echo "⚠️ PHPCS found issues. Consider running 'composer run phpcbf' to fix them."; }
|
||||
if command -v composer &>/dev/null; then
|
||||
echo "Running PHPCS..."
|
||||
composer run phpcs || { echo "⚠️ PHPCS found issues. Consider running 'composer run phpcbf' to fix them."; }
|
||||
|
||||
# Uncomment the following line to automatically fix coding standards issues
|
||||
# echo "Running PHPCBF..."
|
||||
# composer run phpcbf
|
||||
# Uncomment the following line to automatically fix coding standards issues
|
||||
# echo "Running PHPCBF..."
|
||||
# composer run phpcbf
|
||||
else
|
||||
echo "⚠️ Composer not found, skipping code quality checks"
|
||||
echo "⚠️ Composer not found, skipping code quality checks"
|
||||
fi
|
||||
|
||||
# Install composer dependencies
|
||||
@@ -39,7 +40,7 @@ composer install --no-dev --optimize-autoloader
|
||||
|
||||
# Copy plugin files to build directory
|
||||
echo "Copying plugin files..."
|
||||
cp -R *.php "$BUILD_DIR/"
|
||||
cp -R ./*.php "$BUILD_DIR/"
|
||||
cp -R README.md LICENSE CHANGELOG.md readme.txt composer.json "$BUILD_DIR/"
|
||||
|
||||
# Copy directories
|
||||
@@ -54,57 +55,57 @@ mkdir -p "$BUILD_DIR/assets/banner" "$BUILD_DIR/assets/icon" "$BUILD_DIR/assets/
|
||||
|
||||
# Copy assets if they exist
|
||||
if [ -d "assets/banner" ]; then
|
||||
cp -R assets/banner/* "$BUILD_DIR/assets/banner/"
|
||||
cp -R assets/banner/* "$BUILD_DIR/assets/banner/"
|
||||
fi
|
||||
|
||||
if [ -d "assets/icon" ]; then
|
||||
cp -R assets/icon/* "$BUILD_DIR/assets/icon/"
|
||||
cp -R assets/icon/* "$BUILD_DIR/assets/icon/"
|
||||
fi
|
||||
|
||||
if [ -d "assets/screenshots" ]; then
|
||||
cp -R assets/screenshots/* "$BUILD_DIR/assets/screenshots/"
|
||||
cp -R assets/screenshots/* "$BUILD_DIR/assets/screenshots/"
|
||||
fi
|
||||
|
||||
# Copy vendor directory if it exists
|
||||
if [ -d "vendor" ]; then
|
||||
cp -R vendor "$BUILD_DIR/"
|
||||
cp -R vendor "$BUILD_DIR/"
|
||||
fi
|
||||
|
||||
# Create ZIP file
|
||||
# Create ZIP file.
|
||||
echo "Creating ZIP file..."
|
||||
cd build
|
||||
cd build || exit 1
|
||||
zip -r "../$ZIP_FILE" "$PLUGIN_SLUG" -x "*.DS_Store" -x "*.git*" -x "*.github*"
|
||||
cd ..
|
||||
|
||||
# Check if ZIP file was created successfully
|
||||
if [ -f "$ZIP_FILE" ]; then
|
||||
echo "✅ Build successful: $ZIP_FILE created"
|
||||
echo "File path: $(pwd)/$ZIP_FILE"
|
||||
echo "✅ Build successful: $ZIP_FILE created"
|
||||
echo "File path: $(pwd)/$ZIP_FILE"
|
||||
|
||||
# Deploy to local WordPress installation if environment variable is set
|
||||
if [ -n "$WP_LOCAL_PLUGIN_DIR" ]; then
|
||||
echo "\nDeploying to local WordPress installation..."
|
||||
echo "Deploying to local WordPress installation..."
|
||||
# Deploy to local WordPress installation if environment variable is set
|
||||
if [ -n "$WP_LOCAL_PLUGIN_DIR" ]; then
|
||||
printf '\nDeploying to local WordPress installation...\n'
|
||||
echo "Deploying to local WordPress installation..."
|
||||
|
||||
# Remove existing plugin directory
|
||||
rm -rf "$WP_LOCAL_PLUGIN_DIR/$PLUGIN_SLUG"
|
||||
# Remove existing plugin directory.
|
||||
rm -rf "${WP_LOCAL_PLUGIN_DIR:?}/$PLUGIN_SLUG"
|
||||
|
||||
# Copy files to local WordPress installation
|
||||
rsync -av --exclude=".git" --exclude=".github" --exclude=".DS_Store" \
|
||||
"$BUILD_DIR/" "$WP_LOCAL_PLUGIN_DIR/$PLUGIN_SLUG"
|
||||
# Copy files to local WordPress installation
|
||||
rsync -av --exclude=".git" --exclude=".github" --exclude=".DS_Store" \
|
||||
"$BUILD_DIR/" "$WP_LOCAL_PLUGIN_DIR/$PLUGIN_SLUG"
|
||||
|
||||
# Clear WordPress transients if WP-CLI is available
|
||||
if command -v wp &> /dev/null; then
|
||||
echo "Clearing WordPress transients..."
|
||||
wp transient delete --all --path="$WP_LOCAL_PLUGIN_DIR/../.."
|
||||
else
|
||||
echo "⚠️ WP-CLI not found, skipping transient clearing"
|
||||
fi
|
||||
# Clear WordPress transients if WP-CLI is available
|
||||
if command -v wp &>/dev/null; then
|
||||
echo "Clearing WordPress transients..."
|
||||
wp transient delete --all --path="$WP_LOCAL_PLUGIN_DIR/../.."
|
||||
else
|
||||
echo "⚠️ WP-CLI not found, skipping transient clearing"
|
||||
fi
|
||||
|
||||
echo "✅ Local deployment successful!"
|
||||
echo "Plugin deployed to: $WP_LOCAL_PLUGIN_DIR/$PLUGIN_SLUG"
|
||||
fi
|
||||
echo "✅ Local deployment successful!"
|
||||
echo "Plugin deployed to: $WP_LOCAL_PLUGIN_DIR/$PLUGIN_SLUG"
|
||||
fi
|
||||
else
|
||||
echo "❌ Build failed: ZIP file was not created"
|
||||
exit 1
|
||||
echo "❌ Build failed: ZIP file was not created"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
@@ -18,6 +18,14 @@ describe('WordPress Playground Single Site Tests', () => {
|
||||
cy.visit('/wp-admin/plugins.php', { timeout: 30000 });
|
||||
|
||||
cy.get('body', { timeout: 15000 }).then(($body) => {
|
||||
// Verify the starter template plugin exists and is activated.
|
||||
if ($body.find('tr[data-slug="wp-plugin-starter-template-for-ai-coding"]').length) {
|
||||
cy.get('tr[data-slug="wp-plugin-starter-template-for-ai-coding"]').should('exist');
|
||||
cy.get('tr[data-slug="wp-plugin-starter-template-for-ai-coding"] .deactivate a').should('exist');
|
||||
} else {
|
||||
cy.log('Starter template plugin not found by slug, skipping check');
|
||||
}
|
||||
|
||||
if ($body.text().includes('Plugin Toggle')) {
|
||||
cy.contains('tr', 'Plugin Toggle').should('exist');
|
||||
cy.contains('tr', 'Plugin Toggle').find('.deactivate').should('exist');
|
||||
|
||||
@@ -1,30 +1,75 @@
|
||||
describe('WordPress Single Site Tests', () => {
|
||||
it('Can access the site', () => {
|
||||
cy.visit('/');
|
||||
cy.get('body').should('exist');
|
||||
});
|
||||
/* eslint-env mocha, jquery, cypress */
|
||||
describe( 'WordPress Single Site Tests', () => {
|
||||
it( 'Can access the site', () => {
|
||||
cy.visit( '/' );
|
||||
cy.get( 'body' ).should( 'exist' );
|
||||
} );
|
||||
|
||||
it('Can login to the admin area', () => {
|
||||
cy.loginAsAdmin();
|
||||
cy.get('#wpadminbar').should('exist');
|
||||
cy.get('#dashboard-widgets').should('exist');
|
||||
});
|
||||
it( 'Can login to the admin area', () => {
|
||||
cy.loginAsAdmin();
|
||||
cy.get( '#wpadminbar' ).should( 'exist' );
|
||||
cy.get( '#dashboard-widgets' ).should( 'exist' );
|
||||
} );
|
||||
|
||||
it('Plugin is activated', () => {
|
||||
// Use our custom command to check and activate the plugin if needed
|
||||
cy.activatePlugin('wp-plugin-starter-template-for-ai-coding');
|
||||
it( 'Plugin is activated', () => {
|
||||
// Use our custom command to check and activate the plugin if needed.
|
||||
cy.activatePlugin( 'wp-plugin-starter-template-for-ai-coding' );
|
||||
|
||||
// Verify it's active
|
||||
cy.get('tr[data-slug="wp-plugin-starter-template-for-ai-coding"] .deactivate').should('exist');
|
||||
});
|
||||
// Verify it's active.
|
||||
cy.get( 'tr[data-slug="wp-plugin-starter-template-for-ai-coding"] .deactivate' ).should( 'exist' );
|
||||
} );
|
||||
|
||||
it('Plugin settings page loads correctly', () => {
|
||||
cy.loginAsAdmin();
|
||||
it( 'Plugin row is visible on the plugins page', () => {
|
||||
cy.loginAsAdmin();
|
||||
cy.visit( '/wp-admin/plugins.php' );
|
||||
|
||||
// Navigate to the plugin settings page (if it exists)
|
||||
cy.visit('/wp-admin/options-general.php?page=wp-plugin-starter-template');
|
||||
// Verify the plugin row exists with the correct slug.
|
||||
cy.get( 'tr[data-slug="wp-plugin-starter-template-for-ai-coding"]' ).should( 'exist' );
|
||||
|
||||
// This is a basic check - adjust based on your actual plugin's settings page
|
||||
cy.get('h1').should('contain', 'WP Plugin Starter Template');
|
||||
});
|
||||
});
|
||||
// Verify the plugin name is displayed.
|
||||
cy.get( 'tr[data-slug="wp-plugin-starter-template-for-ai-coding"] .plugin-title strong' )
|
||||
.should( 'contain', 'WordPress Plugin Starter Template' );
|
||||
} );
|
||||
|
||||
it( 'Update source selector link is present in the plugin row', () => {
|
||||
cy.loginAsAdmin();
|
||||
cy.visit( '/wp-admin/plugins.php' );
|
||||
|
||||
// The update source selector link should be rendered in the plugin row.
|
||||
cy.get( 'tr[data-slug="wp-plugin-starter-template-for-ai-coding"]' )
|
||||
.find( '.wpst-update-source-selector' )
|
||||
.should( 'exist' );
|
||||
} );
|
||||
|
||||
it( 'Update source modal opens and displays source options', () => {
|
||||
cy.loginAsAdmin();
|
||||
cy.visit( '/wp-admin/plugins.php' );
|
||||
|
||||
// Click the update source selector link to open the modal.
|
||||
cy.get( '.wpst-update-source-selector' ).first().click();
|
||||
|
||||
// Modal should be visible.
|
||||
cy.get( '#wpst-update-source-modal' ).should( 'be.visible' );
|
||||
|
||||
// Modal should contain the three update source options.
|
||||
cy.get( '#wpst-update-source-modal input[name="update_source"][value="wordpress.org"]' ).should( 'exist' );
|
||||
cy.get( '#wpst-update-source-modal input[name="update_source"][value="github"]' ).should( 'exist' );
|
||||
cy.get( '#wpst-update-source-modal input[name="update_source"][value="gitea"]' ).should( 'exist' );
|
||||
|
||||
// Save button should be present.
|
||||
cy.get( '#wpst-save-source' ).should( 'exist' );
|
||||
} );
|
||||
|
||||
it( 'Update source modal can be closed', () => {
|
||||
cy.loginAsAdmin();
|
||||
cy.visit( '/wp-admin/plugins.php' );
|
||||
|
||||
// Open the modal.
|
||||
cy.get( '.wpst-update-source-selector' ).first().click();
|
||||
cy.get( '#wpst-update-source-modal' ).should( 'be.visible' );
|
||||
|
||||
// Close the modal via the close button.
|
||||
cy.get( '#wpst-update-source-modal .wpst-modal-close' ).click();
|
||||
cy.get( '#wpst-update-source-modal' ).should( 'not.be.visible' );
|
||||
} );
|
||||
} );
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 124 KiB |
@@ -46,8 +46,8 @@ class Admin {
|
||||
*/
|
||||
public function enqueue_admin_assets(): void {
|
||||
|
||||
// @phpcs:disable WordPress.Security.NonceVerification.Recommended
|
||||
// @phpcs:disable WordPress.Security.NonceVerification.Missing
|
||||
// @phpcs:disable WordPress.Security.NonceVerification.Recommended
|
||||
// @phpcs:disable WordPress.Security.NonceVerification.Missing
|
||||
// For production, use filter_input.
|
||||
$page = '';
|
||||
if ( defined( 'PHPUNIT_RUNNING' ) && PHPUNIT_RUNNING ) {
|
||||
@@ -64,15 +64,17 @@ class Admin {
|
||||
if ( ! $page || 'wp_plugin_starter_template_settings' !== $page ) {
|
||||
return;
|
||||
}
|
||||
// @phpcs:enable
|
||||
// @phpcs:enable
|
||||
|
||||
// Get the plugin version.
|
||||
$plugin_version = $this->core->get_plugin_version();
|
||||
|
||||
$plugin_url = $this->get_plugin_base_url();
|
||||
|
||||
// Enqueue styles.
|
||||
\wp_enqueue_style(
|
||||
'wpst-admin-styles',
|
||||
plugin_dir_url( dirname( __DIR__ ) ) . 'admin/css/admin-styles.css',
|
||||
$plugin_url . 'admin/css/admin-styles.css',
|
||||
array(), // Dependencies.
|
||||
$plugin_version // Version.
|
||||
);
|
||||
@@ -80,7 +82,7 @@ class Admin {
|
||||
// Enqueue admin scripts.
|
||||
\wp_enqueue_script(
|
||||
'wpst-admin-script',
|
||||
plugin_dir_url( dirname( __DIR__ ) ) . 'admin/js/admin-scripts.js',
|
||||
$plugin_url . 'admin/js/admin-scripts.js',
|
||||
array( 'jquery' ),
|
||||
$plugin_version, // Version.
|
||||
true
|
||||
@@ -99,4 +101,21 @@ class Admin {
|
||||
$data
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get plugin base URL.
|
||||
*
|
||||
* @return string Plugin base URL with trailing slash.
|
||||
*/
|
||||
private function get_plugin_base_url(): string {
|
||||
if ( defined( 'WP_PLUGIN_STARTER_TEMPLATE_URL' ) ) {
|
||||
return WP_PLUGIN_STARTER_TEMPLATE_URL;
|
||||
}
|
||||
|
||||
if ( defined( 'WPST_PLUGIN_URL' ) ) {
|
||||
return WPST_PLUGIN_URL;
|
||||
}
|
||||
|
||||
return \plugin_dir_url( dirname( __DIR__, 2 ) );
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,4 +25,5 @@ if ( is_multisite() ) {
|
||||
|
||||
## Testing
|
||||
|
||||
For information on testing your plugin in a multisite environment, see the [Testing Framework](../../.wiki/Testing.md) documentation.
|
||||
For information on testing your plugin in a multisite environment, see the
|
||||
[Testing Framework](../../.wiki/Testing.md) documentation.
|
||||
|
||||
@@ -6,10 +6,10 @@
|
||||
* Extend this file or create additional classes in this directory
|
||||
* to implement multisite features for your plugin.
|
||||
*
|
||||
* @package WP_Plugin_Starter_Template_For_AI_Coding
|
||||
* @package WPALLSTARS\PluginStarterTemplate
|
||||
*/
|
||||
|
||||
namespace WP_Plugin_Starter_Template_For_AI_Coding\Multisite;
|
||||
namespace WPALLSTARS\PluginStarterTemplate\Multisite;
|
||||
|
||||
// Exit if accessed directly.
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
|
||||
@@ -29,6 +29,7 @@
|
||||
"test:phpunit:multisite": "WP_MULTISITE=1 composer test",
|
||||
"build": "./build.sh",
|
||||
"lint:js": "eslint cypress/",
|
||||
"lint:css": "stylelint \"**/*.css\" --allow-empty-input",
|
||||
"lint:php": "composer run-script phpcs",
|
||||
"lint:php:simple": "composer run-script phpcs:simple",
|
||||
"lint:phpstan": "composer run-script phpstan",
|
||||
@@ -38,7 +39,7 @@
|
||||
"test:php": "composer run-script test",
|
||||
"lint": "composer run-script lint",
|
||||
"fix": "composer run-script fix",
|
||||
"quality": "npm run lint && npm run test:php"
|
||||
"quality": "npm run lint && npm run lint:css && npm run test:php"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -64,6 +65,8 @@
|
||||
"@wp-playground/cli": "^3.0.22",
|
||||
"cypress": "^13.17.0",
|
||||
"eslint": "^8.57.0",
|
||||
"eslint-plugin-cypress": "^2.15.1"
|
||||
"eslint-plugin-cypress": "^2.15.1",
|
||||
"stylelint": "^16.0.0",
|
||||
"stylelint-config-standard": "^36.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
<exclude-pattern>*/build/*</exclude-pattern>
|
||||
<exclude-pattern>*/dist/*</exclude-pattern>
|
||||
|
||||
<!-- Command line arguments -->
|
||||
<!-- Command line arguments: combined short flags (-s shows sniff codes, -p shows progress) -->
|
||||
<arg value="sp"/>
|
||||
<arg name="extensions" value="php"/>
|
||||
<arg name="basepath" value="."/>
|
||||
|
||||
@@ -15,6 +15,8 @@
|
||||
<exclude name="CamelCaseMethodName" />
|
||||
<exclude name="CamelCaseParameterName" />
|
||||
<exclude name="CamelCaseVariableName" />
|
||||
<!-- WordPress plugins use filter_input() for production and $_GET for testing; Superglobals rule is not applicable. -->
|
||||
<exclude name="Superglobals" />
|
||||
</rule>
|
||||
<rule ref="rulesets/design.xml" />
|
||||
<rule ref="rulesets/naming.xml">
|
||||
|
||||
@@ -5,13 +5,6 @@ parameters:
|
||||
- admin
|
||||
- wp-plugin-starter-template.php
|
||||
excludePaths:
|
||||
analyse:
|
||||
- vendor
|
||||
- node_modules
|
||||
- tests
|
||||
- bin
|
||||
- build
|
||||
- dist
|
||||
analyseAndScan:
|
||||
- vendor
|
||||
- node_modules
|
||||
|
||||
@@ -21,6 +21,6 @@
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<iframe src="https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json&_t=2" title="WordPress Playground Single Site Environment"></iframe>
|
||||
<iframe src="https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/main/playground/blueprint.json" title="WordPress Playground Single Site Environment"></iframe>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -68,7 +68,7 @@
|
||||
"landingPage": "/wp-admin/",
|
||||
"login": true,
|
||||
"features": {
|
||||
"networking": true
|
||||
"networking": false
|
||||
},
|
||||
"steps": [
|
||||
{
|
||||
|
||||
@@ -150,7 +150,7 @@ When you receive feedback from these code quality tools, you can use AI assistan
|
||||
|
||||
1. Copy the output from the code quality tool
|
||||
2. Paste it into your AI assistant chat
|
||||
3. Ask the AI to help you understand and resolve the issues
|
||||
3. Request the AI's assistance to interpret and resolve the reported issues
|
||||
4. Apply the suggested fixes
|
||||
5. Commit the changes and verify that the issues are resolved
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ if ( getenv( 'WP_PHPUNIT__DIR' ) ) {
|
||||
// Include plugin files needed for tests.
|
||||
require_once WPST_PLUGIN_DIR . 'includes/class-core.php';
|
||||
require_once WPST_PLUGIN_DIR . 'includes/class-plugin.php';
|
||||
if ( file_exists( WPST_PLUGIN_DIR . 'admin/lib/admin.php' ) ) {
|
||||
require_once WPST_PLUGIN_DIR . 'admin/lib/admin.php';
|
||||
if ( file_exists( WPST_PLUGIN_DIR . 'includes/Admin/class-admin.php' ) ) {
|
||||
require_once WPST_PLUGIN_DIR . 'includes/Admin/class-admin.php';
|
||||
}
|
||||
}
|
||||
|
||||
@@ -101,17 +101,12 @@ class AdminTest extends \WP_Mock\Tools\TestCase {
|
||||
'return' => 'wp_plugin_starter_template_settings',
|
||||
]);
|
||||
|
||||
// Mock WordPress functions used in the method
|
||||
WP_Mock::userFunction('plugin_dir_url', [
|
||||
'return' => 'http://example.com/wp-content/plugins/wp-plugin-starter-template/includes/Admin/',
|
||||
]);
|
||||
|
||||
// Mock wp_enqueue_style
|
||||
WP_Mock::userFunction('wp_enqueue_style', [
|
||||
'times' => 1,
|
||||
'args' => [
|
||||
'wpst-admin-styles',
|
||||
'http://example.com/wp-content/plugins/wp-plugin-starter-template/includes/Admin/../../admin/css/admin-styles.css',
|
||||
'http://example.org/wp-content/plugins/wp-plugin-starter-template/admin/css/admin-styles.css',
|
||||
[],
|
||||
'1.0.0',
|
||||
],
|
||||
@@ -122,7 +117,7 @@ class AdminTest extends \WP_Mock\Tools\TestCase {
|
||||
'times' => 1,
|
||||
'args' => [
|
||||
'wpst-admin-script',
|
||||
'http://example.com/wp-content/plugins/wp-plugin-starter-template/includes/Admin/../../admin/js/admin-scripts.js',
|
||||
'http://example.org/wp-content/plugins/wp-plugin-starter-template/admin/js/admin-scripts.js',
|
||||
['jquery'],
|
||||
'1.0.0',
|
||||
true,
|
||||
|
||||
@@ -55,13 +55,19 @@ spl_autoload_register(
|
||||
// Get the relative class name.
|
||||
$relative_class = substr( $className, $len );
|
||||
|
||||
// Convert namespace to path.
|
||||
$file = WP_PLUGIN_STARTER_TEMPLATE_PATH . 'includes/' . str_replace( '\\', '/', $relative_class ) . '.php';
|
||||
// Build class file path using WordPress-style class file names.
|
||||
$relative_path = str_replace( '\\', '/', $relative_class );
|
||||
$path_parts = explode( '/', $relative_path );
|
||||
$class_name = array_pop( $path_parts );
|
||||
$directory = '';
|
||||
|
||||
// Convert class name format to file name format.
|
||||
$file = str_replace( 'class-', '', $file );
|
||||
$file = preg_replace( '/([a-z])([A-Z])/', '$1-$2', $file );
|
||||
$file = strtolower( $file );
|
||||
if ( ! empty( $path_parts ) ) {
|
||||
$directory = implode( '/', $path_parts ) . '/';
|
||||
}
|
||||
|
||||
$class_file = preg_replace( '/([a-z])([A-Z])/', '$1-$2', $class_name );
|
||||
$class_file = 'class-' . strtolower( $class_file ) . '.php';
|
||||
$file = WP_PLUGIN_STARTER_TEMPLATE_PATH . 'includes/' . $directory . $class_file;
|
||||
|
||||
// If the file exists, require it.
|
||||
if ( file_exists( $file ) ) {
|
||||
|
||||
Reference in New Issue
Block a user