wpallstars/wp-plugin-starter-template-for-ai-coding
Template
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #13 from wpallstars/simplify-code-quality-tools

Browse Source 
Add PHPStan and PHP Mess Detector for improved code quality
This commit is contained in:
Marcus Quinn
2025-04-21 15:19:38 +01:00
committed by GitHub
parent 1f4be45862 cdc73bc010
commit 2481d63561
24 changed files with 2293 additions and 437 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
.ai-workflows/code-review.md
View File

@@ -85,13 +85,21 @@ This project uses several automated code review tools to maintain high code qual
* **Benefits**: Provides a grade for your codebase, identifies issues, and tracks code quality over time
* **Usage**: Codacy automatically analyzes your codebase and provides feedback on pull requests
### 4. SonarCloud
### 4. PHPStan
[SonarCloud](https://sonarcloud.io/) is a cloud-based code quality and security service that performs static code analysis to detect bugs, vulnerabilities, and code smells.
[PHPStan](https://phpstan.org/) is a static analysis tool that finds errors in your code without running it.
* **Integration**: Add the SonarCloud GitHub App to your repository
* **Benefits**: Provides detailed analysis of code quality, security vulnerabilities, and technical debt
* **Usage**: SonarCloud automatically analyzes your codebase and provides feedback on pull requests
* **Integration**: Included in the project's composer.json and GitHub Actions workflow
* **Benefits**: Detects undefined variables, methods, and properties; type-related issues; and logical errors
* **Usage**: Run `composer phpstan` or `npm run lint:phpstan` locally, or let GitHub Actions run it automatically
### 5. PHP Mess Detector
[PHP Mess Detector](https://phpmd.org/) is a tool that looks for potential problems in your code such as possible bugs, suboptimal code, overcomplicated expressions, and unused parameters, variables, and methods.
* **Integration**: Included in the project's composer.json and GitHub Actions workflow
* **Benefits**: Identifies code smells, complexity issues, unused code, naming problems, and more
* **Usage**: Run `composer phpmd` or `npm run lint:phpmd` locally, or let GitHub Actions run it automatically
### Using AI Assistants with Code Review Tools

48
.codacy.yml
View File

@@ -3,6 +3,52 @@ engines:
markdownlint:
enabled: true
config_file: .markdownlint.json
phpmd:
enabled: true
phpcs:
enabled: true
stylelint:
enabled: false
shellcheck:
enabled: false
# Disable tools that are causing issues
eslint:
enabled: false
eslint-8:
enabled: false
eslint-9:
enabled: false
trivy:
enabled: false
semgrep:
enabled: false
checkov:
enabled: false
pmd:
enabled: false
pmd-7:
enabled: false
lizard:
enabled: false
jshint:
enabled: false
csslint:
enabled: false
jacksonlinter:
enabled: false
spectral:
enabled: false
duplication:
enabled: true
exclude_patterns:
- "tests/**"
- "vendor/**"
- "node_modules/**"
metrics:
enabled: true
exclude_paths:
- "vendor/**"
- "node_modules/**"
@@ -11,3 +57,5 @@ exclude_paths:
- "bin/**"
- ".github/**"
- "tests/**"
- "*.lock"
- "*.json"

30
.eslintrc.json Normal file
View File

@@ -0,0 +1,30 @@
{
"env": {
"browser": true,
"jquery": true,
"es6": true
},
"extends": "eslint:recommended",
"globals": {
"wp": "readonly",
"wpstData": "readonly",
"wpstModalData": "readonly",
"Cypress": "readonly",
"cy": "readonly",
"describe": "readonly",
"it": "readonly",
"before": "readonly",
"module": "readonly"
},
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"rules": {
"indent": ["error", 2],
"linebreak-style": ["error", "unix"],
"quotes": ["error", "single"],
"semi": ["error", "always"]
},
"ignorePatterns": ["vendor/**", "node_modules/**", "build/**", "dist/**", "bin/**"]
}

70
.github/workflows/code-quality.yml vendored
View File

@@ -1,4 +1,4 @@
name: Code Quality - Run automated code quality checks
name: Code Quality
on:
push:
@@ -19,21 +19,71 @@ jobs:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
php-version: '8.1'
extensions: mbstring, intl, zip
tools: composer:v2, phpcs
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
- name: Run PHPCS
run: composer run phpcs
run: composer phpcs
continue-on-error: true
- name: Run PHPCBF (report only)
run: |
echo "Running PHPCBF in dry-run mode to show what would be fixed"
composer run phpcbf -- --dry-run
composer phpcbf -- --dry-run
continue-on-error: true
phpstan:
name: PHPStan Static Analysis
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
extensions: mbstring, intl, zip
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
- name: Run PHPStan
run: composer phpstan
continue-on-error: true
phpmd:
name: PHP Mess Detector
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
extensions: mbstring, intl, zip
tools: composer:v2, phpmd
- name: Install dependencies
run: composer install --prefer-dist --no-progress
- name: Run PHPMD
run: composer phpmd
continue-on-error: true
sonarcloud:
@@ -59,7 +109,7 @@ jobs:
restore-keys: ${{ runner.os }}-sonar
- name: SonarCloud Scan
uses: SonarSource/sonarcloud-github-action@v2.0.2
uses: SonarSource/sonarqube-scan-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
@@ -88,13 +138,15 @@ jobs:
verbose: true
output: results.sarif
format: sarif
# Adjust the below patterns based on your project structure
# Limit the number of issues to prevent GitHub Code Scanning rejection
gh-code-scanning-compat: true
max-allowed-issues: 2147483647
max-allowed-issues: 20
# Limit tools to prevent timeouts and stay under GitHub's 20 runs limit
tool: phpcs,phpmd,markdownlint
continue-on-error: true
- name: Upload SARIF results file
uses: github/codeql-action/upload-sarif@v2
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: results.sarif
continue-on-error: true

1
.markdownlint.json
View File

@@ -1,4 +1,5 @@
{
"default": true,
"MD004": {
"style": "asterisk"
},

16
.stylelintrc.json Normal file
View File

@@ -0,0 +1,16 @@
{
"extends": "stylelint-config-standard",
"rules": {
"alpha-value-notation": "percentage",
"color-function-notation": "modern",
"font-weight-notation": "numeric",
"media-feature-range-notation": "context"
},
"ignoreFiles": [
"vendor/**",
"node_modules/**",
"build/**",
"dist/**",
"bin/**"
]
}

165
README.md
View File

@@ -252,10 +252,43 @@ This project uses several automated code quality tools to ensure high standards.
3. **Codacy**: Code quality and static analysis
* [Website](https://www.codacy.com/)
* Identifies issues related to code style, security, and performance
* Requires a `CODACY_PROJECT_TOKEN` secret in your GitHub repository settings
* To set up Codacy:
1. Go to [Codacy](https://www.codacy.com/) and sign in with your GitHub account
2. Add your repository to Codacy
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.
4. **SonarCloud**: Code quality and security analysis
* [Website](https://sonarcloud.io/)
* Provides detailed analysis of code quality and security
* Requires a `SONAR_TOKEN` secret in your GitHub repository settings
* To set up SonarCloud:
1. Go to [SonarCloud](https://sonarcloud.io/) and sign in with your GitHub account
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. **PHP_CodeSniffer (PHPCS)**: PHP code style checker
* Enforces WordPress Coding Standards
* Automatically runs in GitHub Actions workflow
* Run locally with `composer phpcs`
6. **PHP Code Beautifier and Fixer (PHPCBF)**: Automatically fixes coding standard violations
* Run locally with `composer phpcbf`
7. **PHPStan**: PHP static analysis tool
* Detects bugs and errors without running the code
* Run locally with `composer phpstan`
8. **PHP Mess Detector (PHPMD)**: Analyzes code for potential problems
* Identifies complex code, unused parameters, etc.
* Run locally with `composer phpmd`
For detailed setup instructions, see the [Code Quality Setup Guide](docs/code-quality-setup.md).
### Using AI Assistants with Code Quality Tools
@@ -269,6 +302,138 @@ When you receive feedback from these code quality tools, you can use AI assistan
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
GitHub offers three levels of secrets management, each with different scopes and use cases:
1. **Organization Secrets** (recommended for teams and organizations):
* Available at: GitHub Organization > Settings > Secrets and variables > Actions
* Scope: Can be shared across multiple repositories within the organization
* Benefits: Centralized management, reduced duplication, easier rotation
* Recommended for: `SONAR_TOKEN` and other tokens that apply to multiple repositories
* Note: You can restrict which repositories can access organization secrets
* Note: Codacy tokens (`CODACY_PROJECT_TOKEN`) are project-specific and should be set at the repository level
2. **Repository Secrets**:
* 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
3. **Environment Secrets**:
* Available at: Repository > Settings > Environments > (select environment) > Environment secrets
* Scope: Limited to specific deployment environments (e.g., production, staging)
* 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.
### Local Environment Setup for Code Quality Tools
To run code quality tools locally before committing to GitHub:
1. **Install dependencies**:
```bash
composer install
```
2. **Run PHP CodeSniffer**:
```bash
composer phpcs
```
3. **Fix coding standards automatically**:
```bash
composer phpcbf
```
4. **Run PHPStan static analysis**:
```bash
composer phpstan
```
5. **Run PHP Mess Detector**:
```bash
composer phpmd
```
6. **Run all linters at once**:
```bash
composer lint
```
7. **Set up environment variables for SonarCloud and Codacy**:
* **For macOS/Linux**:
```bash
export SONAR_TOKEN=your_sonar_token
export CODACY_PROJECT_TOKEN=your_codacy_token
```
* **For Windows (Command Prompt)**:
```cmd
set SONAR_TOKEN=your_sonar_token
set CODACY_PROJECT_TOKEN=your_codacy_token
```
* **For Windows (PowerShell)**:
```powershell
$env:SONAR_TOKEN="your_sonar_token"
$env:CODACY_PROJECT_TOKEN="your_codacy_token"
```
8. **Create a .env file** (alternative approach):
```env
# .env (already included in .gitignore to prevent committing secrets)
SONAR_TOKEN=your_sonar_token
CODACY_PROJECT_TOKEN=your_codacy_token
```
Then load these variables:
```bash
# Using a tool like dotenv
source .env
```
9. **Run SonarCloud locally**:
```bash
# Install SonarScanner
npm install -g sonarqube-scanner
# Run analysis
sonar-scanner \
-Dsonar.projectKey=your_project_key \
-Dsonar.organization=your_organization \
-Dsonar.sources=. \
-Dsonar.host.url=https://sonarcloud.io \
-Dsonar.login=$SONAR_TOKEN
```
10. **Run Codacy locally**:
```bash
# Install Codacy CLI
npm install -g codacy-coverage
# Run analysis
codacy-analysis-cli analyze --directory . --project-token $CODACY_PROJECT_TOKEN
```
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.
## Developers
### AI-Powered Development

6
admin/css/admin-styles.css
View File

@@ -11,7 +11,7 @@
padding: 20px;
background: #fff;
border-radius: 5px;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
box-shadow: 0 1px 3px rgb(0 0 0 / 10%);
}
.wpst-admin-header {
@@ -98,7 +98,7 @@
padding: 20px;
background: #fff;
border-radius: 3px;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
box-shadow: 0 1px 3px rgb(0 0 0 / 10%);
}
.wpst-card-header {
@@ -124,7 +124,7 @@
}
/* Responsive Styles */
@media screen and (max-width: 782px) {
@media screen and (width <= 782px) {
.wpst-form-table th {
width: 100%;
display: block;

8
admin/css/update-source-selector.css
View File

@@ -14,7 +14,7 @@
width: 100%;
height: 100%;
overflow: auto;
background-color: rgba(0, 0, 0, 0.4);
background-color: rgb(0 0 0 / 40%);
}
.wpst-modal-content {
@@ -23,7 +23,7 @@
margin: 10% auto;
padding: 20px;
border-radius: 5px;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
box-shadow: 0 4px 8px rgb(0 0 0 / 10%);
width: 500px;
max-width: 90%;
}
@@ -45,7 +45,7 @@
top: 10px;
right: 15px;
font-size: 20px;
font-weight: bold;
font-weight: 700;
color: #666;
cursor: pointer;
}
@@ -108,7 +108,7 @@
display: inline-block;
width: 20px;
height: 20px;
border: 2px solid rgba(0, 0, 0, 0.1);
border: 2px solid rgb(0 0 0 / 10%);
border-radius: 50%;
border-top-color: #0073aa;
animation: wpst-spin 1s ease-in-out infinite;

178
admin/js/admin-scripts.js
View File

@@ -5,131 +5,131 @@
*/
(function ($) {
'use strict';
'use strict';
/**
/**
* Admin functionality
*/
const WPSTAdmin = {
/**
const WPSTAdmin = {
/**
* Initialize
*/
init: function () {
// Initialize components.
this.initComponents();
init: function () {
// Initialize components.
this.initComponents();
// Bind events.
this.bindEvents();
},
// Bind events.
this.bindEvents();
},
/**
/**
* Initialize components
*/
initComponents: function () {
// Initialize any components here.
},
initComponents: function () {
// Initialize any components here.
},
/**
/**
* Bind events
*/
bindEvents: function () {
// Example: Toggle sections.
$( '.wpst-toggle-section' ).on( 'click', this.toggleSection );
bindEvents: function () {
// Example: Toggle sections.
$( '.wpst-toggle-section' ).on( 'click', this.toggleSection );
// Example: Form submission.
$( '#wpst-settings-form' ).on( 'submit', this.handleFormSubmit );
},
// Example: Form submission.
$( '#wpst-settings-form' ).on( 'submit', this.handleFormSubmit );
},
/**
/**
* Toggle section visibility
*
* @param {Event} e Click event
*/
toggleSection: function (e) {
e.preventDefault();
toggleSection: function (e) {
e.preventDefault();
const $this = $( this );
const target = $this.data( 'target' );
const $this = $( this );
const target = $this.data( 'target' );
$( target ).slideToggle( 200 );
$this.toggleClass( 'open' );
},
$( target ).slideToggle( 200 );
$this.toggleClass( 'open' );
},
/**
/**
* Handle form submission
*
* @param {Event} e Submit event
*/
handleFormSubmit: function (e) {
e.preventDefault();
handleFormSubmit: function (e) {
e.preventDefault();
const $form = $( this );
const $submitButton = $form.find( 'input[type="submit"]' );
const formData = $form.serialize();
const $form = $( this );
const $submitButton = $form.find( 'input[type="submit"]' );
const formData = $form.serialize();
// Disable submit button and show loading state.
$submitButton.prop( 'disabled', true ).addClass( 'loading' );
// Disable submit button and show loading state.
$submitButton.prop( 'disabled', true ).addClass( 'loading' );
// Send AJAX request.
$.ajax(
{
url: wpstData.ajaxUrl,
type: 'POST',
data: {
action: 'wpst_save_settings',
nonce: wpstData.nonce,
formData: formData
},
success: function (response) {
if (response.success) {
WPSTAdmin.showNotice( 'success', response.data.message );
} else {
WPSTAdmin.showNotice( 'error', response.data.message );
}
},
error: function () {
WPSTAdmin.showNotice( 'error', 'An error occurred. Please try again.' );
},
complete: function () {
// Re-enable submit button and remove loading state.
$submitButton.prop( 'disabled', false ).removeClass( 'loading' );
}
}
);
},
// Send AJAX request.
$.ajax(
{
url: wpstData.ajaxUrl,
type: 'POST',
data: {
action: 'wpst_save_settings',
nonce: wpstData.nonce,
formData: formData
},
success: function (response) {
if (response.success) {
WPSTAdmin.showNotice( 'success', response.data.message );
} else {
WPSTAdmin.showNotice( 'error', response.data.message );
}
},
error: function () {
WPSTAdmin.showNotice( 'error', 'An error occurred. Please try again.' );
},
complete: function () {
// Re-enable submit button and remove loading state.
$submitButton.prop( 'disabled', false ).removeClass( 'loading' );
}
}
);
},
/**
/**
* Show admin notice
*
* @param {string} type Notice type (success, error, warning)
* @param {string} message Notice message
*/
showNotice: function (type, message) {
const $notice = $( '<div class="wpst-notice ' + type + '"><p>' + message + '</p></div>' );
showNotice: function (type, message) {
const $notice = $( '<div class="wpst-notice ' + type + '"><p>' + message + '</p></div>' );
// Add notice to the page.
$( '.wpst-notices' ).html( $notice );
// Add notice to the page.
$( '.wpst-notices' ).html( $notice );
// Automatically remove notice after 5 seconds.
setTimeout(
function () {
$notice.fadeOut(
300,
function () {
$( this ).remove();
}
);
},
5000
);
}
};
// Automatically remove notice after 5 seconds.
setTimeout(
function () {
$notice.fadeOut(
300,
function () {
$( this ).remove();
}
);
},
5000
);
}
};
// Initialize when document is ready.
$( document ).ready(
function () {
WPSTAdmin.init();
}
);
// Initialize when document is ready.
$( document ).ready(
function () {
WPSTAdmin.init();
}
);
})( jQuery );

240
admin/js/update-source-selector.js
View File

@@ -5,174 +5,174 @@
*/
(function ($) {
'use strict';
'use strict';
/**
/**
* Update Source Selector functionality
*/
const WPSTUpdateSourceSelector = {
/**
const WPSTUpdateSourceSelector = {
/**
* Modal element
*/
$modal: null,
$modal: null,
/**
/**
* Selected source
*/
selectedSource: '',
selectedSource: '',
/**
/**
* Initialize
*/
init: function () {
// Cache DOM elements.
this.$modal = $( '#wpst-update-source-modal' );
init: function () {
// Cache DOM elements.
this.$modal = $( '#wpst-update-source-modal' );
// Bind events.
this.bindEvents();
},
// Bind events.
this.bindEvents();
},
/**
/**
* Bind events
*/
bindEvents: function () {
// Open modal when clicking on the update source link.
$( document ).on( 'click', '.wpst-update-source-selector', this.openModal.bind( this ) );
bindEvents: function () {
// Open modal when clicking on the update source link.
$( document ).on( 'click', '.wpst-update-source-selector', this.openModal.bind( this ) );
// Close modal when clicking on the close button or outside the modal.
this.$modal.on( 'click', '.wpst-modal-close', this.closeModal.bind( this ) );
$( document ).on(
'click',
'.wpst-modal',
function (e) {
if ($( e.target ).hasClass( 'wpst-modal' )) {
WPSTUpdateSourceSelector.closeModal();
}
}
);
// Close modal when clicking on the close button or outside the modal.
this.$modal.on( 'click', '.wpst-modal-close', this.closeModal.bind( this ) );
$( document ).on(
'click',
'.wpst-modal',
function (e) {
if ($( e.target ).hasClass( 'wpst-modal' )) {
WPSTUpdateSourceSelector.closeModal();
}
}
);
// Select source option.
this.$modal.on( 'click', '.wpst-source-option', this.selectSource.bind( this ) );
// Select source option.
this.$modal.on( 'click', '.wpst-source-option', this.selectSource.bind( this ) );
// Save source selection.
this.$modal.on( 'click', '#wpst-save-source', this.saveSource.bind( this ) );
},
// Save source selection.
this.$modal.on( 'click', '#wpst-save-source', this.saveSource.bind( this ) );
},
/**
/**
* Open the modal
*
* @param {Event} e Click event
*/
openModal: function (e) {
e.preventDefault();
this.$modal.show();
},
openModal: function (e) {
e.preventDefault();
this.$modal.show();
},
/**
/**
* Close the modal
*/
closeModal: function () {
this.$modal.hide();
},
closeModal: function () {
this.$modal.hide();
},
/**
/**
* Select a source option
*
* @param {Event} e Click event
*/
selectSource: function (e) {
const $option = $( e.currentTarget );
selectSource: function (e) {
const $option = $( e.currentTarget );
// Update selected state.
this.$modal.find( '.wpst-source-option' ).removeClass( 'selected' );
$option.addClass( 'selected' );
// Update selected state.
this.$modal.find( '.wpst-source-option' ).removeClass( 'selected' );
$option.addClass( 'selected' );
// Update radio button.
$option.find( 'input[type="radio"]' ).prop( 'checked', true );
// Update radio button.
$option.find( 'input[type="radio"]' ).prop( 'checked', true );
// Store selected source.
this.selectedSource = $option.find( 'input[type="radio"]' ).val();
},
// Store selected source.
this.selectedSource = $option.find( 'input[type="radio"]' ).val();
},
/**
/**
* Save the selected source
*/
saveSource: function () {
// Validate selection.
if ( ! this.selectedSource) {
this.showMessage( 'error', 'Please select an update source.' );
return;
}
saveSource: function () {
// Validate selection.
if ( ! this.selectedSource) {
this.showMessage( 'error', 'Please select an update source.' );
return;
}
// Show loading state.
const $saveButton = $( '#wpst-save-source' );
$saveButton.prop( 'disabled', true ).html( '<span class="wpst-loading"></span> Saving...' );
// Show loading state.
const $saveButton = $( '#wpst-save-source' );
$saveButton.prop( 'disabled', true ).html( '<span class="wpst-loading"></span> Saving...' );
// Send AJAX request.
$.ajax(
{
url: wpstModalData.ajaxUrl, // WordPress AJAX URL.
type: 'POST',
data: {
action: 'wpst_set_update_source', // AJAX action hook.
nonce: wpstModalData.nonce, // Security nonce.
source: this.selectedSource
},
success: function (response) {
if (response.success) {
WPSTUpdateSourceSelector.showMessage( 'success', response.data.message );
// Send AJAX request.
$.ajax(
{
url: wpstModalData.ajaxUrl, // WordPress AJAX URL.
type: 'POST',
data: {
action: 'wpst_set_update_source', // AJAX action hook.
nonce: wpstModalData.nonce, // Security nonce.
source: this.selectedSource
},
success: function (response) {
if (response.success) {
WPSTUpdateSourceSelector.showMessage( 'success', response.data.message );
// Close modal after a short delay.
setTimeout(
function () {
WPSTUpdateSourceSelector.closeModal();
},
1500
);
} else {
WPSTUpdateSourceSelector.showMessage( 'error', response.data.message );
}
},
error: function () {
WPSTUpdateSourceSelector.showMessage( 'error', 'An error occurred. Please try again.' );
},
complete: function () {
// Reset button state.
$saveButton.prop( 'disabled', false ).text( wpstModalData.i18n.confirm );
}
}
);
},
// Close modal after a short delay.
setTimeout(
function () {
WPSTUpdateSourceSelector.closeModal();
},
1500
);
} else {
WPSTUpdateSourceSelector.showMessage( 'error', response.data.message );
}
},
error: function () {
WPSTUpdateSourceSelector.showMessage( 'error', 'An error occurred. Please try again.' );
},
complete: function () {
// Reset button state.
$saveButton.prop( 'disabled', false ).text( wpstModalData.i18n.confirm );
}
}
);
},
/**
/**
* Show a message in the modal
*
* @param {string} type Message type (success, error)
* @param {string} message Message text
*/
showMessage: function (type, message) {
const $message = this.$modal.find( '.wpst-modal-message' );
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 content and type.
$message.html( message ).removeClass( 'success error' ).addClass( type ).show();
// Hide message after a delay for success messages.
if (type === 'success') {
setTimeout(
function () {
$message.fadeOut( 300 );
},
3000
);
}
}
};
// Hide message after a delay for success messages.
if (type === 'success') {
setTimeout(
function () {
$message.fadeOut( 300 );
},
3000
);
}
}
};
// Initialize when document is ready.
$( document ).ready(
function () {
WPSTUpdateSourceSelector.init();
}
);
// Initialize when document is ready.
$( document ).ready(
function () {
WPSTUpdateSourceSelector.init();
}
);
})( jQuery );

84
admin/templates/modal.php
View File

@@ -7,51 +7,51 @@
// Ensure this file is loaded within WordPress.
if ( ! defined( 'ABSPATH' ) ) {
die;
die;
}
?>
<!-- Update Source Modal -->
<div id="wpst-update-source-modal" class="wpst-modal">
<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">&times;</span>
</div>
<div class="wpst-modal-body">
<p><?php esc_html_e( 'Choose your preferred source for plugin updates:', 'wp-plugin-starter-template' ); ?></p>
<div class="wpst-modal-message"></div>
<div class="wpst-source-options">
<?php
// Get current update source.
$current_source = get_option( 'wpst_update_source', 'wordpress.org' );
?>
<label class="wpst-source-option <?php echo 'wordpress.org' === $current_source ? 'selected' : ''; ?>">
<input type="radio" name="update_source" value="wordpress.org" <?php checked( $current_source, 'wordpress.org' ); ?>>
<span class="wpst-source-option-label"><?php esc_html_e( 'WordPress.org', 'wp-plugin-starter-template' ); ?></span>
<div class="wpst-source-option-description"><?php esc_html_e( 'Receive updates from the official WordPress.org repository. Recommended for most users.', 'wp-plugin-starter-template' ); ?></div>
</label>
<label class="wpst-source-option <?php echo 'github' === $current_source ? 'selected' : ''; ?>">
<input type="radio" name="update_source" value="github" <?php checked( $current_source, 'github' ); ?>>
<span class="wpst-source-option-label"><?php esc_html_e( 'GitHub', 'wp-plugin-starter-template' ); ?></span>
<div class="wpst-source-option-description"><?php esc_html_e( 'Receive updates from the GitHub repository. May include pre-release versions.', 'wp-plugin-starter-template' ); ?></div>
</label>
<label class="wpst-source-option <?php echo 'gitea' === $current_source ? 'selected' : ''; ?>">
<input type="radio" name="update_source" value="gitea" <?php checked( $current_source, 'gitea' ); ?>>
<span class="wpst-source-option-label"><?php esc_html_e( 'Gitea', 'wp-plugin-starter-template' ); ?></span>
<div class="wpst-source-option-description"><?php esc_html_e( 'Receive updates from the Gitea repository. May include pre-release versions.', 'wp-plugin-starter-template' ); ?></div>
</label>
</div>
</div>
<div class="wpst-modal-footer">
<button type="button" id="wpst-save-source" class="button button-primary"><?php esc_html_e( 'Save', 'wp-plugin-starter-template' ); ?></button>
</div>
</div>
<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">&times;</span>
</div>
<div class="wpst-modal-body">
<p><?php esc_html_e( 'Choose your preferred source for plugin updates:', 'wp-plugin-starter-template' ); ?></p>
<div class="wpst-modal-message"></div>
<div class="wpst-source-options">
<?php
// Get current update source.
$current_source = get_option( 'wpst_update_source', 'wordpress.org' );
?>
<label class="wpst-source-option <?php echo 'wordpress.org' === $current_source ? 'selected' : ''; ?>">
<input type="radio" name="update_source" value="wordpress.org" <?php checked( $current_source, 'wordpress.org' ); ?>>
<span class="wpst-source-option-label"><?php esc_html_e( 'WordPress.org', 'wp-plugin-starter-template' ); ?></span>
<div class="wpst-source-option-description"><?php esc_html_e( 'Receive updates from the official WordPress.org repository. Recommended for most users.', 'wp-plugin-starter-template' ); ?></div>
</label>
<label class="wpst-source-option <?php echo 'github' === $current_source ? 'selected' : ''; ?>">
<input type="radio" name="update_source" value="github" <?php checked( $current_source, 'github' ); ?>>
<span class="wpst-source-option-label"><?php esc_html_e( 'GitHub', 'wp-plugin-starter-template' ); ?></span>
<div class="wpst-source-option-description"><?php esc_html_e( 'Receive updates from the GitHub repository. May include pre-release versions.', 'wp-plugin-starter-template' ); ?></div>
</label>
<label class="wpst-source-option <?php echo 'gitea' === $current_source ? 'selected' : ''; ?>">
<input type="radio" name="update_source" value="gitea" <?php checked( $current_source, 'gitea' ); ?>>
<span class="wpst-source-option-label"><?php esc_html_e( 'Gitea', 'wp-plugin-starter-template' ); ?></span>
<div class="wpst-source-option-description"><?php esc_html_e( 'Receive updates from the Gitea repository. May include pre-release versions.', 'wp-plugin-starter-template' ); ?></div>
</label>
</div>
</div>
<div class="wpst-modal-footer">
<button type="button" id="wpst-save-source" class="button button-primary"><?php esc_html_e( 'Save', 'wp-plugin-starter-template' ); ?></button>
</div>
</div>
</div>

2
assets/css/admin.css
View File

@@ -6,7 +6,7 @@
padding: 20px;
background: #fff;
border: 1px solid #ccd0d4;
box-shadow: 0 1px 1px rgba(0, 0, 0, 0.04);
box-shadow: 0 1px 1px rgb(0 0 0 / 4%);
margin-top: 20px;
}

8
assets/js/admin.js
View File

@@ -3,10 +3,10 @@
*/
(function($) {
'use strict';
'use strict';
$(document).ready(function() {
// Plugin admin functionality will go here
});
$(document).ready(function() {
// Plugin admin functionality will go here
});
})(jQuery);

27
composer.json
View File

@@ -15,11 +15,20 @@
"php": ">=7.4"
},
"require-dev": {
"phpunit/phpunit": "^9.5",
"phpunit/phpunit": "^9.5.0",
"10up/wp_mock": "^1.0",
"dealerdirect/phpcodesniffer-composer-installer": "^1.0",
"wp-coding-standards/wpcs": "^3.0",
"phpcompatibility/phpcompatibility-wp": "^2.1"
"phpcompatibility/phpcompatibility-wp": "^2.1",
"phpstan/phpstan": "^1.10.0",
"szepeviktor/phpstan-wordpress": "^1.3",
"phpmd/phpmd": "^2.13.0",
"symfony/dependency-injection": "^5.4",
"symfony/config": "^5.4",
"symfony/filesystem": "^5.4",
"symfony/deprecation-contracts": "^2.5",
"doctrine/instantiator": "^1.5.0",
"psr/log": "^1.1"
},
"autoload": {
"psr-4": {
@@ -37,12 +46,14 @@
}
},
"scripts": {
"phpcs": "phpcs --standard=phpcs.xml",
"phpcs:simple": "phpcs --standard=phpcs-simple.xml",
"phpcbf": "phpcbf --standard=phpcs.xml",
"phpcbf:simple": "phpcbf --standard=phpcs-simple.xml",
"test": "phpunit",
"lint": ["@phpcs"],
"phpcs": "vendor/bin/phpcs --standard=phpcs.xml",
"phpcs:simple": "vendor/bin/phpcs --standard=phpcs-simple.xml",
"phpcbf": "vendor/bin/phpcbf --standard=phpcs.xml",
"phpcbf:simple": "vendor/bin/phpcbf --standard=phpcs-simple.xml",
"phpstan": "vendor/bin/phpstan analyse --level=5 .",
"phpmd": "vendor/bin/phpmd . text cleancode,codesize,controversial,design,naming,unusedcode --exclude vendor,node_modules,tests,bin,build,dist",
"test": "vendor/bin/phpunit",
"lint": ["@phpcs", "@phpstan", "@phpmd"],
"fix": ["@phpcbf"]
}
}

1355
composer.lock generated
View File

File diff suppressed because it is too large Load Diff

107
docs/code-quality-setup.md Normal file
View File

@@ -0,0 +1,107 @@
# Code Quality Tools Setup
This document explains how to set up and use the code quality tools for this project.
## Prerequisites
* PHP 7.4 or higher
* Composer
## Installation
1. Clone the repository:
```bash
git clone https://github.com/wpallstars/wp-plugin-starter-template-for-ai-coding.git
cd wp-plugin-starter-template-for-ai-coding
```
2. Install dependencies:
```bash
composer install
```
## Available Tools
### PHP CodeSniffer (PHPCS)
PHPCS checks your code against the WordPress Coding Standards.
```bash
# Run PHPCS
composer phpcs
# Run PHPCS with a simplified ruleset
composer phpcs:simple
```
### PHP Code Beautifier and Fixer (PHPCBF)
PHPCBF automatically fixes coding standard violations.
```bash
# Run PHPCBF to fix coding standard violations
composer phpcbf
# Run PHPCBF with a simplified ruleset
composer phpcbf:simple
```
### PHPStan
PHPStan performs static analysis to find bugs in your code.
```bash
# Run PHPStan
composer phpstan
```
### PHP Mess Detector (PHPMD)
PHPMD detects potential problems in your code.
```bash
# Run PHPMD
composer phpmd
```
### Running All Linters
```bash
# Run all linters (PHPCS, PHPStan, PHPMD)
composer lint
```
### Running All Fixers
```bash
# Run all fixers (PHPCBF)
composer fix
```
## Environment Variables
For SonarCloud and Codacy integration, you need to set up the following environment variables:
### SonarCloud
```bash
export SONAR_TOKEN=your_sonar_token
```
### Codacy
```bash
export CODACY_PROJECT_TOKEN=your_codacy_token
```
## CI/CD Integration
The project includes GitHub Actions workflows for running these tools automatically on each push and pull request. See the `.github/workflows/code-quality.yml` file for details.
## Customization
* PHPCS rules can be customized in `phpcs.xml`
* PHPStan configuration is in `phpstan.neon`
* SonarCloud configuration is in `sonar-project.properties`

121
includes/Admin/class-admin.php
View File

@@ -14,86 +14,71 @@ use WPALLSTARS\PluginStarterTemplate\Core;
*/
class Admin {
/**
* Core plugin class instance.
*
* @var Core
*/
private $core;
/**
* Core plugin class instance.
*
* @var Core
*/
private $core;
/**
* Constructor.
*
* @param Core $core Core instance.
*/
public function __construct( Core $core ) {
$this->core = $core;
$this->initialize_hooks();
}
/**
* Constructor.
*
* @param Core $core Core instance.
*/
public function __construct( Core $core ) {
$this->core = $core;
$this->initialize_hooks();
}
/**
* Initializes WordPress hooks.
*/
private function initialize_hooks() {
\add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_assets' ) );
}
/**
* Initializes WordPress hooks.
*/
private function initialize_hooks(): void {
\add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_assets' ) );
}
/**
* Enqueues admin-specific scripts and styles.
*
* This method is hooked into 'admin_enqueue_scripts'. It checks if the current
* screen is relevant to the plugin before enqueueing assets.
/**
* Enqueues admin-specific scripts and styles.
*
* This method is hooked into 'admin_enqueue_scripts'. It checks if the current
* screen is relevant to the plugin before enqueueing assets.
*
*
* @phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found
* @param string $hook_suffix The hook suffix of the current admin page.
*/
public function enqueue_admin_assets( string $hook_suffix ): void {
*/
public function enqueue_admin_assets(): void {
// @phpcs:disable WordPress.Security.NonceVerification.Recommended
// @phpcs:disable WordPress.Security.NonceVerification.Missing
if ( ! isset( $_GET['page'] ) || 'wp_plugin_starter_template_settings' !== $_GET['page'] ) {
return;
}
$page = filter_input( INPUT_GET, 'page', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
if ( ! $page || 'wp_plugin_starter_template_settings' !== $page ) {
return;
}
// @phpcs:enable
// Get the plugin version.
$plugin_version = $this->core->get_plugin_version();
// Get the plugin version.
$pluginVersion = $this->core->get_plugin_version();
// Enqueue styles.
\wp_enqueue_style(
'wpst-admin-styles',
\plugin_dir_url( __FILE__ ) . '../../admin/css/admin-styles.css',
array(), // Dependencies.
$plugin_version // Version.
);
// Enqueue styles.
\wp_enqueue_style(
'wpst-admin-styles',
\plugin_dir_url( __FILE__ ) . '../../admin/css/admin-styles.css',
array(), // Dependencies.
$pluginVersion // Version.
);
// Enqueue admin scripts.
\wp_enqueue_script(
'wpst-admin-script',
\plugin_dir_url( __FILE__ ) . '../../admin/js/admin-scripts.js',
array( 'jquery' ),
$plugin_version, // Version.
true
);
// Enqueue admin scripts.
\wp_enqueue_script(
'wpst-admin-script',
\plugin_dir_url( __FILE__ ) . '../../admin/js/admin-scripts.js',
array( 'jquery' ),
$pluginVersion, // Version.
true
);
// Prepare data for localization.
$data = array(
'ajax_url' => \admin_url( 'admin-ajax.php' ),
// @TODO: Fix mocking for wp_create_nonce. Issue #1.
// 'nonce' => \wp_create_nonce( 'wpst_admin_nonce' ),
);
// Localize the script with the data.
// @TODO: Fix mocking for wp_localize_script. Issue #1.
// @phpcs:ignore Squiz.PHP.CommentedOutCode.Found
/*
\wp_localize_script(
'wpst-admin-script',
'wpst_admin_data',
$data
);
*/
}
// TODO: Implement localization when mocking is fixed (Issue #1).
// This will include ajax_url and nonce for security.
}
}

64
includes/class-core.php
View File

@@ -12,39 +12,39 @@ namespace WPALLSTARS\PluginStarterTemplate;
*/
class Core {
/**
* Plugin version
*
* @var string
*/
private $version;
/**
* Plugin version
*
* @var string
*/
private $version;
/**
* Constructor
*
* @param string $version Plugin version.
*/
public function __construct( $version = '' ) {
// Initialize hooks.
$this->version = $version;
}
/**
* Constructor
*
* @param string $version Plugin version.
*/
public function __construct( $version = '' ) {
// Initialize hooks.
$this->version = $version;
}
/**
* Example method to filter content
*
* @param string $content The content to filter.
* @return string The filtered content.
*/
public function filter_content( $content ) {
return $content;
}
/**
* Example method to filter content
*
* @param string $content The content to filter.
* @return string The filtered content.
*/
public function filter_content( $content ) {
return $content;
}
/**
* Get the plugin version
*
* @return string The plugin version.
*/
public function get_plugin_version() {
return $this->version;
}
/**
* Get the plugin version
*
* @return string The plugin version.
*/
public function get_plugin_version() {
return $this->version;
}
}

84
includes/class-plugin.php
View File

@@ -14,51 +14,51 @@ use WPALLSTARS\PluginStarterTemplate\Admin\Admin;
*/
class Plugin {
/**
* Core instance
*
* @var Core
*/
private $core;
/**
* Core instance
*
* @var Core
*/
private $core;
/**
* Admin instance
*
* @var Admin
*/
private $admin;
/**
* Admin instance
*
* @var Admin
*/
private $admin;
/**
* Plugin file
*
* @var string
*/
private $plugin_file;
/**
* Plugin file path
*
* @var string
*/
private string $pluginFile;
/**
* Plugin version
*
* @var string
*/
private $version;
/**
* Plugin version
*
* @var string
*/
private $version;
/**
* Constructor
*
* @param string $plugin_file Main plugin file path.
* @param string $version Plugin version.
*/
public function __construct( $plugin_file, $version ) {
$this->plugin_file = $plugin_file;
$this->version = $version;
$this->core = new Core( $version );
$this->admin = new Admin( $this->core );
}
/**
* Constructor
*
* @param string $pluginFile Main plugin file path.
* @param string $version Plugin version.
*/
public function __construct( string $pluginFile, string $version ) {
$this->pluginFile = $pluginFile;
$this->version = $version;
$this->core = new Core( $version );
$this->admin = new Admin( $this->core );
}
/**
* Initialize the plugin
*/
public function init() {
// Initialization logic goes here.
}
/**
* Initialize the plugin
*/
public function init() {
// Initialization logic goes here.
}
}

6
package.json
View File

@@ -13,11 +13,13 @@
"build": "./build.sh",
"lint:php": "composer run-script phpcs",
"lint:php:simple": "composer run-script phpcs:simple",
"lint:phpstan": "composer run-script phpstan",
"lint:phpmd": "composer run-script phpmd",
"fix:php": "composer run-script phpcbf",
"fix:php:simple": "composer run-script phpcbf:simple",
"test:php": "composer run-script test",
"lint": "npm run lint:php",
"fix": "npm run fix:php",
"lint": "composer run-script lint",
"fix": "composer run-script fix",
"quality": "npm run lint && npm run test:php"
},
"repository": {

65
phpcs.xml Normal file
View File

@@ -0,0 +1,65 @@
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards">
<description>WordPress dev PHP_CodeSniffer ruleset.</description>
<!-- Check all PHP files in directory tree by default. -->
<file>.</file>
<exclude-pattern>*/vendor/*</exclude-pattern>
<exclude-pattern>*/node_modules/*</exclude-pattern>
<exclude-pattern>*/bin/*</exclude-pattern>
<exclude-pattern>*/.github/*</exclude-pattern>
<exclude-pattern>*/tests/*</exclude-pattern>
<exclude-pattern>libs/</exclude-pattern>
<arg name="extensions" value="php" />
<arg name="basepath" value="." />
<arg name="parallel" value="8" />
<!-- Configs -->
<config name="minimum_supported_wp_version" value="5.2" />
<!-- Rules -->
<rule ref="WordPress">
<exclude name="WordPress.NamingConventions.ValidVariableName" />
<exclude name="WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition" />
<!-- Disable Strict comparison in array check. Not applicable in the majority of cases. -->
<exclude name="WordPress.PHP.StrictInArray" />
<exclude name="WordPress.WP.I18n" />
<exclude name="WordPress.Files.FileName.InvalidClassFileName" />
<exclude name="WordPress.DB.DirectDatabaseQuery.NoCaching" />
<exclude name="Universal.ControlStructures.DisallowAlternativeSyntax.FoundIfWithInlineHTML" />
<exclude name="Universal.ControlStructures.DisallowAlternativeSyntax.FoundForeachWithInlineHTML" />
<exclude name="Universal.ControlStructures.DisallowAlternativeSyntax.FoundIf" />
<exclude name="Universal.ControlStructures.IfElseDeclaration.NoNewLine" />
<exclude name="Universal.Classes.RequireFinalClass.NonFinalClassFound" />
<exclude name="Universal.Namespaces.EnforceCurlyBraceSyntax.Forbidden" />
<exclude name="Generic.Commenting.Todo" />
<exclude name="Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition" />
<exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch" />
<exclude name="Generic.WhiteSpace.DisallowSpaceIndent" />
<exclude name="WordPress.WP.CapitalPDangit.Misspelled" />
</rule>
<rule ref="Generic.WhiteSpace.ScopeIndent">
<properties>
<property name="indent" value="4"/>
<property name="tabIndent" value="false"/>
</properties>
</rule>
<rule ref="Generic.WhiteSpace.DisallowTabIndent" />
<rule ref="Generic.Formatting.MultipleStatementAlignment">
<properties>
<property name="maxPadding" value="1" />
<property name="error" value="false" />
</properties>
</rule>
</ruleset>

25
phpstan.neon Normal file
View File

@@ -0,0 +1,25 @@
parameters:
level: 5
paths:
- includes
- admin
- wp-plugin-starter-template.php
excludePaths:
paths:
- vendor
- node_modules
- tests
- bin
- build
- dist
ignoreErrors:
- '#Function apply_filters invoked with [0-9]+ parameters, 2 required.#'
- '#Function [a-zA-Z0-9_]+ not found.#'
- '#Call to static method [a-zA-Z0-9_:()]+ on an unknown class [a-zA-Z0-9_]+.#'
- '#Function do_action invoked with [0-9]+ parameters, 1 required.#'
- '#Function add_action invoked with [0-9]+ parameters, 2 required.#'
- '#Function add_filter invoked with [0-9]+ parameters, 2 required.#'
reportUnmatchedIgnoredErrors: false
includes:
- vendor/szepeviktor/phpstan-wordpress/extension.neon

2
wp-plugin-starter-template.php
View File

@@ -28,7 +28,7 @@
// If this file is called directly, abort.
if ( ! defined( 'WPINC' ) ) {
die;
die;
}
// Load the main plugin class.