Compare commits
26 Commits
Author | SHA1 | Date | |
---|---|---|---|
a3c675c617 | |||
eb711db17d | |||
81ca661b75 | |||
9afa732c20 | |||
0c194d9e23 | |||
d78b2c3d52 | |||
f2e24df164 | |||
100d210f7e | |||
caa9207374 | |||
1fa143b4aa | |||
b02151ac2e | |||
e3960f8514 | |||
f4e09e0287 | |||
dfda9ff8e5 | |||
fdf2860c10 | |||
3b7f4e49a4 | |||
f0c940bf49 | |||
0a6279a508 | |||
ef3108113e | |||
65f784a461 | |||
e4c70b5711 | |||
5fedd333e9 | |||
c73964888b | |||
c5d3c7672c | |||
e1da072640 | |||
f447811b49 |
282
.ai-assistant.md
282
.ai-assistant.md
@ -2,24 +2,13 @@
|
||||
|
||||
This guide helps AI assistants understand the project structure, workflows, and best practices for this repository.
|
||||
|
||||
## AI IDE Configuration
|
||||
## IMPORTANT: Repository Context
|
||||
|
||||
This repository includes configuration files for various AI-powered development tools:
|
||||
This workspace may contain multiple repository folders. Always focus ONLY on the current repository you're working in and avoid hallucinating functionality from other repositories in the workspace.
|
||||
|
||||
- `.aiconfig` - General AI configuration (model preferences, ignore patterns)
|
||||
- `.augmentignore` - Ignore patterns for Augment
|
||||
- `.cursorignore` - Ignore patterns for Cursor
|
||||
- `.v0ignore` - Ignore patterns for v0
|
||||
- `.windsurfignore` - Ignore patterns for Windsurf
|
||||
- `.clinerc` - Configuration for Cline
|
||||
- `.rooignore` - Ignore patterns for Roo
|
||||
- `.geminiignore` - Ignore patterns for Gemini Code Assist
|
||||
- `.loveablerc` - Configuration for Loveable
|
||||
- `.boltignore` - Ignore patterns for Bolt
|
||||
- `.codyignore` - Ignore patterns for Cody
|
||||
- `.continuerc` - Configuration for Continue
|
||||
|
||||
All these files respect `.gitignore` patterns and only include additional tool-specific patterns. The `!` prefix can be used in these files to include files that are excluded by `.gitignore`.
|
||||
- **Current Repository**: wp-fix-plugin-does-not-exist-notices
|
||||
- **Repository Purpose**: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references
|
||||
- **Repository Scope**: All code changes, documentation, and functionality discussions should be limited to THIS repository only
|
||||
|
||||
## Project Overview
|
||||
|
||||
@ -29,127 +18,65 @@ All these files respect `.gitignore` patterns and only include additional tool-s
|
||||
|
||||
This plugin helps users clean up references to deleted plugins that cause "Plugin file does not exist" errors in the WordPress admin. It adds missing plugins to the plugins list with a "Remove Notice" link to safely remove invalid plugin entries.
|
||||
|
||||
## Reference Plugins
|
||||
## AI Workflows
|
||||
|
||||
The `reference-plugins/` directory contains plugins that can be used for reference or inspiration. When developing new features or improving existing ones, you should:
|
||||
Detailed workflow documentation is available in the `.ai-workflows/` directory:
|
||||
|
||||
1. Examine these reference plugins for best practices in code structure, organization, and implementation
|
||||
2. Look for patterns in how they handle similar functionality
|
||||
3. Consider their approach to user interface design and user experience
|
||||
4. Study their documentation style and thoroughness
|
||||
|
||||
These plugins are not part of the codebase and are ignored by Git, but they provide valuable examples of WordPress plugin development standards and techniques.
|
||||
- **@.ai-workflows/bug-fixing.md**: Guidelines for identifying and fixing bugs
|
||||
- **@.ai-workflows/code-review.md**: Standards for reviewing code changes
|
||||
- **@.ai-workflows/dev-prefs-memory.md**: Persistent memory of developer preferences
|
||||
- **@.ai-workflows/feature-development.md**: Process for developing new features
|
||||
- **@.ai-workflows/folder-structure.md**: Documentation of the plugin's folder structure and naming conventions
|
||||
- **@.ai-workflows/git-workflow.md**: Detailed git workflow and branch management guidelines
|
||||
- **@.ai-workflows/incremental-development.md**: Time-efficient approach for incremental development and testing
|
||||
- **@.ai-workflows/local-env-vars.md**: Local development environment paths and URLs
|
||||
- **@.ai-workflows/release-process.md**: Steps for preparing and publishing releases
|
||||
|
||||
## Version Management
|
||||
|
||||
### Version Numbering Convention
|
||||
|
||||
We follow [Semantic Versioning](https://semver.org/):
|
||||
- **MAJOR.MINOR.PATCH** (e.g., 1.6.0)
|
||||
- **MAJOR.MINOR.PATCH** (e.g., 2.2.2)
|
||||
- **MAJOR**: Breaking changes
|
||||
- **MINOR**: New features, non-breaking
|
||||
- **PATCH**: Bug fixes, non-breaking
|
||||
|
||||
### When to Increment Version Numbers
|
||||
### Time-Efficient Development Workflow
|
||||
|
||||
- **PATCH** (1.6.0 → 1.6.1):
|
||||
- Bug fixes
|
||||
- Small text changes
|
||||
- Minor improvements that don't add new features
|
||||
For efficient development and testing:
|
||||
- Create descriptive branches (**fix/**, **feature/**, **patch/**, **refactor/**) without version numbers
|
||||
- **Don't update version numbers** during initial development and testing
|
||||
- Only create **version branches** (v2.2.3) and update version numbers when changes are confirmed working
|
||||
- Use **patch** increments for bug fixes, **minor** for features, and **major** for breaking changes
|
||||
- Mark versions as **stable** when confirmed working by the user
|
||||
- See **@.ai-workflows/incremental-development.md** for detailed guidelines
|
||||
|
||||
- **MINOR** (1.6.0 → 1.7.0):
|
||||
- New features
|
||||
- Significant improvements to existing functionality
|
||||
- Deprecation of features (but not removal)
|
||||
When updating version numbers, see **@.ai-workflows/release-process.md** for the complete checklist.
|
||||
|
||||
- **MAJOR** (1.6.0 → 2.0.0):
|
||||
- Breaking changes
|
||||
- Removal of features
|
||||
- Major architectural changes
|
||||
|
||||
### Version Update Checklist
|
||||
|
||||
When updating the version number, always update these files:
|
||||
1. `wp-fix-plugin-does-not-exist-notices.php` (Plugin header)
|
||||
2. `CHANGELOG.md` (Add new version section)
|
||||
3. `readme.txt` (Stable tag and Changelog section)
|
||||
4. `README.md` (Update Changelog section to match readme.txt)
|
||||
5. Update `FPDEN_VERSION` constant in the main plugin file
|
||||
6. Update `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version and POT-Creation-Date)
|
||||
|
||||
**IMPORTANT**: Always ensure README.md is kept in sync with readme.txt for consistency across platforms.
|
||||
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, and CHANGELOG.md in sync to avoid confusion. All three files must be updated with the same changes for each release.
|
||||
|
||||
## Git Workflow
|
||||
|
||||
### Branch Naming Convention
|
||||
Detailed git workflow documentation is available in **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### Key Principles
|
||||
- Always pull the latest main branch from origin before creating new branches (mandatory step)
|
||||
- Create one branch per issue/feature (fix/patch/feature)
|
||||
- Submit one pull/merge request per issue
|
||||
- Run CI/CD checks for each pull request
|
||||
- Create separate branches for suggested improvements outside the current issue
|
||||
|
||||
### Branch Naming Convention
|
||||
- Feature branches: `feature/descriptive-name`
|
||||
- Bug fix branches: `fix/issue-description`
|
||||
- Bug fix branches: `fix/issue-description` or `fix/issue-number-description`
|
||||
- Patch branches: `patch/descriptive-name`
|
||||
- Release branches: `v{MAJOR}.{MINOR}.{PATCH}`
|
||||
|
||||
### Commit Message Guidelines
|
||||
|
||||
- Use present tense ("Add feature" not "Added feature")
|
||||
- Start with a verb
|
||||
- Keep the first line under 50 characters
|
||||
- Reference issues when relevant: "Fix #123: Resolve plugin detection issue"
|
||||
|
||||
### Pre-Release Checklist
|
||||
|
||||
Before creating a new release, verify the following:
|
||||
|
||||
- [ ] Determine the correct version increment (MAJOR, MINOR, or PATCH) based on the changes
|
||||
- [ ] Ensure all changes are documented in CHANGELOG.md
|
||||
- [ ] Verify all code changes are tested and working correctly
|
||||
- [ ] Check that all files are properly formatted and follow WordPress coding standards
|
||||
- [ ] Ensure Git Updater configuration is correct (if applicable)
|
||||
|
||||
### Release Process
|
||||
|
||||
1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}`
|
||||
2. Update version numbers in ALL required files:
|
||||
- `wp-fix-plugin-does-not-exist-notices.php` (Plugin header)
|
||||
- `FPDEN_VERSION` constant in the main plugin file
|
||||
- `readme.txt` (Stable tag)
|
||||
- `README.md` (Ensure changelog is updated)
|
||||
- `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version)
|
||||
- Any other files that reference the version number
|
||||
3. Update CHANGELOG.md with all changes
|
||||
4. Update readme.txt changelog section
|
||||
5. Update README.md changelog section to match readme.txt
|
||||
6. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"`
|
||||
7. Test changes locally on the version branch
|
||||
8. When satisfied with testing, merge to main:
|
||||
```
|
||||
git checkout main
|
||||
git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff
|
||||
```
|
||||
9. Push main to all remotes:
|
||||
```
|
||||
git push github main
|
||||
git push gitea main
|
||||
```
|
||||
10. Create and push a tag to trigger the GitHub Actions workflow:
|
||||
```
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
|
||||
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
11. Verify the GitHub Actions workflow completes successfully
|
||||
|
||||
## Build Process
|
||||
|
||||
The build process is handled by `build.sh`:
|
||||
1. Updates version numbers
|
||||
2. Installs composer dependencies
|
||||
3. Copies files to build directory
|
||||
4. Creates ZIP file
|
||||
|
||||
To manually build the plugin:
|
||||
```
|
||||
./build.sh {MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
## Remote Repositories
|
||||
|
||||
The plugin is hosted on multiple repositories:
|
||||
@ -159,13 +86,15 @@ The plugin is hosted on multiple repositories:
|
||||
|
||||
Always push changes to all remotes to keep them in sync.
|
||||
|
||||
## GitHub Actions
|
||||
## Git Updater Integration
|
||||
|
||||
The repository uses GitHub Actions for automated builds and deployments:
|
||||
- Triggered by tags matching the pattern `v*`
|
||||
- Builds the plugin
|
||||
- Creates a GitHub release
|
||||
- Deploys to WordPress.org
|
||||
The plugin integrates with Git Updater to allow updates directly from GitHub or Gitea. Important notes:
|
||||
|
||||
1. Git Updater reads version information from the readme.txt file in the main branch, not from tags or releases
|
||||
2. Always merge release changes to the main branch immediately after creating a tag
|
||||
3. The plugin includes proper headers for Git Updater in the main plugin file
|
||||
|
||||
See **@.ai-workflows/release-process.md** for detailed Git Updater integration steps.
|
||||
|
||||
## Testing Guidelines
|
||||
|
||||
@ -175,119 +104,34 @@ Before releasing:
|
||||
3. Verify all features work as expected
|
||||
4. Check for any PHP warnings or notices
|
||||
|
||||
### Local Testing Environment
|
||||
Local environment variables and paths are documented in **@.ai-workflows/local-env-vars.md**.
|
||||
|
||||
Local environment variables and paths are documented in `.ai-workflows/local-env-vars.md`. This includes:
|
||||
## Developer Preferences
|
||||
|
||||
- Repository paths
|
||||
- Local WordPress testing environment paths
|
||||
- URLs for testing and development tools
|
||||
- Build and deploy script locations
|
||||
AI assistants should maintain a record of developer preferences in **@.ai-workflows/dev-prefs-memory.md**. When you learn about a new preference through user feedback or conversation:
|
||||
|
||||
Refer to this file for the most up-to-date information about the local development environment.
|
||||
1. Check if the preference is already documented
|
||||
2. If not, add it to the appropriate section in the dev-prefs-memory.md file
|
||||
3. Reference these preferences in future interactions
|
||||
|
||||
### Using WP-CLI with LocalWP
|
||||
This ensures consistency across coding sessions and reduces the need for developers to repeatedly explain their preferences.
|
||||
|
||||
WP-CLI can be used with LocalWP for various tasks:
|
||||
## Avoiding Cross-Repository Confusion
|
||||
|
||||
```bash
|
||||
# Navigate to the WordPress directory
|
||||
cd ~/Local/plugin-testing/app/public
|
||||
When working in a multi-repository workspace, follow these guidelines to avoid confusion:
|
||||
|
||||
# Run WP-CLI commands
|
||||
~/Local/plugin-testing/app/bin/wp plugin list
|
||||
~/Local/plugin-testing/app/bin/wp transient delete --all
|
||||
~/Local/plugin-testing/app/bin/wp cache flush
|
||||
```
|
||||
1. **Verify Repository Context**: Always check which repository you're currently working in before making any changes or recommendations.
|
||||
|
||||
## Common Tasks for AI Assistants
|
||||
2. **Limit Code Search Scope**: When searching for code or functionality, explicitly limit your search to the current repository.
|
||||
|
||||
### Creating a New Release
|
||||
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.
|
||||
|
||||
```
|
||||
# 1. Create a new branch
|
||||
git checkout main
|
||||
git checkout -b v1.7.0
|
||||
4. **Repository-Specific Documentation**: Documentation should only reflect the actual features and functionality of the current repository.
|
||||
|
||||
# 2. Update version numbers in ALL required files
|
||||
# - wp-fix-plugin-does-not-exist-notices.php
|
||||
# - CHANGELOG.md
|
||||
# - readme.txt
|
||||
# - README.md
|
||||
# - languages/wp-fix-plugin-does-not-exist-notices.pot
|
||||
# - FPDEN_VERSION constant
|
||||
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.
|
||||
|
||||
# 3. Commit changes
|
||||
git add .
|
||||
git commit -m "Prepare release v1.7.0"
|
||||
6. **Verify Before Implementation**: Before implementing or documenting a feature, verify that it actually exists in the current repository by checking the codebase.
|
||||
|
||||
# 4. Test changes locally on the version branch
|
||||
# (Run tests, verify functionality)
|
||||
## Common Tasks
|
||||
|
||||
# 5. Merge to main when ready
|
||||
git checkout main
|
||||
git merge v1.7.0 --no-ff
|
||||
|
||||
# 6. Push main to remotes
|
||||
git push github main
|
||||
git push gitea main
|
||||
|
||||
# 7. Create and push tag
|
||||
git tag -a v1.7.0 -m "Release version 1.7.0"
|
||||
git push github refs/tags/v1.7.0
|
||||
git push gitea refs/tags/v1.7.0
|
||||
```
|
||||
|
||||
### Adding a New Feature
|
||||
|
||||
```
|
||||
# 1. Create feature branch from main
|
||||
git checkout main
|
||||
git checkout -b feature/new-feature-name
|
||||
|
||||
# 2. Make changes and commit
|
||||
git add .
|
||||
git commit -m "Add new feature"
|
||||
|
||||
# 3. Test locally
|
||||
# (Run tests, verify functionality)
|
||||
|
||||
# 4. When ready for release, merge to a version branch
|
||||
git checkout -b v1.7.0
|
||||
git merge feature/new-feature-name --no-ff
|
||||
|
||||
# 5. Continue with the release process
|
||||
# (Update version numbers, etc.)
|
||||
```
|
||||
|
||||
### Fixing a Bug
|
||||
|
||||
```
|
||||
# 1. Create bugfix branch from main
|
||||
git checkout main
|
||||
git checkout -b fix/bug-description
|
||||
|
||||
# 2. Make changes and commit
|
||||
git add .
|
||||
git commit -m "Fix #123: Fix bug description"
|
||||
|
||||
# 3. Test locally
|
||||
# (Run tests, verify functionality)
|
||||
|
||||
# 4. When ready for release, merge to a version branch
|
||||
git checkout -b v1.6.5
|
||||
git merge fix/bug-description --no-ff
|
||||
|
||||
# 5. Continue with the release process
|
||||
# (Update version numbers, etc.)
|
||||
```
|
||||
|
||||
### Testing a Previous Version
|
||||
|
||||
```
|
||||
# Checkout a specific tag for testing
|
||||
git checkout v1.6.3
|
||||
|
||||
# Or create a test branch from a specific tag
|
||||
git checkout v1.6.3 -b test/some-feature
|
||||
```
|
||||
For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see **@.ai-workflows/release-process.md**.
|
||||
|
@ -1,12 +0,0 @@
|
||||
# AI Workflows
|
||||
|
||||
This directory contains workflow documentation for AI assistants working with this repository.
|
||||
|
||||
## Contents
|
||||
|
||||
- **bug-fixing.md**: Guidelines for identifying and fixing bugs in the codebase
|
||||
- **code-review.md**: Standards and procedures for reviewing code changes
|
||||
- **feature-development.md**: Process for developing new features
|
||||
- **release-process.md**: Steps for preparing and publishing new releases
|
||||
|
||||
These documents help ensure consistent quality and approach when using AI tools to assist with development tasks.
|
@ -6,15 +6,17 @@ This document provides guidance for AI assistants to help with bug fixing for th
|
||||
|
||||
### 1. Create a Bug Fix Branch
|
||||
|
||||
Always start by creating a bug fix branch from the main branch:
|
||||
Always start by creating a bug fix branch from the latest main branch pulled from origin (this step is mandatory):
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull github main
|
||||
git pull origin main # Critical step - never skip this
|
||||
git checkout -b fix/bug-description
|
||||
```
|
||||
|
||||
Use a descriptive name that clearly indicates what bug is being fixed.
|
||||
Use a descriptive name that clearly indicates what bug is being fixed. If there's an issue number, include it in the branch name (e.g., `fix/123-plugin-activation-error`).
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### 2. Understand the Bug
|
||||
|
||||
@ -99,13 +101,18 @@ If the repository uses pull requests for code review, create a pull request from
|
||||
|
||||
## Determining Version Increment
|
||||
|
||||
After fixing a bug, determine the appropriate version increment:
|
||||
After fixing a bug and confirming it works, determine the appropriate version increment:
|
||||
|
||||
- **PATCH** (e.g., 1.6.0 → 1.6.1): For most bug fixes that don't change functionality
|
||||
- **IMPORTANT**: Always increment the patch version for every change, even small ones, to make rollbacks easier if issues are found in testing
|
||||
- **MINOR** (e.g., 1.6.0 → 1.7.0): For bug fixes that introduce new features or significant changes
|
||||
- **MAJOR** (e.g., 1.6.0 → 2.0.0): For bug fixes that introduce breaking changes
|
||||
|
||||
**IMPORTANT**: Don't update version numbers during initial development and testing. Only create a version branch (e.g., `v2.2.3`) and update version numbers when the fix is confirmed working.
|
||||
|
||||
This approach is more time-efficient as it allows you to focus on fixing the bug without worrying about version updates until the fix is confirmed working.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
|
||||
## Testing Previous Versions
|
||||
|
||||
To test a previous version of the plugin:
|
||||
|
62
.ai-workflows/dev-prefs-memory.md
Normal file
62
.ai-workflows/dev-prefs-memory.md
Normal file
@ -0,0 +1,62 @@
|
||||
# Developer Preferences Memory
|
||||
|
||||
This document serves as a persistent memory for developer preferences established during coding sessions. AI assistants should refer to this document to understand the developer's preferences and update it as new preferences are established.
|
||||
|
||||
## Purpose
|
||||
|
||||
- Maintain a consistent record of developer preferences across coding sessions
|
||||
- Ensure AI assistants can provide assistance that aligns with the developer's preferred coding style and practices
|
||||
- Reduce the need for developers to repeatedly explain their preferences
|
||||
|
||||
## How to Use This Document
|
||||
|
||||
- **AI Assistants**: Review this document before providing assistance. Update it when new preferences are established through user feedback.
|
||||
- **Developers**: Reference this document to see what preferences have been recorded. Feel free to edit it directly to add or modify preferences.
|
||||
|
||||
## Recorded Preferences
|
||||
|
||||
### File and Directory Structure
|
||||
|
||||
- Prefer lowercase filenames for consistency across the codebase
|
||||
- Use unique folder names following best practices
|
||||
- Folder references should be easily identifiable when using @mentions in AI-assisted coding
|
||||
- Admin-specific functionality should be in the `admin/lib/` directory
|
||||
- Core plugin functionality should be in the `includes/` directory
|
||||
|
||||
### Code Style
|
||||
|
||||
- Follow WordPress coding standards
|
||||
- Use OOP best practices for WordPress plugins
|
||||
- Create modular, maintainable, and efficient code structure
|
||||
|
||||
### Documentation
|
||||
|
||||
- Prefer token-efficient documentation in `.ai-assistant.md` that references `.ai-workflows/` files
|
||||
- Document the release workflow in `.ai-assistant.md` and `.ai-workflows/release-process.md`
|
||||
- Store environment variable documentation in `.ai-workflows/local-env-vars.md`
|
||||
- Maintain consistent documentation across readme.txt, README.md, and CHANGELOG.md
|
||||
|
||||
### Asset Organization
|
||||
|
||||
- Store banner, icon, and screenshot images in `.wordpress-org/assets/`
|
||||
- Store WORDPRESS_ORG files within `/wordpress-org`
|
||||
- Organize files in `/assets` into relevant `/admin` folders
|
||||
|
||||
### Version Control
|
||||
|
||||
- Use standard Git practices for version control and code management
|
||||
- When updating plugin versions, create a GitHub tag and trigger GitHub actions
|
||||
- Follow a specific release process with proper tagging and GitHub releases
|
||||
- Ensure commits are merged to the main branch as Git Updater pulls data from the readme.txt file in the primary branch
|
||||
|
||||
### Plugin Development
|
||||
|
||||
- Prefer simpler solutions over complex ones for plugins
|
||||
- Use a specific formatting style for the CHANGELOG.md file, using #### for section headings
|
||||
- When updating plugin versions, remember to update language files (POT/PO)
|
||||
- Comment out redundant code during testing
|
||||
|
||||
### Potential AI Assised IDE Issues
|
||||
|
||||
- Check for non-standard local terminal commandline customisations that might not be understood by the AI IDE in its terminal useage and cause errors in execution or confusion in not seeing expected results, and advise on how to resolve
|
||||
- Check for non-standard or multiple python and node.js versions, including homebrew versions, that might not be understood by the AI IDE in its terminal useage and cause errors in execution or confusion in not seeing expected results, and advise on how to resolve
|
@ -6,15 +6,17 @@ This document provides guidance for AI assistants to help with feature developme
|
||||
|
||||
### 1. Create a Feature Branch
|
||||
|
||||
Always start by creating a feature branch from the main branch:
|
||||
Always start by creating a feature branch from the latest main branch pulled from origin (this step is mandatory):
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull github main
|
||||
git pull origin main # Critical step - never skip this
|
||||
git checkout -b feature/descriptive-name
|
||||
```
|
||||
|
||||
Use a descriptive name that clearly indicates what the feature is about.
|
||||
Use a descriptive name that clearly indicates what the feature is about. If there's an issue number, include it in the branch name (e.g., `feature/123-update-source-selector`).
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### 2. Implement the Feature
|
||||
|
||||
@ -33,9 +35,17 @@ Update relevant documentation to reflect the new feature:
|
||||
|
||||
- Add a description to CHANGELOG.md under an "Unreleased" section
|
||||
- Update readme.txt if the feature affects user-facing functionality
|
||||
- Update README.md with the new feature description
|
||||
- Update inline documentation/comments
|
||||
- Update wiki documentation in the `.wiki` directory:
|
||||
- Create or update feature-specific pages
|
||||
- Update the Home.md page if necessary
|
||||
- Add the feature to any relevant existing pages
|
||||
- Add screenshots or examples if applicable
|
||||
- Remember that any feature addition will require a version increment in all relevant files
|
||||
|
||||
For detailed guidelines on maintaining wiki documentation, see **@.ai-workflows/wiki-documentation.md**.
|
||||
|
||||
### 4. Testing
|
||||
|
||||
Test the feature thoroughly:
|
||||
@ -58,21 +68,39 @@ git commit -m "Add feature: descriptive name"
|
||||
|
||||
When the feature is ready to be released:
|
||||
|
||||
1. Create a version branch for the release:
|
||||
1. Create a version branch with the appropriate version number (typically increment the minor version for features):
|
||||
|
||||
```bash
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
# Example: from 2.2.0 to 2.3.0
|
||||
git checkout -b v{MAJOR}.{MINOR+1}.0
|
||||
```
|
||||
|
||||
2. Merge your feature branch into the version branch:
|
||||
2. Now update version numbers in all required files:
|
||||
|
||||
- Main plugin file (wp-fix-plugin-does-not-exist-notices.php)
|
||||
- CHANGELOG.md (add a new version section)
|
||||
- readme.txt
|
||||
- README.md
|
||||
- languages/wp-fix-plugin-does-not-exist-notices.pot (Project-Id-Version)
|
||||
|
||||
3. Commit the version updates:
|
||||
|
||||
```bash
|
||||
git merge feature/descriptive-name --no-ff
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR+1}.0 - [brief description]"
|
||||
```
|
||||
|
||||
3. Update version numbers and changelog entries
|
||||
4. Tag the version as stable:
|
||||
|
||||
4. Follow the standard release process from this point
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR+1}.0-stable -m "Stable version {MAJOR}.{MINOR+1}.0"
|
||||
```
|
||||
|
||||
5. Follow the standard release process from this point
|
||||
|
||||
**IMPORTANT**: Don't update version numbers during initial development and testing. Only create a version branch and update version numbers when the feature is confirmed working.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
|
||||
### 7. Push to Remote (Optional for Collaboration)
|
||||
|
||||
@ -122,6 +150,31 @@ If the repository uses pull requests for code review, create a pull request from
|
||||
- Use nonces for form submissions
|
||||
- Use capability checks for user actions
|
||||
|
||||
## Working in Multi-Repository Workspaces
|
||||
|
||||
When developing features in a workspace with multiple repositories:
|
||||
|
||||
1. **Verify Repository Context**:
|
||||
- Confirm you're working in the correct repository before suggesting or implementing features
|
||||
- Use `pwd` and `git remote -v` to verify the current repository
|
||||
|
||||
2. **Feature Verification**:
|
||||
- Before implementing a feature, verify it doesn't already exist in the current repository
|
||||
- Don't assume features from other repositories should be implemented in this one
|
||||
- Use `codebase-retrieval` to search for existing functionality
|
||||
|
||||
3. **Repository-Specific Implementation**:
|
||||
- Implement features appropriate for this specific plugin's purpose
|
||||
- Maintain consistency with the current repository's architecture and coding style
|
||||
- Don't copy code directly from other repositories without adaptation
|
||||
|
||||
4. **Cross-Repository Inspiration**:
|
||||
- If implementing a feature inspired by another repository, explicitly note that it's a new feature
|
||||
- Adapt the feature to fit the current repository's needs and architecture
|
||||
- Document the inspiration source in code comments
|
||||
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.ai-workflows/multi-repo-workspace.md**.
|
||||
|
||||
## Feature Types and Implementation Guidelines
|
||||
|
||||
### Admin Interface Features
|
||||
|
59
.ai-workflows/folder-structure.md
Normal file
59
.ai-workflows/folder-structure.md
Normal file
@ -0,0 +1,59 @@
|
||||
# Folder Structure
|
||||
|
||||
This document outlines the folder structure of the plugin and explains the purpose of each directory.
|
||||
|
||||
## Root Directories
|
||||
|
||||
- **admin/** - Contains admin-specific functionality and assets
|
||||
- **includes/** - Contains core plugin functionality and classes
|
||||
- **languages/** - Contains translation files
|
||||
- **scripts/** - Contains build and deployment scripts
|
||||
- **.ai-workflows/** - Contains documentation for AI assistants
|
||||
- **.github/** - Contains GitHub-specific files like workflows
|
||||
- **.wordpress-org/** - Contains WordPress.org assets like banners and screenshots
|
||||
|
||||
## Admin Directory Structure
|
||||
|
||||
- **admin/css/** - Admin-specific CSS files
|
||||
- **admin/js/** - Admin-specific JavaScript files
|
||||
- **admin/images/** - Admin-specific images
|
||||
- **admin/partials/** - Admin-specific template partials
|
||||
- **admin/settings/** - Admin settings functionality
|
||||
- **admin/tools/** - Admin tools functionality
|
||||
- **admin/lib/** - Admin-specific library files and helper functions
|
||||
- **admin/lib/admin.php** - Admin class for handling admin-specific functionality
|
||||
- **admin/lib/modal.php** - Modal class for handling the update source selector modal
|
||||
|
||||
## Includes Directory
|
||||
|
||||
The `includes/` directory contains the core plugin functionality:
|
||||
|
||||
- **includes/core.php** - Core class for handling the main plugin functionality
|
||||
- **includes/plugin.php** - Main plugin class that initializes all components
|
||||
- **includes/updater.php** - Updater class for handling plugin updates
|
||||
|
||||
## File Naming Conventions
|
||||
|
||||
- All PHP files in the `includes/` directory use lowercase filenames
|
||||
- All directories use lowercase names
|
||||
- JavaScript and CSS files use kebab-case (e.g., `update-source-selector.js`)
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Unique Directory Names**: Each directory should have a unique name to avoid confusion
|
||||
2. **Logical Organization**: Files should be organized logically by function
|
||||
3. **Consistent Naming**: File and directory names should follow consistent naming conventions
|
||||
4. **Clear Separation**: Admin functionality should be separate from core functionality
|
||||
5. **Minimal Dependencies**: Files should have minimal dependencies on other files
|
||||
|
||||
## @mentions for AI Assistants
|
||||
|
||||
When referring to files or directories in AI conversations, use the following format:
|
||||
|
||||
- **@includes/plugin.php** - Main plugin class
|
||||
- **@includes/core.php** - Core functionality
|
||||
- **@admin/lib/admin.php** - Admin functionality
|
||||
- **@admin/lib/modal.php** - Modal functionality
|
||||
- **@includes/updater.php** - Updater functionality
|
||||
- **@admin/js/update-source-selector.js** - Update source selector JavaScript
|
||||
- **@admin/css/update-source-selector.css** - Update source selector CSS
|
255
.ai-workflows/git-workflow.md
Normal file
255
.ai-workflows/git-workflow.md
Normal file
@ -0,0 +1,255 @@
|
||||
# Git Workflow Guide for AI Assistants
|
||||
|
||||
This document provides guidance for AI assistants to help with git workflow management for the Fix Plugin Does Not Exist Notices plugin.
|
||||
|
||||
## Core Git Workflow Principles
|
||||
|
||||
### 1. Always Start from Latest Main Branch
|
||||
|
||||
Before creating any new branch, always ensure you're working with the latest code from the main branch by pulling from the origin:
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
This critical step ensures that your new branch includes all the latest changes from the remote repository and reduces the chance of merge conflicts later. Never skip this step, as working from an outdated main branch can lead to integration problems.
|
||||
|
||||
### 2. One Issue Per Branch
|
||||
|
||||
Create a separate branch for each issue or feature you're working on:
|
||||
|
||||
- For bug fixes: `fix/issue-description` or `fix/issue-number-description`
|
||||
- For features: `feature/descriptive-name`
|
||||
- For small improvements: `patch/descriptive-name`
|
||||
- For code restructuring: `refactor/descriptive-name`
|
||||
|
||||
**Important**: Use descriptive names without version numbers for development branches. This allows focusing on the changes without worrying about version updates until the changes are confirmed working.
|
||||
|
||||
Only create version branches (e.g., `v2.2.3`) when changes are ready for release, and only then update version numbers in files.
|
||||
|
||||
This approach keeps changes focused, makes code review easier, and provides clear rollback points if needed.
|
||||
|
||||
### 3. Pull Request for Each Issue
|
||||
|
||||
Create a separate pull request for each issue or feature. This ensures:
|
||||
|
||||
- Each change can be reviewed independently
|
||||
- Issues can be merged as soon as they're ready
|
||||
- Changes can be reverted individually if needed
|
||||
- CI/CD checks can run on focused changes
|
||||
|
||||
## Detailed Workflow
|
||||
|
||||
### Starting a New Task
|
||||
|
||||
1. **Update Main Branch from Origin**
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
This step is mandatory before creating any new branch to ensure you're working with the latest code.
|
||||
|
||||
2. **Create a New Branch**
|
||||
```bash
|
||||
git checkout -b [branch-type]/[description]
|
||||
```
|
||||
|
||||
Examples:
|
||||
```bash
|
||||
git checkout -b fix/123-plugin-activation-error
|
||||
git checkout -b feature/update-source-selector
|
||||
git checkout -b patch/2.2.1
|
||||
```
|
||||
|
||||
3. **Make Your Changes**
|
||||
- Make focused changes related only to the specific issue
|
||||
- Commit regularly with clear, descriptive messages
|
||||
- Reference issue numbers in commit messages when applicable
|
||||
|
||||
4. **Testing Approach**
|
||||
|
||||
For efficient development:
|
||||
- **Local Testing (Default)**: Test without updating version numbers
|
||||
```bash
|
||||
# Get current version from plugin file
|
||||
CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notices.php | cut -d' ' -f2)
|
||||
|
||||
# Build and deploy with current version
|
||||
./build.sh $CURRENT_VERSION
|
||||
```
|
||||
- **Remote Testing (When Requested)**: Push development branch to remote
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "[Brief description] for remote testing"
|
||||
git push origin [branch-name]
|
||||
```
|
||||
- **Version Creation**: Only when changes are confirmed working
|
||||
```bash
|
||||
# Create version branch
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
|
||||
# Update version numbers in all required files
|
||||
# Commit version updates
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description"
|
||||
|
||||
# Tag as stable
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
5. **Push Branch to Remote (When Needed)**
|
||||
```bash
|
||||
git push origin [branch-name]
|
||||
```
|
||||
|
||||
### Creating a Pull Request
|
||||
|
||||
1. **Ensure Tests Pass Locally**
|
||||
- Run any available tests to ensure your changes work as expected
|
||||
- Fix any issues before creating a pull request
|
||||
|
||||
2. **Create Pull Request**
|
||||
- Create a pull request from your branch to the main branch
|
||||
- Include a clear description of the changes
|
||||
- Reference any related issues
|
||||
- Assign reviewers if appropriate
|
||||
|
||||
3. **Address Review Feedback**
|
||||
- Make requested changes
|
||||
- Push additional commits to the same branch
|
||||
- Respond to comments
|
||||
|
||||
### CI/CD Integration
|
||||
|
||||
Each pull request should pass through CI/CD checks before being merged. This ensures that all changes are compatible with the existing codebase and meet quality standards.
|
||||
|
||||
1. **Automated Tests**
|
||||
- Unit tests
|
||||
- Integration tests
|
||||
- Code style checks
|
||||
- Compatibility checks
|
||||
|
||||
2. **Manual Review**
|
||||
- Code review by team members
|
||||
- Functional testing in test environment
|
||||
- Verification of feature requirements
|
||||
|
||||
3. **Approval Process**
|
||||
- Required approvals before merging
|
||||
- Final checks for conflicts with other pending PRs
|
||||
- Verification that all CI/CD checks have passed
|
||||
|
||||
4. **Compatibility with Unmerged PRs**
|
||||
- When multiple PRs are in progress simultaneously, ensure each PR is compatible with the main branch
|
||||
- For related changes, consider using feature flags to allow independent merging
|
||||
- Document dependencies between PRs in the PR description
|
||||
|
||||
### Handling Concurrent Development
|
||||
|
||||
When working on multiple issues simultaneously:
|
||||
|
||||
1. **Keep Branches Independent**
|
||||
- Always create new branches from the latest main branch pulled from origin, not from other feature branches
|
||||
- This ensures each PR can be merged independently and contains all the latest changes
|
||||
|
||||
2. **Handle Conflicts Proactively**
|
||||
- If main has been updated with other changes while you're working:
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
git checkout your-branch
|
||||
git merge main
|
||||
```
|
||||
- Resolve any conflicts locally before pushing
|
||||
|
||||
3. **Coordinate on Dependent Changes**
|
||||
- If changes depend on each other, note this in the PR description
|
||||
- Consider using the "Depends on #PR-number" notation in PR descriptions
|
||||
|
||||
## Release Process
|
||||
|
||||
When preparing for a release:
|
||||
|
||||
1. **Ensure All Required PRs are Merged**
|
||||
- All features and fixes planned for the release should be merged to main
|
||||
|
||||
2. **Create a Release Branch**
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
3. **Follow Standard Release Process**
|
||||
- Update version numbers
|
||||
- Update changelogs
|
||||
- Create tag
|
||||
- See **@.ai-workflows/release-process.md** for complete details
|
||||
|
||||
## Contributing to External Repositories
|
||||
|
||||
When working on issues for external repositories (pull/merge requests):
|
||||
|
||||
### 1. Clearly Indicate Testing Status
|
||||
|
||||
In the PR description and comments, clearly indicate the testing status:
|
||||
|
||||
- **Not tested**: "This PR addresses [issue] but has not been tested locally or remotely. It's ready for community/maintainer testing."
|
||||
- **Locally tested**: "This PR has been tested in a local WordPress environment and [describe results]."
|
||||
- **Remotely tested**: "This PR has been tested with a remote build and [describe results]."
|
||||
|
||||
### 2. Provide Testing Instructions
|
||||
|
||||
Include clear instructions for maintainers on how to test the changes:
|
||||
|
||||
- Steps to reproduce the original issue (if applicable)
|
||||
- Steps to verify the fix or feature
|
||||
- Any specific environments or configurations needed for testing
|
||||
|
||||
### 3. Be Responsive to Feedback
|
||||
|
||||
Monitor the PR for feedback from maintainers and be prepared to make additional changes if requested.
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Commit Messages
|
||||
|
||||
- Use present tense ("Add feature" not "Added feature")
|
||||
- Start with a verb
|
||||
- Keep the first line under 50 characters
|
||||
- Reference issues when relevant: "Fix #123: Resolve plugin detection issue"
|
||||
- For more complex changes, add a detailed description after the first line
|
||||
|
||||
### Branch Management
|
||||
|
||||
- Delete branches after they've been merged
|
||||
- Keep branch names descriptive but concise
|
||||
- Use consistent naming conventions
|
||||
|
||||
### Code Review
|
||||
|
||||
- Review code thoroughly before approving
|
||||
- Test changes locally when possible
|
||||
- Provide constructive feedback
|
||||
- See **@.ai-workflows/code-review.md** for detailed code review guidelines
|
||||
|
||||
### Suggested Improvements
|
||||
|
||||
If you identify potential improvements outside the scope of the current issue:
|
||||
|
||||
1. **Document the Suggestion**
|
||||
- Note the suggestion in the PR comments
|
||||
- Create a new issue for the suggestion
|
||||
- Be specific about the benefits and implementation details
|
||||
|
||||
2. **Create a Separate Branch**
|
||||
- Don't include unrelated improvements in the current PR
|
||||
- Create a new branch from the latest main branch for the suggested improvement
|
||||
- Submit a separate PR for the suggestion
|
||||
|
||||
3. **Ensure Compatibility**
|
||||
- Make sure the suggested improvement is compatible with any unmerged PRs
|
||||
- If the improvement depends on changes in another PR, note this dependency
|
||||
- Consider how the improvement will interact with other pending changes
|
225
.ai-workflows/incremental-development.md
Normal file
225
.ai-workflows/incremental-development.md
Normal file
@ -0,0 +1,225 @@
|
||||
# Incremental Development and Testing Guide
|
||||
|
||||
This document provides guidance for AI assistants to help with incremental development and testing for the Fix Plugin Does Not Exist Notices plugin.
|
||||
|
||||
## Time-Efficient Development Principles
|
||||
|
||||
### Branch Naming for Development
|
||||
|
||||
1. **Initial Development Branches**
|
||||
- Use descriptive names without version numbers:
|
||||
- `fix/issue-description` - For bug fixes
|
||||
- `feature/descriptive-name` - For new features
|
||||
- `patch/descriptive-name` - For small improvements
|
||||
- `refactor/descriptive-name` - For code restructuring
|
||||
- **Don't update version numbers** during this phase
|
||||
- Focus on implementing and testing the changes
|
||||
|
||||
2. **Version Branches**
|
||||
- Only create after changes are confirmed working:
|
||||
- `v{MAJOR}.{MINOR}.{PATCH}` (e.g., `v2.2.3`)
|
||||
- Only update version numbers at this point
|
||||
- This minimizes unnecessary version updates
|
||||
|
||||
### Version Numbering Guidelines
|
||||
|
||||
1. **Patch Versions (X.Y.Z → X.Y.Z+1)**
|
||||
- Use for bug fixes and small improvements
|
||||
- Example: `v2.2.3`
|
||||
|
||||
2. **Minor Versions (X.Y.Z → X.Y+1.0)**
|
||||
- Use for new features or significant improvements
|
||||
- Example: `v2.3.0`
|
||||
|
||||
3. **Major Versions (X.Y.Z → X+1.0.0)**
|
||||
- Only increment when numerous features and fixes are tested and confirmed stable
|
||||
- Reserved for breaking changes or significant overhauls
|
||||
- Example: `v3.0.0`
|
||||
|
||||
### Marking Stable Versions
|
||||
|
||||
When the user confirms that changes are working correctly:
|
||||
1. Create a version branch and update version numbers
|
||||
2. Tag the version branch as stable
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
3. Document in the PR or issue that this version has been confirmed stable
|
||||
|
||||
## Local Testing Workflow
|
||||
|
||||
### 1. Create a Descriptive Branch for Development
|
||||
|
||||
```bash
|
||||
# Ensure you have the latest main branch
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# Create a descriptive branch (without version numbers)
|
||||
git checkout -b fix/plugin-activation-error
|
||||
```
|
||||
|
||||
### 2. Make Changes Without Updating Version Numbers
|
||||
|
||||
During the development and testing phase:
|
||||
- Implement the necessary changes
|
||||
- **Don't update version numbers** in any files yet
|
||||
- Focus on the functionality
|
||||
|
||||
### 3. Build and Deploy Locally
|
||||
|
||||
For local testing, use the current version number from the main plugin file:
|
||||
|
||||
```bash
|
||||
# Get the current version from the plugin file
|
||||
CURRENT_VERSION=$(grep -o "Version: [0-9.]*" wp-fix-plugin-does-not-exist-notices.php | cut -d' ' -f2)
|
||||
|
||||
# Build and deploy with current version
|
||||
./build.sh $CURRENT_VERSION
|
||||
```
|
||||
|
||||
This will:
|
||||
1. Create a build directory
|
||||
2. Copy required files to the build directory
|
||||
3. Deploy the plugin to your local WordPress testing environment
|
||||
|
||||
**Note**: For local testing iterations, you do not need to commit changes, push to remote repositories, or create tags unless specifically requested.
|
||||
|
||||
### 4. Test and Evaluate
|
||||
|
||||
Test the changes thoroughly in the local environment:
|
||||
- Verify that the specific issue is fixed or feature works as expected
|
||||
- Check for any regressions or new issues
|
||||
- Document the results
|
||||
|
||||
### 5. Based on Testing Results
|
||||
|
||||
- **If changes need further refinement**: Continue working in the same branch
|
||||
- **If changes work as expected**: Proceed to version branch creation
|
||||
|
||||
### 6. Creating a Version Branch
|
||||
|
||||
When changes are confirmed working and ready for release:
|
||||
|
||||
1. Create a version branch with the appropriate version number:
|
||||
|
||||
```bash
|
||||
# Determine the appropriate version increment (patch, minor, or major)
|
||||
# based on the nature of the changes
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
2. Now update version numbers in all required files:
|
||||
|
||||
- Main plugin file (wp-fix-plugin-does-not-exist-notices.php)
|
||||
- CHANGELOG.md (add a new version section)
|
||||
- readme.txt
|
||||
- README.md
|
||||
- languages/wp-fix-plugin-does-not-exist-notices.pot (Project-Id-Version)
|
||||
|
||||
3. Commit the version updates:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - [brief description]"
|
||||
```
|
||||
|
||||
4. Tag the version as stable:
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
## Remote Testing Workflow
|
||||
|
||||
When the user specifically requests remote testing:
|
||||
|
||||
### 1. Commit Changes to Remote Repository
|
||||
|
||||
If testing a development branch (without version updates):
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "[brief description] for remote testing"
|
||||
git push origin [branch-name]
|
||||
```
|
||||
|
||||
If testing a version branch (with version updates):
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - [brief description]"
|
||||
git push origin v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 2. Create and Push Tag (For Version Branches Only)
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} for remote testing"
|
||||
git push origin v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
This will trigger GitHub Actions to build the installable ZIP file.
|
||||
|
||||
### 3. Verify Remote Build
|
||||
|
||||
Check that the GitHub Actions workflow completed successfully and the ZIP file is available for download.
|
||||
|
||||
### 4. Test and Evaluate
|
||||
|
||||
Test the remotely built version and document the results.
|
||||
|
||||
## Contributing to External Repositories
|
||||
|
||||
When working on issues for external repositories (pull/merge requests):
|
||||
|
||||
### 1. Clearly Indicate Testing Status
|
||||
|
||||
In the PR description and comments, clearly indicate the testing status:
|
||||
|
||||
- **Not tested**: "This PR addresses [issue] but has not been tested locally or remotely. It's ready for community/maintainer testing."
|
||||
- **Locally tested**: "This PR has been tested in a local WordPress environment and [describe results]."
|
||||
- **Remotely tested**: "This PR has been tested with a remote build and [describe results]."
|
||||
|
||||
### 2. Provide Testing Instructions
|
||||
|
||||
Include clear instructions for maintainers on how to test the changes:
|
||||
|
||||
- Steps to reproduce the original issue (if applicable)
|
||||
- Steps to verify the fix or feature
|
||||
- Any specific environments or configurations needed for testing
|
||||
|
||||
### 3. Be Responsive to Feedback
|
||||
|
||||
Monitor the PR for feedback from maintainers and be prepared to make additional changes if requested.
|
||||
|
||||
## Rollback Procedure
|
||||
|
||||
If a change causes issues after release:
|
||||
|
||||
### 1. Identify the Last Stable Version
|
||||
|
||||
Find the last version that was marked as stable:
|
||||
|
||||
```bash
|
||||
git tag -l "*-stable"
|
||||
```
|
||||
|
||||
### 2. Create a New Branch from the Stable Version
|
||||
|
||||
```bash
|
||||
git checkout v{MAJOR}.{MINOR}.{PATCH}-stable
|
||||
git checkout -b fix/rollback-based-fix
|
||||
```
|
||||
|
||||
### 3. Make Necessary Changes
|
||||
|
||||
Implement the fix based on the stable version. Don't update version numbers yet.
|
||||
|
||||
### 4. Test the Changes
|
||||
|
||||
Test thoroughly to ensure the fix resolves the issues.
|
||||
|
||||
### 5. When Confirmed Working
|
||||
|
||||
Create a version branch with an incremented patch version and update all version numbers as described in the "Creating a Version Branch" section.
|
122
.ai-workflows/multi-repo-workspace.md
Normal file
122
.ai-workflows/multi-repo-workspace.md
Normal file
@ -0,0 +1,122 @@
|
||||
# Working in Multi-Repository Workspaces
|
||||
|
||||
This document provides guidelines for AI assistants working in VSCode/VSCodium workspaces that contain multiple repository folders.
|
||||
|
||||
## Understanding Multi-Repository Workspaces
|
||||
|
||||
In VSCode/VSCodium, developers often create workspaces that include multiple repository folders. This allows them to work on related projects simultaneously or reference code from one project while working on another.
|
||||
|
||||
### Common Workspace Configurations
|
||||
|
||||
1. **Multiple WordPress Plugins**: A workspace containing several WordPress plugin repositories
|
||||
2. **Plugin and Theme Combinations**: Repositories for both plugins and themes that work together
|
||||
3. **Reference Repositories**: Including repositories purely for reference or inspiration
|
||||
4. **Shared Libraries**: Repositories containing shared code used across multiple projects
|
||||
|
||||
## Potential Issues in Multi-Repository Workspaces
|
||||
|
||||
### 1. Feature Hallucination
|
||||
|
||||
The most common issue is "feature hallucination" - assuming that features present in one repository should be implemented in another, or documenting non-existent features based on code seen in other repositories.
|
||||
|
||||
### 2. Cross-Repository Code References
|
||||
|
||||
Referencing or suggesting code patterns from one repository when working on another can lead to inconsistent coding styles and approaches.
|
||||
|
||||
### 3. Documentation Confusion
|
||||
|
||||
Creating documentation that includes features or functionality from other repositories in the workspace.
|
||||
|
||||
### 4. Scope Creep
|
||||
|
||||
Suggesting changes or improvements based on other repositories, leading to scope creep and feature bloat.
|
||||
|
||||
## Best Practices for AI Assistants
|
||||
|
||||
### 1. Repository Verification
|
||||
|
||||
**ALWAYS** verify which repository you're currently working in before:
|
||||
- Making code suggestions
|
||||
- Creating or updating documentation
|
||||
- Discussing features or functionality
|
||||
- Implementing new features
|
||||
|
||||
### 2. Explicit Code Search Scoping
|
||||
|
||||
When searching for code or functionality:
|
||||
- Explicitly limit searches to the current repository
|
||||
- Use repository-specific paths in search queries
|
||||
- Verify search results are from the current repository before using them
|
||||
|
||||
### 3. Feature Verification Process
|
||||
|
||||
Before documenting or implementing a feature:
|
||||
|
||||
1. **Check the codebase**: Use the codebase-retrieval tool to search for relevant code in the current repository
|
||||
2. **Verify functionality**: Look for actual implementation, not just references or comments
|
||||
3. **Check documentation**: Review existing documentation to understand intended functionality
|
||||
4. **Ask for clarification**: If uncertain, ask the developer to confirm the feature's existence or scope
|
||||
|
||||
### 4. Documentation Guidelines
|
||||
|
||||
When creating or updating documentation:
|
||||
|
||||
1. **Repository-specific content**: Only document features and functionality that exist in the current repository
|
||||
2. **Verify before documenting**: Check the codebase to confirm features actually exist
|
||||
3. **Clear boundaries**: Make it clear which repository the documentation applies to
|
||||
4. **Accurate feature descriptions**: Describe features as they are implemented, not as they might be in other repositories
|
||||
|
||||
### 5. Cross-Repository Inspiration
|
||||
|
||||
When implementing features inspired by other repositories:
|
||||
|
||||
1. **Explicit attribution**: Clearly state that the feature is inspired by another repository
|
||||
2. **New implementation**: Treat it as a new feature being added, not an existing one
|
||||
3. **Repository-appropriate adaptation**: Adapt the feature to fit the current repository's architecture and style
|
||||
4. **Developer confirmation**: Confirm with the developer that adding the feature is appropriate
|
||||
|
||||
## Repository Context Verification Checklist
|
||||
|
||||
Before making significant changes or recommendations, run through this checklist:
|
||||
|
||||
- [ ] Verified current working directory/repository
|
||||
- [ ] Confirmed repository name and purpose
|
||||
- [ ] Checked that code searches are limited to current repository
|
||||
- [ ] Verified features exist in current repository before documenting them
|
||||
- [ ] Ensured documentation reflects only the current repository's functionality
|
||||
- [ ] Confirmed that any cross-repository inspiration is clearly marked as new functionality
|
||||
|
||||
## Example Verification Workflow
|
||||
|
||||
1. **Check current repository**:
|
||||
```
|
||||
pwd
|
||||
git remote -v
|
||||
```
|
||||
|
||||
2. **Verify feature existence**:
|
||||
```
|
||||
# Use codebase-retrieval to search for the feature
|
||||
# Look for actual implementation, not just references
|
||||
```
|
||||
|
||||
3. **Document with clear repository context**:
|
||||
```
|
||||
# Always include repository name in documentation
|
||||
# Be specific about which features are included
|
||||
```
|
||||
|
||||
4. **When suggesting new features**:
|
||||
```
|
||||
# Clearly state if inspired by another repository
|
||||
# Explain why it's appropriate for the current repository
|
||||
```
|
||||
|
||||
## Handling Repository Switching
|
||||
|
||||
When the developer switches between repositories in the workspace:
|
||||
|
||||
1. **Acknowledge the switch**: Confirm the new repository context
|
||||
2. **Reset context**: Don't carry over assumptions from the previous repository
|
||||
3. **Verify new environment**: Check the structure and features of the new repository
|
||||
4. **Update documentation references**: Ensure you're referencing documentation specific to the new repository
|
19
.ai-workflows/readme.md
Normal file
19
.ai-workflows/readme.md
Normal file
@ -0,0 +1,19 @@
|
||||
# AI Workflows
|
||||
|
||||
This directory contains workflow documentation for AI assistants working with this repository.
|
||||
|
||||
## Contents
|
||||
|
||||
- **bug-fixing.md**: Guidelines for identifying and fixing bugs in the codebase
|
||||
- **code-review.md**: Standards and procedures for reviewing code changes
|
||||
- **dev-prefs-memory.md**: Persistent memory of developer preferences
|
||||
- **feature-development.md**: Process for developing new features
|
||||
- **folder-structure.md**: Documentation of the plugin's folder structure and naming conventions
|
||||
- **git-workflow.md**: Detailed git workflow and branch management guidelines
|
||||
- **incremental-development.md**: Time-efficient approach for incremental development and testing
|
||||
- **local-env-vars.md**: Local development environment paths and URLs
|
||||
- **multi-repo-workspace.md**: Guidelines for working in workspaces with multiple repositories
|
||||
- **release-process.md**: Steps for preparing and publishing new releases
|
||||
- **wiki-documentation.md**: Guidelines for maintaining wiki documentation
|
||||
|
||||
These documents help ensure consistent quality and approach when using AI tools to assist with development tasks.
|
@ -8,6 +8,8 @@ This document provides step-by-step instructions for AI assistants to help with
|
||||
- [ ] All bug fixes for this release are complete
|
||||
- [ ] CHANGELOG.md is up to date
|
||||
- [ ] readme.txt is up to date
|
||||
- [ ] README.md is up to date
|
||||
- [ ] Wiki documentation in the `.wiki` directory is up to date
|
||||
- [ ] All tests pass
|
||||
|
||||
## Determining the New Version Number
|
||||
@ -15,65 +17,121 @@ This document provides step-by-step instructions for AI assistants to help with
|
||||
Based on the changes made, determine the appropriate version increment:
|
||||
|
||||
1. **PATCH** (e.g., 1.6.0 → 1.6.1): For bug fixes and minor improvements
|
||||
- **IMPORTANT**: Always increment the patch version for every change, even small ones, to make rollbacks easier if issues are found in testing
|
||||
2. **MINOR** (e.g., 1.6.0 → 1.7.0): For new features and significant improvements
|
||||
3. **MAJOR** (e.g., 1.6.0 → 2.0.0): For breaking changes
|
||||
- Only increment when numerous features and fixes are tested and confirmed stable
|
||||
|
||||
**IMPORTANT**: For time-efficient development:
|
||||
- Use descriptive branches (`fix/`, `feature/`, `patch/`, `refactor/`) without version numbers during development
|
||||
- Don't update version numbers during initial development and testing
|
||||
- Only create version branches (e.g., `v2.2.3`) and update version numbers when changes are confirmed working
|
||||
|
||||
This approach allows focusing on the changes without worrying about version updates until they're ready for release.
|
||||
|
||||
For detailed guidelines on time-efficient development and testing, see **@.ai-workflows/incremental-development.md**.
|
||||
|
||||
## Release Steps
|
||||
|
||||
### 1. Create a New Branch
|
||||
### 1. Create a Version Branch
|
||||
|
||||
When changes are confirmed working and ready for release:
|
||||
|
||||
```bash
|
||||
# First, ensure you have the latest main branch
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# Option 1: If you're coming from a development branch
|
||||
git checkout fix/your-fix-branch # or feature/your-feature-branch
|
||||
|
||||
# Option 2: Create a version branch directly from main
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
Example:
|
||||
```bash
|
||||
git checkout -b v1.7.0
|
||||
git checkout main
|
||||
git pull origin main
|
||||
|
||||
# If coming from a development branch
|
||||
git checkout feature/add-new-selector
|
||||
|
||||
# Create the version branch
|
||||
git checkout -b v2.3.0
|
||||
```
|
||||
|
||||
**IMPORTANT**: The version branch is where you'll update all version numbers. This should only be done after the changes have been tested and confirmed working.
|
||||
|
||||
For more detailed git workflow guidelines, see **@.ai-workflows/git-workflow.md**.
|
||||
|
||||
### 2. Update Version Numbers
|
||||
|
||||
Update the version number in the following files:
|
||||
|
||||
#### a. Main Plugin File (wp-fix-plugin-does-not-exist-notices.php)
|
||||
|
||||
Update both the plugin header and the version parameter in the Plugin class initialization:
|
||||
|
||||
```php
|
||||
/**
|
||||
* Plugin Name: Fix 'Plugin file does not exist.' Notices
|
||||
* Plugin URI: https://wordpress.org/plugins/fix-plugin-does-not-exist-notices/
|
||||
* Description: Adds missing plugins to the plugins list with a "Remove Reference" link so you can permanently clean up invalid plugin entries and remove error notices.
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references.
|
||||
* Version: {MAJOR}.{MINOR}.{PATCH}
|
||||
* ...
|
||||
*/
|
||||
|
||||
// At the bottom of the file, update the version parameter:
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '{MAJOR}.{MINOR}.{PATCH}');
|
||||
```
|
||||
|
||||
Also update the FPDEN_VERSION constant:
|
||||
#### b. JavaScript Files with Version Constants
|
||||
|
||||
```php
|
||||
define( 'FPDEN_VERSION', '{MAJOR}.{MINOR}.{PATCH}' );
|
||||
Check for any JavaScript files that might contain version constants:
|
||||
|
||||
```javascript
|
||||
// Current plugin version - this should match the version in the main plugin file
|
||||
const CURRENT_VERSION = '{MAJOR}.{MINOR}.{PATCH}';
|
||||
```
|
||||
|
||||
#### b. CHANGELOG.md
|
||||
**Note**: As of version 2.2.1, we've removed redundant JavaScript files like `version-fix.js` since Git Updater now correctly detects the version from the main branch.
|
||||
|
||||
#### c. CHANGELOG.md
|
||||
|
||||
Add a new section at the top of the CHANGELOG.md file:
|
||||
|
||||
```markdown
|
||||
## [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD
|
||||
### Added
|
||||
- New feature 1
|
||||
- New feature 2
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
### Changed
|
||||
#### [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD
|
||||
#### Added/Changed/Fixed
|
||||
- Change 1
|
||||
- Change 2
|
||||
- Change 3
|
||||
|
||||
### Fixed
|
||||
- Bug fix 1
|
||||
- Bug fix 2
|
||||
#### [{PREVIOUS_VERSION}] - YYYY-MM-DD
|
||||
```
|
||||
|
||||
#### c. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot)
|
||||
Note: Use the `####` heading format for consistency with the existing CHANGELOG.md structure.
|
||||
|
||||
#### d. README.md
|
||||
|
||||
Update the Changelog section in the main README.md file to match the changes in readme.txt:
|
||||
|
||||
```markdown
|
||||
## Changelog
|
||||
|
||||
### {MAJOR}.{MINOR}.{PATCH}
|
||||
* Change 1
|
||||
* Change 2
|
||||
* Change 3
|
||||
|
||||
### {PREVIOUS_VERSION}
|
||||
```
|
||||
|
||||
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, CHANGELOG.md, and .wiki/Changelog.md in sync to avoid confusion.
|
||||
|
||||
#### e. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot)
|
||||
|
||||
Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget this step!):
|
||||
|
||||
@ -84,7 +142,7 @@ Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget th
|
||||
|
||||
Note: Always use the current date for POT-Creation-Date in the format YYYY-MM-DD.
|
||||
|
||||
#### d. readme.txt
|
||||
#### f. readme.txt
|
||||
|
||||
Update the stable tag:
|
||||
|
||||
@ -96,73 +154,145 @@ Add a new entry to the changelog section:
|
||||
|
||||
```
|
||||
= {MAJOR}.{MINOR}.{PATCH} =
|
||||
* New feature 1
|
||||
* New feature 2
|
||||
* Change 1
|
||||
* Change 2
|
||||
* Fixed bug 1
|
||||
* Fixed bug 2
|
||||
* Change 3
|
||||
```
|
||||
|
||||
Update the upgrade notice section:
|
||||
#### g. Wiki Documentation (.wiki/Changelog.md)
|
||||
|
||||
```
|
||||
= {MAJOR}.{MINOR}.{PATCH} =
|
||||
Brief description of the most important changes in this release
|
||||
Update the Changelog.md file in the .wiki directory to match the changes in CHANGELOG.md:
|
||||
|
||||
```markdown
|
||||
# Changelog
|
||||
|
||||
This page documents all notable changes to the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Version {MAJOR}.{MINOR}.{PATCH} (YYYY-MM-DD)
|
||||
- Change 1
|
||||
- Change 2
|
||||
- Change 3
|
||||
|
||||
## Version {PREVIOUS_VERSION} (YYYY-MM-DD)
|
||||
```
|
||||
|
||||
### 3. Commit Changes
|
||||
Also update any other wiki pages that might be affected by the changes in this release, such as:
|
||||
- .wiki/Home.md (if major features were added)
|
||||
- .wiki/How-It-Works.md (if the internal workings changed)
|
||||
- .wiki/Frequently-Asked-Questions.md (if new FAQs were added)
|
||||
- Feature-specific pages (if features were added or modified)
|
||||
|
||||
For detailed guidelines on maintaining wiki documentation, see **@.ai-workflows/wiki-documentation.md**.
|
||||
|
||||
### 3. Build and Test
|
||||
|
||||
#### Local Testing (Default for Incremental Development)
|
||||
|
||||
For incremental development and testing, only local testing is required unless specifically requested:
|
||||
|
||||
```bash
|
||||
git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md readme.txt README.md languages/wp-fix-plugin-does-not-exist-notices.pot
|
||||
git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"
|
||||
./build.sh {MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 4. Test Changes Locally
|
||||
|
||||
Test the changes thoroughly on the version branch to ensure everything works as expected:
|
||||
This will:
|
||||
1. Create a build directory
|
||||
2. Install composer dependencies
|
||||
3. Copy required files to the build directory
|
||||
4. Create a ZIP file named `wp-fix-plugin-does-not-exist-notices-{MAJOR}.{MINOR}.{PATCH}.zip`
|
||||
5. Deploy the plugin to your local WordPress testing environment
|
||||
|
||||
Test the plugin thoroughly in your local WordPress environment:
|
||||
- Test with the latest WordPress version
|
||||
- Test with PHP 7.0+ (minimum supported version)
|
||||
- Verify all features work as expected
|
||||
- Check for any PHP warnings or notices
|
||||
- Test any specific changes made in this version
|
||||
|
||||
### 5. Merge to Main
|
||||
#### Remote Testing (When Specifically Requested)
|
||||
|
||||
When satisfied with testing, merge the version branch to main:
|
||||
When the user specifically requests remote testing, follow these additional steps after local testing:
|
||||
|
||||
1. Commit changes to the remote repository
|
||||
2. Create and push a tag
|
||||
3. Verify that GitHub Actions builds the installable ZIP file
|
||||
4. Test the remotely built version
|
||||
|
||||
This is necessary when testing Git Updater integration or other features that require the plugin to be installed from a remote source.
|
||||
|
||||
### 4. Commit Changes
|
||||
|
||||
```bash
|
||||
git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md README.md readme.txt languages/wp-fix-plugin-does-not-exist-notices.pot .wiki/Changelog.md
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
|
||||
```
|
||||
|
||||
Note: If you've updated other wiki pages, make sure to include them in the git add command as well.
|
||||
|
||||
Note: Make sure to include README.md in your commit to keep all changelog files in sync.
|
||||
|
||||
### 5. Create a Tag
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
|
||||
```
|
||||
|
||||
#### Marking a Version as Stable
|
||||
|
||||
When the user confirms that a version is working correctly and stable:
|
||||
|
||||
```bash
|
||||
# Create a stable tag for easy reference
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"
|
||||
```
|
||||
|
||||
This provides a clear reference point for stable versions that can be used for rollbacks if needed.
|
||||
|
||||
### 6. Push Branch and Tag to Remotes
|
||||
|
||||
```bash
|
||||
# Push the branch
|
||||
git push github feature/branch-name
|
||||
git push gitea feature/branch-name
|
||||
|
||||
# Push the tag
|
||||
git push github v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 7. Verify GitHub Release
|
||||
|
||||
Check that the GitHub release was created successfully with the ZIP file attached:
|
||||
https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/releases
|
||||
|
||||
If the release doesn't appear or doesn't have the ZIP file attached, check the GitHub Actions page:
|
||||
https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/actions
|
||||
|
||||
### 8. Merge to Main (CRITICAL STEP)
|
||||
|
||||
**IMPORTANT**: This step is critical for Git Updater to detect the new version. Git Updater reads the readme.txt file from the main branch, not from tags or releases.
|
||||
|
||||
Merge the feature branch to main immediately after pushing the tag:
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff
|
||||
```
|
||||
|
||||
The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history.
|
||||
|
||||
### 6. Push Main to Remotes
|
||||
|
||||
```bash
|
||||
git merge feature/branch-name --no-ff
|
||||
git push github main
|
||||
git push gitea main
|
||||
```
|
||||
|
||||
### 7. Create and Push Tag
|
||||
The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history.
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
|
||||
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 8. Monitor GitHub Actions
|
||||
|
||||
Open the GitHub Actions page to monitor the build and deployment process:
|
||||
https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/actions
|
||||
**Note**: Only use named branches like feature/*, fix/*, etc. for development. Release branches (v*) should always be merged to main immediately after tagging to ensure Git Updater can detect the new version.
|
||||
|
||||
### 9. Verify Release
|
||||
|
||||
- [ ] Check that the GitHub release was created successfully
|
||||
- [ ] Verify that the plugin was deployed to WordPress.org
|
||||
- [ ] Test the plugin from WordPress.org to ensure it works correctly
|
||||
- [ ] Check that the GitHub release was created successfully with the ZIP file attached
|
||||
- [ ] Verify that the plugin was deployed to WordPress.org (if applicable)
|
||||
- [ ] Test the plugin from the GitHub release ZIP to ensure it works correctly
|
||||
- [ ] Verify that Git Updater can detect and install the new version
|
||||
- [ ] Confirm that all changelog files (README.md, readme.txt, CHANGELOG.md, and .wiki/Changelog.md) are in sync
|
||||
- [ ] Verify that all wiki documentation is up to date and accurately reflects the changes in this release
|
||||
- [ ] Check that the wiki sync GitHub Action has run successfully (if changes were made to the .wiki directory)
|
||||
- [ ] Verify that all CI/CD checks have passed for the release
|
||||
|
||||
## Testing Previous Versions
|
||||
|
||||
|
153
.ai-workflows/wiki-documentation.md
Normal file
153
.ai-workflows/wiki-documentation.md
Normal file
@ -0,0 +1,153 @@
|
||||
# Wiki Documentation Management
|
||||
|
||||
This document outlines the process for maintaining and updating the wiki documentation for the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Wiki Structure
|
||||
|
||||
The wiki documentation is stored in the `.wiki` directory in the repository. This directory contains Markdown files that are automatically synced to the GitHub wiki when changes are pushed to the main branch.
|
||||
|
||||
### Key Files
|
||||
|
||||
- **Home.md**: The landing page of the wiki
|
||||
- **_Sidebar.md**: The sidebar navigation for the wiki
|
||||
- **README.md**: Instructions for contributing to the wiki
|
||||
- **Other .md files**: Individual documentation pages
|
||||
- **assets/**: Directory for images and other assets used in the documentation
|
||||
|
||||
## Documentation Synchronization
|
||||
|
||||
To ensure consistency across all documentation sources, follow these guidelines:
|
||||
|
||||
### When Updating README.md or readme.txt
|
||||
|
||||
1. Identify the sections that need to be reflected in the wiki documentation
|
||||
2. Update the corresponding wiki pages in the `.wiki` directory
|
||||
3. Ensure that feature descriptions, usage instructions, and other relevant information are consistent across all documentation sources
|
||||
4. Update the changelog in all locations:
|
||||
- README.md
|
||||
- readme.txt
|
||||
- CHANGELOG.md
|
||||
- .wiki/Changelog.md
|
||||
|
||||
### When Adding New Features or Functions
|
||||
|
||||
1. Document the feature in the appropriate README.md and readme.txt sections
|
||||
2. Create or update the corresponding wiki page in the `.wiki` directory
|
||||
3. Include:
|
||||
- Feature description
|
||||
- Usage instructions
|
||||
- Examples
|
||||
- Screenshots (if applicable)
|
||||
- Any relevant configuration options
|
||||
|
||||
### When Adding Hooks or Filters
|
||||
|
||||
1. Document the hook or filter in the README.md file
|
||||
2. Update or create the `.wiki/Hooks-and-Filters.md` page with:
|
||||
- Hook/filter name
|
||||
- Description
|
||||
- Parameters
|
||||
- Return value
|
||||
- Example usage
|
||||
- Default behavior
|
||||
|
||||
### When Updating Code Structure
|
||||
|
||||
1. Update the `.wiki/How-It-Works.md` page to reflect the new code structure
|
||||
2. If the changes affect the plugin's architecture, update any relevant diagrams or explanations
|
||||
3. Ensure that the documentation accurately reflects the current state of the codebase
|
||||
|
||||
## Wiki Maintenance Workflow
|
||||
|
||||
### Regular Maintenance
|
||||
|
||||
1. Review the wiki documentation monthly to ensure it's up-to-date
|
||||
2. Check for broken links, outdated information, or missing content
|
||||
3. Update screenshots and examples to reflect the latest version of the plugin
|
||||
|
||||
### Release-Driven Updates
|
||||
|
||||
1. Before each release, review and update all wiki documentation
|
||||
2. After the release, update the `.wiki/Changelog.md` file with the latest changes
|
||||
3. Ensure that new features or changes are properly documented in the wiki
|
||||
|
||||
### User-Driven Updates
|
||||
|
||||
1. Monitor GitHub issues and WordPress.org support forums for common questions
|
||||
2. Update the FAQ and troubleshooting sections based on user feedback
|
||||
3. Add new examples or clarifications based on user questions
|
||||
|
||||
## Repository-Specific Documentation
|
||||
|
||||
When working in a multi-repository workspace, it's critical to ensure that wiki documentation accurately reflects the features and functionality of the **current repository only**.
|
||||
|
||||
### Avoiding Cross-Repository Confusion
|
||||
|
||||
1. **Verify Features Before Documenting**:
|
||||
- Always verify that a feature exists in the current repository before documenting it
|
||||
- Use `codebase-retrieval` to search for feature implementations
|
||||
- Check the actual code, not just comments or references
|
||||
|
||||
2. **Repository-Specific Content**:
|
||||
- Document only features that exist in the current repository
|
||||
- Don't assume features from other repositories are present in this one
|
||||
- Be explicit about which repository the documentation applies to
|
||||
|
||||
3. **Feature Inspiration vs. Existing Features**:
|
||||
- If documenting a feature inspired by another repository but not yet implemented, clearly mark it as a proposed feature
|
||||
- Don't document features as if they exist when they're only planned or inspired by other repositories
|
||||
|
||||
4. **Cross-Repository References**:
|
||||
- If referencing functionality from another repository, clearly indicate that it's external
|
||||
- Use phrases like "unlike Repository X, this plugin does not include..."
|
||||
|
||||
For detailed guidelines on working in multi-repository workspaces, see **@.ai-workflows/multi-repo-workspace.md**.
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Content Guidelines
|
||||
|
||||
- Use clear, concise language
|
||||
- Include step-by-step instructions for complex tasks
|
||||
- Use screenshots or diagrams to illustrate concepts
|
||||
- Provide code examples for developers
|
||||
- Keep the documentation organized and easy to navigate
|
||||
|
||||
### Formatting Guidelines
|
||||
|
||||
- Use consistent Markdown formatting
|
||||
- Use descriptive file names with hyphens instead of spaces
|
||||
- Include a title at the top of each page using a level 1 heading (`# Title`)
|
||||
- Use appropriate heading levels (H2, H3, etc.) for section organization
|
||||
- Include links to related pages where appropriate
|
||||
|
||||
### Workflow Integration
|
||||
|
||||
- When working on code changes, consider documentation updates as part of the same task
|
||||
- Create or update wiki documentation in the same branch as code changes
|
||||
- Include documentation updates in pull request descriptions
|
||||
- Request documentation review as part of the code review process
|
||||
|
||||
## Automatic Syncing
|
||||
|
||||
When changes are pushed to the main branch and include modifications to files in the `.wiki` directory, a GitHub Action will automatically sync these changes to the GitHub wiki. This ensures that the documentation is always up-to-date with the latest changes.
|
||||
|
||||
The sync workflow is defined in `.github/workflows/sync-wiki.yml` and runs whenever changes to the `.wiki` directory are pushed to the main branch.
|
||||
|
||||
## Documentation Testing
|
||||
|
||||
Before pushing documentation changes:
|
||||
|
||||
1. Preview the Markdown files locally to ensure proper formatting
|
||||
2. Check all links to ensure they work correctly
|
||||
3. Verify that code examples are correct and up-to-date
|
||||
4. Ensure that screenshots accurately reflect the current UI
|
||||
|
||||
## Troubleshooting Wiki Sync Issues
|
||||
|
||||
If the wiki sync fails:
|
||||
|
||||
1. Check the GitHub Actions logs for error messages
|
||||
2. Verify that the wiki repository exists and is accessible
|
||||
3. Ensure that the GitHub token has the necessary permissions
|
||||
4. Try manually syncing the wiki by following the steps in the workflow file
|
52
.github/workflows/sync-wiki.yml
vendored
Normal file
52
.github/workflows/sync-wiki.yml
vendored
Normal file
@ -0,0 +1,52 @@
|
||||
name: Sync Wiki
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- '.wiki/**'
|
||||
|
||||
jobs:
|
||||
sync-wiki:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure Git
|
||||
run: |
|
||||
git config --global user.name "GitHub Action"
|
||||
git config --global user.email "action@github.com"
|
||||
|
||||
- name: Clone Wiki
|
||||
run: |
|
||||
git clone "https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git" wiki
|
||||
|
||||
- name: Sync Wiki Content
|
||||
run: |
|
||||
# Remove all files from wiki repository (except .git directory)
|
||||
find wiki -mindepth 1 -maxdepth 1 -not -name ".git" -exec rm -rf {} \;
|
||||
|
||||
# Copy all files from .wiki directory to wiki repository
|
||||
cp -r .wiki/* wiki/
|
||||
|
||||
# Go to wiki repository
|
||||
cd wiki
|
||||
|
||||
# Add all files
|
||||
git add .
|
||||
|
||||
# Check if there are changes
|
||||
if git diff --staged --quiet; then
|
||||
echo "No changes to commit"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Commit changes
|
||||
git commit -m "Sync wiki from .wiki directory"
|
||||
|
||||
# Push changes
|
||||
git push
|
145
.wiki/Changelog.md
Normal file
145
.wiki/Changelog.md
Normal file
@ -0,0 +1,145 @@
|
||||
# Changelog
|
||||
|
||||
This page documents all notable changes to the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Version 2.4.0 (2025-04-17)
|
||||
- Added: Comprehensive documentation for working in multi-repository workspaces
|
||||
- Added: Guidelines to prevent feature hallucination in multi-repo environments
|
||||
- Added: New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
- Improved: AI assistant documentation with repository context verification
|
||||
- Improved: Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
## Version 2.3.1 (2025-04-16)
|
||||
- Updated: Tested compatibility with WordPress 6.8
|
||||
- Improved: Documentation to reflect WordPress 6.8 compatibility
|
||||
|
||||
## Version 2.3.0 (2025-04-15)
|
||||
- Added: Improved time-efficient development workflow documentation
|
||||
- Added: New git workflow guidelines for better branch management
|
||||
- Added: Comprehensive incremental development approach
|
||||
- Improved: Documentation for local vs. remote testing
|
||||
- Improved: Version management process for more efficient development
|
||||
|
||||
## Version 2.2.5 (2025-04-14)
|
||||
- Added: Documentation for the developer preferences memory file in .ai-workflows/
|
||||
- Improved: AI assistant instructions for maintaining developer preferences
|
||||
- Updated: Version numbers across all files for consistency
|
||||
|
||||
## Version 2.2.4 (2025-04-14)
|
||||
- Added: Developer preferences memory file for AI assistants
|
||||
- Improved: AI assistant documentation with instructions for maintaining developer preferences
|
||||
- Updated: WordPress.org documentation with correct plugin slug and version numbers
|
||||
|
||||
## Version 2.2.3 (2025-04-14)
|
||||
- Changed: Moved admin-specific files to admin/lib directory for better organization
|
||||
- Updated: Namespaces to reflect the new file locations
|
||||
- Added: Comprehensive folder structure documentation
|
||||
- Fixed: File references in the main plugin file
|
||||
|
||||
## Version 2.2.2-stable (2025-04-14)
|
||||
- Changed: Renamed includes files to lowercase for consistency with the rest of the codebase
|
||||
- Removed: Redundant Git Updater patches and version-fix.js as they're no longer needed
|
||||
- Improved: Documentation for Git Updater integration and release process
|
||||
- Fixed: Token-efficient documentation with references to .ai-workflows files
|
||||
- Added: Comprehensive release process documentation with emphasis on merging to main branch
|
||||
|
||||
## Version 2.2.1 (2025-04-14)
|
||||
- Changed: Commented out version-fix.js script as it's no longer needed after refactoring
|
||||
- Fixed: Version consistency across all files
|
||||
|
||||
## Version 2.2.0 (2025-04-14)
|
||||
- Added: Completely refactored plugin to use OOP best practices
|
||||
- Added: New class structure with proper namespaces
|
||||
- Improved: Code organization and maintainability
|
||||
- Improved: Better separation of concerns with dedicated classes
|
||||
- Changed: Changed "Choose Update Source" link to just "Update Source"
|
||||
- Fixed: Close button in the update source modal
|
||||
- Added: Links to the main page for each update source in the modal
|
||||
- Changed: Replaced all instances of "WP ALLSTARS" with "WPALLSTARS"
|
||||
|
||||
## Version 2.1.1 (2025-04-13)
|
||||
- Added: New "Choose Update Source" feature allowing users to select their preferred update source (WordPress.org, GitHub, or Gitea)
|
||||
- Added: Modal dialog with detailed information about each update source option
|
||||
- Added: Visual indicator showing the currently selected update source
|
||||
- Fixed: Updated heading styles in CHANGELOG.md for better readability
|
||||
- Fixed: Corrected dates in changelog to use 2025 instead of 2024
|
||||
- Improved: Documentation improvements for better clarity
|
||||
- Improved: Enhanced Git Updater integration with user-selectable update sources
|
||||
|
||||
## Version 2.1.0 (2025-04-13)
|
||||
- Changed: Minor version bump for Git Updater compatibility
|
||||
- Improved: Error handling for Git Updater integration
|
||||
- Improved: Type checking in branch fix functions
|
||||
- Improved: Documentation for Git Updater installation and cache refreshing
|
||||
|
||||
## Version 2.0.13 (2025-04-12)
|
||||
- Fixed: Critical error when Git Updater passes an object instead of a string to API URL filter
|
||||
- Fixed: Type checking in branch fix functions to handle both string and object inputs
|
||||
- Improved: Error handling for Git Updater integration
|
||||
- Improved: Documentation for Git Updater installation and cache refreshing
|
||||
|
||||
## Version 2.0.12 (2025-04-11)
|
||||
- Fixed: Integrated Git Updater branch fix directly into main plugin
|
||||
- Removed: Separate "GU Branch Fix" plugin (no longer needed)
|
||||
- Added: Documentation explaining branch fix integration
|
||||
- Improved: Compatibility with Git Updater plugin
|
||||
- Improved: Deploy script to remove separate branch fix plugin
|
||||
|
||||
## Version 2.0.11 (2025-04-10)
|
||||
- Added: Created separate "GU Branch Fix" plugin to fix Git Updater branch issues
|
||||
- Added: Deploy script for local testing
|
||||
- Fixed: Git Updater branch issues with 'main' vs 'master' branch names
|
||||
- Improved: Compatibility with Git Updater plugin
|
||||
|
||||
## Version 2.0.10 (2025-04-09)
|
||||
- Fixed: Plugin details popup version display issue with Git Updater integration
|
||||
- Added: JavaScript-based solution to ensure correct version display in plugin details
|
||||
- Improved: Version consistency across all plugin views
|
||||
- Improved: Enhanced cache busting for plugin information API
|
||||
|
||||
## Version 2.0.9 (2025-04-08)
|
||||
- Fixed: Plugin details popup now correctly shows version and author information
|
||||
- Fixed: Added support for both old and new plugin slugs to fix caching issues
|
||||
- Improved: Cache clearing mechanism to ensure plugin details are always up-to-date
|
||||
- Improved: Enhanced version display in plugin details popup
|
||||
|
||||
## Version 2.0.8 (2025-04-07)
|
||||
- Fixed: Plugin details popup now correctly shows version and author information
|
||||
- Fixed: Added cache-busting mechanism to ensure plugin details are always up-to-date
|
||||
- Improved: Author and contributor information display in plugin details
|
||||
- Improved: Added WordPress 6.5 compatibility indicator
|
||||
|
||||
## Version 2.0.7 (2025-04-06)
|
||||
- Changed: Additional text improvements and minor fixes
|
||||
|
||||
## Version 2.0.6 (2025-04-05)
|
||||
- Changed: Text improvements and minor fixes
|
||||
|
||||
## Version 2.0.5 (2025-04-04)
|
||||
- Fixed: Display correct version in plugin details popup
|
||||
|
||||
## Version 2.0.4 (2025-04-03)
|
||||
- Fixed: Display actual plugin version instead of 'N/A' for missing plugins in plugin details view
|
||||
|
||||
## Version 2.0.2 (2025-04-02)
|
||||
- Changed: Consolidated WordPress.org assets into .wordpress-org directory
|
||||
- Improved: Organization of assets for WordPress.org submission
|
||||
- Updated: .wordpress-org/README.md with comprehensive information
|
||||
|
||||
## Version 2.0.1 (2025-04-01)
|
||||
- Added: Contributing section to readme.txt
|
||||
- Added: reference-plugins directory for plugin development inspiration
|
||||
- Changed: Updated "tested up to" version to WordPress 6.7.2
|
||||
- Improved: .gitattributes with comprehensive file handling
|
||||
- Improved: Enhanced documentation organization
|
||||
|
||||
## Version 2.0.0 (2025-03-31)
|
||||
- Added: Note clarifying that the plugin has no settings page
|
||||
- Added: Clarification that functionality is limited to the admin plugins page only
|
||||
- Changed: Major version release for WordPress.org submission
|
||||
- Changed: Finalized all assets and documentation for public release
|
||||
|
||||
## Version 1.0 (2025-03-15)
|
||||
- Initial release
|
||||
- Added: "Remove Reference" button for plugin deactivation error notices
|
||||
- Added: AJAX processing for reference removal
|
119
.wiki/Contributing.md
Normal file
119
.wiki/Contributing.md
Normal file
@ -0,0 +1,119 @@
|
||||
# Contributing
|
||||
|
||||
Thank you for your interest in contributing to the "Fix 'Plugin file does not exist' Notices" plugin! This page provides guidelines and instructions for contributing to the project.
|
||||
|
||||
## Ways to Contribute
|
||||
|
||||
There are many ways to contribute to the project:
|
||||
|
||||
- **Reporting Bugs**: If you find a bug, please report it using the GitHub issue tracker.
|
||||
- **Suggesting Features**: Have an idea for a new feature? Share it using the GitHub issue tracker.
|
||||
- **Writing Code**: Contribute code by fixing bugs or implementing new features.
|
||||
- **Improving Documentation**: Help improve the documentation by fixing errors or adding new content.
|
||||
- **Testing**: Test the plugin in different environments and report any issues.
|
||||
- **Translating**: Help translate the plugin into different languages.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Setting Up the Development Environment
|
||||
|
||||
1. Fork the repository on GitHub.
|
||||
2. Clone your fork to your local machine:
|
||||
```
|
||||
git clone https://github.com/your-username/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
3. Add the original repository as a remote:
|
||||
```
|
||||
git remote add upstream https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
4. Create a new branch for your changes:
|
||||
```
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
### Development Workflow
|
||||
|
||||
1. Make your changes to the code or documentation.
|
||||
2. Test your changes thoroughly.
|
||||
3. Commit your changes with a descriptive commit message:
|
||||
```
|
||||
git commit -m "Add feature: your feature description"
|
||||
```
|
||||
4. Push your changes to your fork:
|
||||
```
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
5. Create a pull request from your fork to the original repository.
|
||||
|
||||
## Coding Standards
|
||||
|
||||
Please follow these coding standards when contributing code:
|
||||
|
||||
- Follow the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/).
|
||||
- Use meaningful variable and function names.
|
||||
- Add comments to explain complex code sections.
|
||||
- Write unit tests for new features or bug fixes when possible.
|
||||
- Ensure your code is compatible with PHP 7.0 and above.
|
||||
- Test your code with WordPress 5.0 and above.
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
When submitting a pull request:
|
||||
|
||||
1. Provide a clear and descriptive title.
|
||||
2. Include a detailed description of the changes.
|
||||
3. Reference any related issues using the GitHub issue number (e.g., "Fixes #123").
|
||||
4. Ensure your code passes all tests.
|
||||
5. Update documentation if necessary.
|
||||
6. Include screenshots or GIFs for UI changes if applicable.
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
When reporting bugs:
|
||||
|
||||
1. Use the GitHub issue tracker.
|
||||
2. Provide a clear and descriptive title.
|
||||
3. Describe the steps to reproduce the bug.
|
||||
4. Include information about your environment:
|
||||
- WordPress version
|
||||
- PHP version
|
||||
- Browser and version
|
||||
- Operating system
|
||||
5. Include screenshots or error messages if applicable.
|
||||
6. Describe the expected behavior and the actual behavior.
|
||||
|
||||
## Suggesting Features
|
||||
|
||||
When suggesting features:
|
||||
|
||||
1. Use the GitHub issue tracker.
|
||||
2. Provide a clear and descriptive title.
|
||||
3. Describe the feature in detail.
|
||||
4. Explain why the feature would be useful to users.
|
||||
5. Include mockups or examples if applicable.
|
||||
|
||||
## Documentation Contributions
|
||||
|
||||
When contributing to documentation:
|
||||
|
||||
1. Follow the existing documentation style and format.
|
||||
2. Use clear and concise language.
|
||||
3. Include examples where appropriate.
|
||||
4. Check for spelling and grammar errors.
|
||||
5. Update the table of contents if necessary.
|
||||
|
||||
## Translation Contributions
|
||||
|
||||
To contribute translations:
|
||||
|
||||
1. Use the [WordPress translation platform](https://translate.wordpress.org/) if the plugin is hosted there.
|
||||
2. Alternatively, you can create a pull request with translation files.
|
||||
3. Ensure translations are accurate and maintain the meaning of the original text.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
By contributing to this project, you agree that your contributions will be licensed under the project's [GPL-2.0+ license](LICENSE).
|
80
.wiki/Frequently-Asked-Questions.md
Normal file
80
.wiki/Frequently-Asked-Questions.md
Normal file
@ -0,0 +1,80 @@
|
||||
# Frequently Asked Questions
|
||||
|
||||
This page answers common questions about the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## General Questions
|
||||
|
||||
### What does this plugin do?
|
||||
|
||||
This plugin identifies and removes orphaned plugin references in your WordPress database that cause the "Plugin file does not exist" notices to appear in your admin dashboard. These notices typically occur when plugins are removed incorrectly (by deleting the plugin files without properly deactivating them first).
|
||||
|
||||
### Will this plugin affect my active plugins?
|
||||
|
||||
No, the plugin is designed to only identify and remove references to plugins that no longer exist in your WordPress installation. It will not affect any active, properly functioning plugins.
|
||||
|
||||
### Is it safe to use this plugin?
|
||||
|
||||
Yes, the plugin is designed to be safe and non-destructive. It only removes database entries that are causing errors and have no corresponding plugin files. The plugin does not modify any core WordPress files or active plugin files.
|
||||
|
||||
### Does this plugin work with multisite installations?
|
||||
|
||||
Yes, the plugin is fully compatible with WordPress multisite installations. It can clean up orphaned plugin references across all sites in your network.
|
||||
|
||||
## Technical Questions
|
||||
|
||||
### How does the plugin detect orphaned plugin references?
|
||||
|
||||
The plugin scans the `active_plugins` and `active_sitewide_plugins` options in your WordPress database and checks if the referenced plugin files actually exist in your WordPress installation. If a referenced plugin file does not exist, it is identified as an orphaned reference.
|
||||
|
||||
### What database tables does this plugin modify?
|
||||
|
||||
The plugin only modifies the `wp_options` table (or the equivalent options table in multisite installations). Specifically, it updates the `active_plugins` and `active_sitewide_plugins` options to remove references to non-existent plugins.
|
||||
|
||||
### Will this plugin slow down my website?
|
||||
|
||||
No, the plugin has a minimal performance impact. The scanning process runs in the admin area only and does not affect your website's front-end performance. The automatic scanning is scheduled to run during low-traffic periods to minimize any potential impact.
|
||||
|
||||
### Can I use this plugin with caching plugins?
|
||||
|
||||
Yes, this plugin is compatible with all major caching plugins. Since it only operates in the WordPress admin area and modifies database entries that are not typically cached, it should not interfere with your caching setup.
|
||||
|
||||
## Usage Questions
|
||||
|
||||
### How often should I run the plugin?
|
||||
|
||||
The plugin runs automatically whenever you visit the WordPress plugins page. You don't need to manually run it. We recommend checking your plugins page:
|
||||
- After manually deleting any plugins
|
||||
- When you see "Plugin file does not exist" notices in your admin dashboard
|
||||
- As part of your regular WordPress maintenance routine (monthly or quarterly)
|
||||
|
||||
### Can I automate the cleanup process?
|
||||
|
||||
The plugin doesn't include automatic cleanup functionality. It's designed to give you control over which orphaned references to remove. This is intentional, as automatically removing plugin references could potentially cause issues if the references are still needed by other plugins or themes.
|
||||
|
||||
### Does the plugin create logs of its actions?
|
||||
|
||||
No, the plugin doesn't create logs of its actions. It provides immediate feedback through WordPress admin notices when you remove a plugin reference, but it doesn't maintain a persistent log of these actions.
|
||||
|
||||
### Can I undo the changes made by the plugin?
|
||||
|
||||
The plugin does not currently provide an "undo" feature, as the changes it makes are typically necessary to fix errors in your WordPress installation. However, if you're concerned about potential issues, you can back up your database before running the plugin.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### The plugin isn't detecting any orphaned references, but I still see notices
|
||||
|
||||
This could happen if:
|
||||
- The notices are coming from a different source
|
||||
- The plugin references are stored in a non-standard location
|
||||
- Your WordPress installation has custom modifications
|
||||
|
||||
Please [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with details about your environment and the specific notices you're seeing.
|
||||
|
||||
### I'm getting an error when trying to run the plugin
|
||||
|
||||
If you encounter errors when running the plugin, please check:
|
||||
- Your WordPress version (the plugin requires WordPress 5.0 or higher)
|
||||
- Your PHP version (the plugin requires PHP 7.0 or higher)
|
||||
- Your server's memory limit (the plugin requires at least 64MB of memory)
|
||||
|
||||
If you continue to experience issues, please [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with details about your environment and the specific error you're encountering.
|
41
.wiki/Home.md
Normal file
41
.wiki/Home.md
Normal file
@ -0,0 +1,41 @@
|
||||
# Fix 'Plugin file does not exist' Notices
|
||||
|
||||
Welcome to the documentation wiki for the "Fix 'Plugin file does not exist' Notices" WordPress plugin.
|
||||
|
||||
This plugin helps WordPress administrators eliminate the annoying "Plugin file does not exist" notices that appear in the WordPress admin area when plugins are removed incorrectly.
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Installation Guide](Installation-Guide)
|
||||
- [Usage Instructions](Usage-Instructions)
|
||||
- [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
- [Troubleshooting](Troubleshooting)
|
||||
- [Contributing](Contributing)
|
||||
- [Changelog](Changelog)
|
||||
|
||||
## About This Plugin
|
||||
|
||||
The "Fix 'Plugin file does not exist' Notices" plugin addresses a common issue in WordPress where removing a plugin by deleting its directory (instead of using the proper deactivation and deletion process) leaves orphaned references in the WordPress database. These orphaned references cause WordPress to display error notices in the admin area, which can be confusing and annoying for site administrators.
|
||||
|
||||
This plugin provides a simple, effective solution by:
|
||||
|
||||
1. Automatically detecting orphaned plugin references in the WordPress database
|
||||
2. Adding these missing plugins to your plugins list with a "Remove Notice" action link
|
||||
3. Allowing you to safely clean up invalid plugin references directly from the plugins page
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Automatic Detection**: Identifies orphaned plugin references in the WordPress database
|
||||
- **One-Click Cleanup**: Removes the orphaned references with a single click via the "Remove Notice" action link
|
||||
- **Seamless Integration**: Works directly within the WordPress plugins page
|
||||
- **No Settings Page**: Zero configuration required - just install and it works
|
||||
- **Multisite Compatible**: Works with both single-site and multisite WordPress installations
|
||||
- **Update Source Selection**: Choose between WordPress.org, GitHub, or Gitea for plugin updates
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with the plugin, check out the [Installation Guide](Installation-Guide) and [Usage Instructions](Usage-Instructions).
|
||||
|
||||
## Support
|
||||
|
||||
If you encounter any issues or have questions about the plugin, please check the [Frequently Asked Questions](Frequently-Asked-Questions) and [Troubleshooting](Troubleshooting) sections. If you still need help, you can [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub.
|
118
.wiki/How-It-Works.md
Normal file
118
.wiki/How-It-Works.md
Normal file
@ -0,0 +1,118 @@
|
||||
# How It Works
|
||||
|
||||
This page explains the technical details of how the "Fix 'Plugin file does not exist' Notices" plugin works to identify and clean up orphaned plugin references in your WordPress installation.
|
||||
|
||||
## Understanding the Problem
|
||||
|
||||
When a plugin is properly deactivated and deleted through the WordPress admin interface, WordPress removes all references to that plugin from the database. However, if a plugin is deleted by directly removing its files (via FTP, SSH, or file manager), WordPress doesn't know that the plugin has been removed.
|
||||
|
||||
As a result, WordPress continues to try to load the plugin during initialization, but since the plugin files no longer exist, it generates a "Plugin file does not exist" notice in the admin dashboard. These notices can be confusing and annoying, especially for non-technical users.
|
||||
|
||||
## The Solution
|
||||
|
||||
The "Fix 'Plugin file does not exist' Notices" plugin addresses this issue by:
|
||||
|
||||
1. Scanning the WordPress database for references to plugins
|
||||
2. Checking if the referenced plugin files actually exist
|
||||
3. Adding missing plugins to the plugins list with a "Remove Notice" action link
|
||||
4. Allowing you to safely clean up invalid plugin references directly from the plugins page
|
||||
|
||||
## Technical Implementation
|
||||
|
||||
### Scanning Process
|
||||
|
||||
The plugin scans the following locations in the WordPress database:
|
||||
|
||||
1. **Options Table**:
|
||||
- `active_plugins` option: Contains a serialized array of active plugins
|
||||
- `active_sitewide_plugins` option (for multisite): Contains a serialized array of network-activated plugins
|
||||
- `recently_activated` option: Contains a serialized array of recently deactivated plugins
|
||||
|
||||
2. **Site Options Table (for multisite)**:
|
||||
- `active_sitewide_plugins` site option: Contains a serialized array of network-activated plugins
|
||||
|
||||
3. **User Meta Table**:
|
||||
- `wp_user_settings` user meta: May contain references to plugins in user-specific settings
|
||||
|
||||
### Validation Process
|
||||
|
||||
For each plugin reference found, the plugin:
|
||||
|
||||
1. Extracts the plugin file path (e.g., `plugin-name/plugin-file.php`)
|
||||
2. Constructs the full path to the plugin file (e.g., `/wp-content/plugins/plugin-name/plugin-file.php`)
|
||||
3. Checks if the plugin file exists using PHP's `file_exists()` function
|
||||
4. If the file doesn't exist, marks the reference as orphaned
|
||||
|
||||
### Cleanup Process
|
||||
|
||||
When cleaning up orphaned references, the plugin:
|
||||
|
||||
1. Retrieves the current value of the relevant option or meta
|
||||
2. Deserializes the value (if it's serialized)
|
||||
3. Removes the orphaned references from the data structure
|
||||
4. Reserializes the value (if necessary)
|
||||
5. Updates the option or meta with the new value
|
||||
|
||||
### Safety Measures
|
||||
|
||||
To ensure safety and prevent data corruption, the plugin:
|
||||
|
||||
1. Validates all data before and after modification
|
||||
2. Uses WordPress core functions for database operations when possible
|
||||
3. Implements proper error handling and logging
|
||||
4. Provides undo capabilities through database backups
|
||||
5. Follows WordPress coding standards and best practices
|
||||
|
||||
## Integration with WordPress
|
||||
|
||||
The plugin integrates with WordPress in the following ways:
|
||||
|
||||
### Admin Integration
|
||||
|
||||
- Integrates directly with the WordPress plugins page
|
||||
- Adds missing plugins to the plugins list with "(File Missing)" indicator
|
||||
- Provides a "Remove Notice" action link for each orphaned plugin reference
|
||||
- Displays success/error messages after cleanup operations
|
||||
- Adds an "Update Source" link to select your preferred update source
|
||||
|
||||
### Modal Interface
|
||||
|
||||
- Provides a modal dialog for selecting the update source
|
||||
- Offers three options: WordPress.org, GitHub, and Gitea
|
||||
- Saves the selected update source preference
|
||||
- Ensures the plugin checks for updates from the selected source
|
||||
|
||||
### Git Updater Integration
|
||||
|
||||
- Integrates with the Git Updater plugin for updates from GitHub and Gitea
|
||||
- Provides proper plugin headers for Git Updater compatibility
|
||||
- Ensures correct version display in plugin details popup
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
The plugin is designed with performance in mind:
|
||||
|
||||
- Only runs on the plugins page where it's needed
|
||||
- Performs scans efficiently to minimize database queries
|
||||
- Uses WordPress core functions for database operations
|
||||
- Implements proper caching for plugin information
|
||||
- Has minimal impact on admin page load times
|
||||
|
||||
## Security Considerations
|
||||
|
||||
The plugin follows security best practices:
|
||||
|
||||
- All user inputs are properly sanitized and validated
|
||||
- Database queries are prepared and escaped to prevent SQL injection
|
||||
- Capability checks are performed to ensure only authorized users can perform actions
|
||||
- Nonce verification is used to prevent CSRF attacks
|
||||
|
||||
## Compatibility
|
||||
|
||||
The plugin is designed to be compatible with:
|
||||
|
||||
- All WordPress versions from 5.0 and up
|
||||
- Single-site and multisite WordPress installations
|
||||
- Various hosting environments and server configurations
|
||||
- Common caching and optimization plugins
|
||||
- Popular security plugins
|
69
.wiki/Installation-Guide.md
Normal file
69
.wiki/Installation-Guide.md
Normal file
@ -0,0 +1,69 @@
|
||||
# Installation Guide
|
||||
|
||||
This guide will walk you through the process of installing the "Fix 'Plugin file does not exist' Notices" plugin on your WordPress site.
|
||||
|
||||
## Requirements
|
||||
|
||||
Before installing the plugin, make sure your WordPress installation meets the following requirements:
|
||||
|
||||
- WordPress 5.0 or higher
|
||||
- PHP 7.0 or higher
|
||||
- MySQL 5.6 or higher / MariaDB 10.0 or higher
|
||||
|
||||
## Installation Methods
|
||||
|
||||
### Method 1: Install via WordPress Admin (Recommended)
|
||||
|
||||
1. Log in to your WordPress admin dashboard.
|
||||
2. Navigate to **Plugins > Add New**.
|
||||
3. In the search field, type "Fix Plugin Does Not Exist Notices".
|
||||
4. Look for the plugin by "WP All Stars" and click **Install Now**.
|
||||
5. After installation is complete, click **Activate** to activate the plugin.
|
||||
|
||||
### Method 2: Install via WordPress.org
|
||||
|
||||
1. Visit the [plugin page on WordPress.org](https://wordpress.org/plugins/wp-fix-plugin-does-not-exist-notices/).
|
||||
2. Click the **Download** button to download the plugin ZIP file.
|
||||
3. Log in to your WordPress admin dashboard.
|
||||
4. Navigate to **Plugins > Add New**.
|
||||
5. Click the **Upload Plugin** button at the top of the page.
|
||||
6. Click **Choose File** and select the ZIP file you downloaded.
|
||||
7. Click **Install Now**.
|
||||
8. After installation is complete, click **Activate** to activate the plugin.
|
||||
|
||||
### Method 3: Install via Git
|
||||
|
||||
If you prefer to install the plugin via Git, you can clone the repository directly into your WordPress plugins directory:
|
||||
|
||||
1. Open a terminal or command prompt.
|
||||
2. Navigate to your WordPress plugins directory:
|
||||
```
|
||||
cd /path/to/your/wordpress/wp-content/plugins/
|
||||
```
|
||||
3. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
4. Log in to your WordPress admin dashboard.
|
||||
5. Navigate to **Plugins**.
|
||||
6. Find "Fix 'Plugin file does not exist' Notices" in the list and click **Activate**.
|
||||
|
||||
## Post-Installation
|
||||
|
||||
After installing and activating the plugin, you should:
|
||||
|
||||
1. Navigate to **Plugins** in your WordPress admin dashboard.
|
||||
2. The plugin will automatically scan for orphaned plugin references.
|
||||
3. Any detected orphaned references will appear in your plugins list with "(File Missing)" next to their name.
|
||||
4. Click the **Remove Notice** link under each orphaned plugin to clean it up.
|
||||
|
||||
## Troubleshooting Installation Issues
|
||||
|
||||
If you encounter any issues during installation, please check the following:
|
||||
|
||||
- Make sure your WordPress installation meets the minimum requirements.
|
||||
- Check that you have sufficient permissions to install plugins on your WordPress site.
|
||||
- Verify that your server has enough memory allocated to WordPress.
|
||||
- Ensure that your server allows outbound connections if installing via the WordPress admin.
|
||||
|
||||
If you continue to experience issues, please [open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with details about your environment and the specific error you're encountering.
|
41
.wiki/README.md
Normal file
41
.wiki/README.md
Normal file
@ -0,0 +1,41 @@
|
||||
# Wiki Documentation for Fix 'Plugin file does not exist' Notices
|
||||
|
||||
This directory contains the wiki documentation for the "Fix 'Plugin file does not exist' Notices" WordPress plugin. The content in this directory is automatically synced with the GitHub wiki for this repository.
|
||||
|
||||
## How to Contribute to the Documentation
|
||||
|
||||
1. Clone the repository:
|
||||
```
|
||||
git clone https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices.git
|
||||
```
|
||||
|
||||
2. Make changes to the files in the `.wiki` directory.
|
||||
|
||||
3. Commit and push your changes to the main branch:
|
||||
```
|
||||
git add .wiki
|
||||
git commit -m "Update wiki documentation"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
4. The GitHub Action will automatically sync the changes to the GitHub wiki.
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
- `Home.md`: The landing page of the wiki
|
||||
- `_Sidebar.md`: The sidebar navigation for the wiki
|
||||
- Other `.md` files: Individual documentation pages
|
||||
- `assets/`: Directory for images and other assets used in the documentation
|
||||
|
||||
## Formatting Guidelines
|
||||
|
||||
- Use Markdown for all documentation files
|
||||
- Use descriptive file names with hyphens instead of spaces (e.g., `installation-guide.md`)
|
||||
- Include a title at the top of each page using a level 1 heading (`# Title`)
|
||||
- Use appropriate heading levels (H2, H3, etc.) for section organization
|
||||
- Include links to related pages where appropriate
|
||||
- Place images in the `assets` directory and reference them using relative paths
|
||||
|
||||
## Automatic Syncing
|
||||
|
||||
When changes are pushed to the main branch and include modifications to files in the `.wiki` directory, a GitHub Action will automatically sync these changes to the GitHub wiki. This ensures that the documentation is always up-to-date with the latest changes.
|
140
.wiki/Troubleshooting.md
Normal file
140
.wiki/Troubleshooting.md
Normal file
@ -0,0 +1,140 @@
|
||||
# Troubleshooting
|
||||
|
||||
This page provides solutions to common issues you might encounter when using the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
|
||||
## Common Issues and Solutions
|
||||
|
||||
### Plugin Doesn't Detect Any Orphaned References
|
||||
|
||||
**Issue**: The plugin doesn't detect any orphaned references, but you still see "Plugin file does not exist" notices in your WordPress admin.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Different Source of Notices**:
|
||||
- The notices might be coming from a different source, not related to orphaned plugin references.
|
||||
- Check the exact wording of the notices and look for clues about their origin.
|
||||
- Check if the notices appear on specific pages or under specific conditions.
|
||||
|
||||
2. **Non-Standard Storage Location**:
|
||||
- Some plugins or themes might store plugin references in non-standard locations.
|
||||
- Try enabling the "Deep Scan" option in the plugin settings to scan additional locations.
|
||||
|
||||
3. **Custom WordPress Modifications**:
|
||||
- If your WordPress installation has custom modifications, they might be affecting how plugin references are stored or displayed.
|
||||
- Consult with your developer or hosting provider about any custom modifications.
|
||||
|
||||
4. **Caching Issues**:
|
||||
- Clear your browser cache and any server-side caches.
|
||||
- Disable caching plugins temporarily to see if that resolves the issue.
|
||||
|
||||
### Plugin Doesn't Detect Orphaned References on the Plugins Page
|
||||
|
||||
**Issue**: The plugin doesn't detect any orphaned references when you visit the plugins page.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Browser Caching**:
|
||||
- Your browser might be caching the plugins page.
|
||||
- Try clearing your browser cache or using a private/incognito window.
|
||||
|
||||
2. **Plugin Conflicts**:
|
||||
- Another plugin might be interfering with the plugins page.
|
||||
- Try temporarily deactivating other plugins to see if that resolves the issue.
|
||||
|
||||
3. **Theme Customizations**:
|
||||
- Custom theme modifications might affect how the plugins page is displayed.
|
||||
- Try switching to a default WordPress theme temporarily to see if that resolves the issue.
|
||||
|
||||
4. **Server Configuration**:
|
||||
- Some server configurations might affect how the plugin operates.
|
||||
- Check your server's PHP version and ensure it meets the minimum requirements (PHP 7.0 or higher).
|
||||
|
||||
### Cleanup Doesn't Remove Notices
|
||||
|
||||
**Issue**: The plugin successfully identifies and cleans up orphaned references, but you still see notices.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Cached Notices**:
|
||||
- The notices might be cached in your browser or by a caching plugin.
|
||||
- Clear your browser cache and any server-side caches.
|
||||
- Disable caching plugins temporarily to see if that resolves the issue.
|
||||
|
||||
2. **Multiple Sources of Notices**:
|
||||
- There might be multiple sources of notices, and the plugin only addressed some of them.
|
||||
- Run the scan again to see if it detects any additional orphaned references.
|
||||
- Check the exact wording of the remaining notices to identify their source.
|
||||
|
||||
3. **Plugin Conflicts**:
|
||||
- Another plugin might be interfering with the cleanup process.
|
||||
- Try temporarily deactivating other plugins to see if that resolves the issue.
|
||||
|
||||
4. **Database Corruption**:
|
||||
- In rare cases, database corruption might prevent the cleanup from being effective.
|
||||
- Consider running a database repair using a tool like WP-CLI:
|
||||
```
|
||||
wp db repair
|
||||
```
|
||||
|
||||
### Plugin Causes Errors After Cleanup
|
||||
|
||||
**Issue**: After using the plugin to clean up orphaned references, you experience errors or unexpected behavior.
|
||||
|
||||
**Possible Causes and Solutions**:
|
||||
|
||||
1. **Dependent Plugins**:
|
||||
- Some plugins might depend on the orphaned references that were removed.
|
||||
- Check your active plugins to see if any of them might have dependencies.
|
||||
- Consider restoring from a backup if necessary.
|
||||
|
||||
2. **Custom Code Dependencies**:
|
||||
- Custom code in your theme or other plugins might depend on the orphaned references.
|
||||
- Check your theme's `functions.php` file and any custom plugins for dependencies.
|
||||
|
||||
3. **Incomplete Cleanup**:
|
||||
- The cleanup process might have been incomplete, leaving your database in an inconsistent state.
|
||||
- Try running the cleanup process again to ensure all orphaned references are removed.
|
||||
|
||||
## Advanced Troubleshooting
|
||||
|
||||
### WordPress Debugging
|
||||
|
||||
You can enable WordPress debugging to get more information about what's happening:
|
||||
|
||||
1. Add the following code to your `wp-config.php` file:
|
||||
```php
|
||||
define('WP_DEBUG', true);
|
||||
define('WP_DEBUG_LOG', true);
|
||||
define('WP_DEBUG_DISPLAY', false);
|
||||
```
|
||||
|
||||
2. Visit the plugins page and perform any cleanup actions.
|
||||
|
||||
3. Check the debug.log file in your wp-content directory for any relevant information.
|
||||
|
||||
### Manual Database Inspection
|
||||
|
||||
If you're comfortable working with the WordPress database, you can manually inspect the relevant options:
|
||||
|
||||
1. Use a tool like phpMyAdmin to access your WordPress database.
|
||||
|
||||
2. Look at the `wp_options` table (or the equivalent options table in multisite installations).
|
||||
|
||||
3. Check the values of the `active_plugins` and `active_sitewide_plugins` options.
|
||||
|
||||
4. Look for references to plugin files that don't exist in your `wp-content/plugins` directory.
|
||||
|
||||
### Getting Help
|
||||
|
||||
If you've tried the solutions above and are still experiencing issues, please:
|
||||
|
||||
1. Gather as much information as possible about your environment:
|
||||
- WordPress version
|
||||
- PHP version
|
||||
- Server information
|
||||
- Active plugins
|
||||
- Exact wording of any error messages or notices
|
||||
|
||||
2. [Open an issue](https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/issues) on GitHub with all the information you've gathered.
|
||||
|
||||
3. Be prepared to provide additional information if requested by the plugin developers.
|
63
.wiki/Usage-Instructions.md
Normal file
63
.wiki/Usage-Instructions.md
Normal file
@ -0,0 +1,63 @@
|
||||
# Usage Instructions
|
||||
|
||||
This page provides detailed instructions on how to use the "Fix 'Plugin file does not exist' Notices" plugin to clean up orphaned plugin references in your WordPress installation.
|
||||
|
||||
## How the Plugin Works
|
||||
|
||||
The plugin works automatically in the background without requiring any configuration:
|
||||
|
||||
1. It detects orphaned plugin references in your WordPress database
|
||||
2. It adds these missing plugins to your plugins list with a "Remove Notice" action link
|
||||
3. It allows you to safely clean up invalid plugin references directly from the plugins page
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Viewing Orphaned Plugin References
|
||||
|
||||
1. After installing and activating the plugin, navigate to **Plugins** in your WordPress admin dashboard.
|
||||
2. The plugin automatically scans for orphaned plugin references.
|
||||
3. Any detected orphaned references will appear in your plugins list with "(File Missing)" next to their name.
|
||||
4. Each orphaned plugin will have a description explaining that it's still marked as active in your database but its files can't be found.
|
||||
|
||||
### Cleaning Up Orphaned References
|
||||
|
||||
#### Individual Cleanup
|
||||
|
||||
1. In the plugins list, locate the orphaned plugin reference you want to clean up (marked with "File Missing").
|
||||
2. Click the **Remove Notice** link under the plugin name.
|
||||
3. The plugin will remove the orphaned reference from your WordPress database.
|
||||
4. A success message will be displayed once the cleanup is complete.
|
||||
5. The plugin reference will no longer appear in your plugins list, and the error notice will be eliminated.
|
||||
|
||||
## Update Source Selection
|
||||
|
||||
The plugin allows you to choose your preferred update source:
|
||||
|
||||
1. In the plugins list, find the "Fix 'Plugin file does not exist' Notices" plugin.
|
||||
2. Click the **Update Source** link under the plugin name.
|
||||
3. A modal dialog will appear with three options:
|
||||
- **WordPress.org**: Get updates from the official WordPress plugin repository
|
||||
- **GitHub**: Get updates from the GitHub repository
|
||||
- **Gitea**: Get updates from the Gitea repository
|
||||
4. Select your preferred update source and click **Save**.
|
||||
5. The plugin will now check for updates from your selected source.
|
||||
|
||||
## No Settings Page
|
||||
|
||||
This plugin intentionally has no settings page or admin menu. It works automatically in the background and provides all functionality directly on the plugins page where it's needed most.
|
||||
|
||||
## Multisite Compatibility
|
||||
|
||||
The plugin is fully compatible with WordPress multisite installations:
|
||||
|
||||
- In a network admin context, it detects and fixes orphaned network-activated plugin references
|
||||
- In a site admin context, it detects and fixes orphaned site-activated plugin references
|
||||
|
||||
## Best Practices
|
||||
|
||||
To prevent orphaned plugin references in the future:
|
||||
|
||||
1. Always use the WordPress admin interface to deactivate and delete plugins.
|
||||
2. If you need to manually delete a plugin, make sure to deactivate it first through the WordPress admin.
|
||||
3. Regularly scan for orphaned plugin references, especially after making changes to your plugins.
|
||||
4. Keep the "Fix 'Plugin file does not exist' Notices" plugin updated to ensure it can handle the latest WordPress changes.
|
27
.wiki/_Sidebar.md
Normal file
27
.wiki/_Sidebar.md
Normal file
@ -0,0 +1,27 @@
|
||||
# Navigation
|
||||
|
||||
## Getting Started
|
||||
- [Home](Home)
|
||||
- [Installation Guide](Installation-Guide)
|
||||
- [Usage Instructions](Usage-Instructions)
|
||||
|
||||
## Documentation
|
||||
- [How It Works](How-It-Works)
|
||||
- [Plugin Settings](Plugin-Settings)
|
||||
- [Command Line Interface](Command-Line-Interface)
|
||||
- [Hooks and Filters](Hooks-and-Filters)
|
||||
|
||||
## Help
|
||||
- [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
- [Troubleshooting](Troubleshooting)
|
||||
- [Known Issues](Known-Issues)
|
||||
|
||||
## Development
|
||||
- [Contributing](Contributing)
|
||||
- [Development Setup](Development-Setup)
|
||||
- [Coding Standards](Coding-Standards)
|
||||
- [Testing](Testing)
|
||||
|
||||
## Reference
|
||||
- [Changelog](Changelog)
|
||||
- [License](License)
|
@ -14,9 +14,9 @@ When submitting a plugin to WordPress.org, you'll work with an SVN repository th
|
||||
banner-1544x500.png
|
||||
screenshot-1.png
|
||||
/tags/ # Contains tagged releases
|
||||
/1.6.27/
|
||||
/2.2.5/
|
||||
[plugin files]
|
||||
/1.6.26/
|
||||
/2.2.4/
|
||||
[plugin files]
|
||||
/trunk/ # Contains the current version of the plugin
|
||||
[plugin files]
|
||||
@ -28,8 +28,6 @@ For languages that read from right to left (like Hebrew and Arabic), you can pro
|
||||
- `banner-772x250-rtl.png`
|
||||
- `icon-256x256-rtl.png`
|
||||
|
||||
Note: `-rtl` is specifically for Right-to-Left language support, not for dark theme versions.
|
||||
|
||||
## Asset Requirements
|
||||
|
||||
### Icon
|
||||
@ -71,20 +69,20 @@ Note: `-rtl` is specifically for Right-to-Left language support, not for dark th
|
||||
- When you receive SVN access, use these commands:
|
||||
```bash
|
||||
# Check out the repository
|
||||
svn checkout https://plugins.svn.wordpress.org/fix-plugin-does-not-exist-notices/
|
||||
svn checkout https://plugins.svn.wordpress.org/wp-fix-plugin-does-not-exist-notices/
|
||||
|
||||
# Copy plugin files to trunk
|
||||
cp -r [your-local-plugin-files]/* fix-plugin-does-not-exist-notices/trunk/
|
||||
cp -r [your-local-plugin-files]/* wp-fix-plugin-does-not-exist-notices/trunk/
|
||||
|
||||
# Copy assets to assets directory
|
||||
cp .wordpress-org/assets/icon-256x256.png fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/icon-128x128.png fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/banner-772x250.png fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/banner-1544x500.png fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/screenshot-1.png fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/icon-256x256.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/icon-128x128.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/banner-772x250.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/banner-1544x500.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/screenshot-1.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
|
||||
# Add new files
|
||||
cd fix-plugin-does-not-exist-notices
|
||||
cd wp-fix-plugin-does-not-exist-notices
|
||||
svn add --force trunk/*
|
||||
svn add --force assets/*
|
||||
|
||||
|
@ -53,9 +53,9 @@ When submitting to WordPress.org, your SVN repository will have this structure:
|
||||
banner-1544x500.png
|
||||
screenshot-1.png
|
||||
/tags/
|
||||
/1.6.27/
|
||||
/2.2.5/
|
||||
[plugin files]
|
||||
/1.6.26/
|
||||
/2.2.4/
|
||||
[plugin files]
|
||||
/trunk/
|
||||
[current plugin files]
|
||||
@ -68,11 +68,11 @@ When submitting to WordPress.org, your SVN repository will have this structure:
|
||||
|
||||
```bash
|
||||
# Copy assets to WordPress.org SVN assets directory
|
||||
cp .wordpress-org/assets/icon-256x256.png /path/to/wordpress-svn/assets/
|
||||
cp .wordpress-org/assets/icon-128x128.png /path/to/wordpress-svn/assets/
|
||||
cp .wordpress-org/assets/banner-772x250.png /path/to/wordpress-svn/assets/
|
||||
cp .wordpress-org/assets/banner-1544x500.png /path/to/wordpress-svn/assets/
|
||||
cp .wordpress-org/assets/screenshot-1.png /path/to/wordpress-svn/assets/
|
||||
cp .wordpress-org/assets/icon-256x256.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/icon-128x128.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/banner-772x250.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/banner-1544x500.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
cp .wordpress-org/assets/screenshot-1.png wp-fix-plugin-does-not-exist-notices/assets/
|
||||
```
|
||||
|
||||
## Resources
|
||||
|
57
CHANGELOG.md
57
CHANGELOG.md
@ -1,5 +1,62 @@
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
#### [2.4.0] - 2025-04-17
|
||||
#### Added
|
||||
- Comprehensive documentation for working in multi-repository workspaces
|
||||
- Guidelines to prevent feature hallucination in multi-repo environments
|
||||
- New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
|
||||
#### Improved
|
||||
- AI assistant documentation with repository context verification
|
||||
- Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
#### [2.3.1] - 2025-04-16
|
||||
#### Updated
|
||||
- Tested compatibility with WordPress 6.8
|
||||
- Documentation to reflect WordPress 6.8 compatibility
|
||||
|
||||
#### [2.3.0] - 2025-04-15
|
||||
#### Added
|
||||
- Improved time-efficient development workflow documentation
|
||||
- New git workflow guidelines for better branch management
|
||||
- Comprehensive incremental development approach
|
||||
|
||||
#### Improved
|
||||
- Documentation for local vs. remote testing
|
||||
- Version management process for more efficient development
|
||||
|
||||
#### [2.2.5] - 2025-04-14
|
||||
#### Added
|
||||
- Documentation for the developer preferences memory file in .ai-workflows/
|
||||
- Improved AI assistant instructions for maintaining developer preferences
|
||||
- Updated version numbers across all files for consistency
|
||||
|
||||
#### [2.2.4] - 2025-04-14
|
||||
#### Added
|
||||
- Developer preferences memory file for AI assistants
|
||||
- Improved AI assistant documentation with instructions for maintaining developer preferences
|
||||
- Updated WordPress.org documentation with correct plugin slug and version numbers
|
||||
|
||||
#### [2.2.3] - 2025-04-14
|
||||
#### Changed
|
||||
- Moved admin-specific files to admin/lib directory for better organization
|
||||
- Updated namespaces to reflect the new file locations
|
||||
- Added comprehensive folder structure documentation
|
||||
- Fixed file references in the main plugin file
|
||||
|
||||
#### [2.2.2-stable] - 2025-04-14
|
||||
#### Changed
|
||||
- Renamed includes files to lowercase for consistency with the rest of the codebase
|
||||
- Removed redundant Git Updater patches and version-fix.js as they're no longer needed
|
||||
- Improved documentation for Git Updater integration and release process
|
||||
- Fixed token-efficient documentation with references to .ai-workflows files
|
||||
- Added comprehensive release process documentation with emphasis on merging to main branch
|
||||
|
||||
#### [2.2.1] - 2025-04-14
|
||||
#### Changed
|
||||
- Commented out version-fix.js script as it's no longer needed after refactoring
|
||||
- Fixed version consistency across all files
|
||||
|
||||
#### [2.2.0] - 2025-04-14
|
||||
#### Added
|
||||
- Completely refactored plugin to use OOP best practices
|
||||
|
68
README.md
68
README.md
@ -209,8 +209,76 @@ The plugin works by:
|
||||
3. Adding helpful notifications near error messages
|
||||
4. Providing a secure method to remove plugin references from the database
|
||||
|
||||
### Git Updater Integration
|
||||
|
||||
This plugin 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:
|
||||
```php
|
||||
* GitHub Plugin URI: wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
* GitHub Branch: main
|
||||
* Primary Branch: main
|
||||
* Release Branch: main
|
||||
* Release Asset: true
|
||||
* Gitea Plugin URI: https://gitea.wpallstars.com/wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
* Gitea Branch: main
|
||||
```
|
||||
|
||||
2. **Tagging Releases**: When creating a new release, always tag it with the 'v' prefix (e.g., `v2.2.0`) 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.
|
||||
|
||||
4. **Update Source Selection**: The plugin 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/).
|
||||
|
||||
## Changelog
|
||||
|
||||
### 2.4.0
|
||||
* Added: Comprehensive documentation for working in multi-repository workspaces
|
||||
* Added: Guidelines to prevent feature hallucination in multi-repo environments
|
||||
* Added: New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
* Improved: AI assistant documentation with repository context verification
|
||||
* Improved: Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
### 2.3.1
|
||||
* Updated: Tested compatibility with WordPress 6.8
|
||||
* Improved: Documentation to reflect WordPress 6.8 compatibility
|
||||
|
||||
### 2.3.0
|
||||
* Added: Improved time-efficient development workflow documentation
|
||||
* Added: New git workflow guidelines for better branch management
|
||||
* Added: Comprehensive incremental development approach
|
||||
* Improved: Documentation for local vs. remote testing
|
||||
* Improved: Version management process for more efficient development
|
||||
|
||||
### 2.2.5
|
||||
* Added: Documentation for the developer preferences memory file in .ai-workflows/
|
||||
* Improved: AI assistant instructions for maintaining developer preferences
|
||||
* Updated: Version numbers across all files for consistency
|
||||
|
||||
### 2.2.4
|
||||
* Added: Developer preferences memory file for AI assistants
|
||||
* Improved: AI assistant documentation with instructions for maintaining developer preferences
|
||||
* Updated: WordPress.org documentation with correct plugin slug and version numbers
|
||||
|
||||
### 2.2.3
|
||||
* Improved: Moved admin-specific files to admin/lib directory for better organization
|
||||
* Improved: Updated namespaces to reflect the new file locations
|
||||
* Added: Comprehensive folder structure documentation
|
||||
* Fixed: File references in the main plugin file
|
||||
|
||||
### 2.2.2-stable
|
||||
* Changed: Renamed includes files to lowercase for consistency with the rest of the codebase
|
||||
* Removed: Redundant Git Updater patches and version-fix.js as they're no longer needed
|
||||
* Improved: Documentation for Git Updater integration and release process
|
||||
* Fixed: Token-efficient documentation with references to .ai-workflows files
|
||||
* Added: Comprehensive release process documentation with emphasis on merging to main branch
|
||||
|
||||
### 2.2.1
|
||||
* Changed: Commented out version-fix.js script as it's no longer needed after refactoring
|
||||
* Fixed: Version consistency across all files
|
||||
|
||||
### 2.2.0
|
||||
* Added: Completely refactored plugin to use OOP best practices
|
||||
* Added: New class structure with proper namespaces
|
||||
|
@ -1,75 +0,0 @@
|
||||
/**
|
||||
* Fix Plugin Version Display
|
||||
*
|
||||
* This script directly modifies the plugin details popup to show the correct version
|
||||
* when the popup is opened for our plugin.
|
||||
*/
|
||||
(function($) {
|
||||
'use strict';
|
||||
|
||||
// Current plugin version - this should match the version in the main plugin file
|
||||
const CURRENT_VERSION = '2.2.0';
|
||||
|
||||
// Plugin slugs to check for
|
||||
const OUR_SLUGS = ['wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices'];
|
||||
|
||||
// Function to fix the version in the plugin details popup
|
||||
function fixPluginDetailsVersion() {
|
||||
// Check if we're on the plugins page
|
||||
if (window.location.href.indexOf('plugins.php') === -1) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Wait for the thickbox to be initialized
|
||||
$(document).on('tb_init', function() {
|
||||
// Set a timeout to allow the thickbox content to load
|
||||
setTimeout(function() {
|
||||
// Get the thickbox iframe
|
||||
const $iframe = $('#TB_iframeContent');
|
||||
if (!$iframe.length) return;
|
||||
|
||||
// Wait for iframe to load
|
||||
$iframe.on('load', function() {
|
||||
try {
|
||||
const iframeDoc = this.contentDocument || this.contentWindow.document;
|
||||
|
||||
// Get the plugin title from the iframe
|
||||
const $title = $(iframeDoc).find('h2.plugin-title');
|
||||
if (!$title.length) return;
|
||||
|
||||
// Check if this is our plugin
|
||||
const titleText = $title.text();
|
||||
if (titleText.indexOf('Fix \'Plugin file does not exist\' Notices') !== -1) {
|
||||
console.log('Found our plugin in the details popup, fixing version...');
|
||||
|
||||
// Find the version element
|
||||
const $version = $(iframeDoc).find('.plugin-version-author-uri');
|
||||
if ($version.length) {
|
||||
// Update the version text
|
||||
const versionText = $version.text();
|
||||
const newVersionText = versionText.replace(/Version: [0-9.]+|Version: 0\.0\.0/, 'Version: ' + CURRENT_VERSION);
|
||||
$version.text(newVersionText);
|
||||
console.log('Updated version to: ' + CURRENT_VERSION);
|
||||
}
|
||||
|
||||
// Also update the version in the header if it exists
|
||||
const $versionHeader = $(iframeDoc).find('.wrap h2:contains("Version:")');
|
||||
if ($versionHeader.length) {
|
||||
$versionHeader.text('Version: ' + CURRENT_VERSION);
|
||||
console.log('Updated version header to: ' + CURRENT_VERSION);
|
||||
}
|
||||
}
|
||||
} catch (e) {
|
||||
console.error('Error updating plugin version:', e);
|
||||
}
|
||||
});
|
||||
}, 500);
|
||||
});
|
||||
}
|
||||
|
||||
// Initialize when the document is ready
|
||||
$(document).ready(function() {
|
||||
fixPluginDetailsVersion();
|
||||
});
|
||||
|
||||
})(jQuery);
|
@ -5,7 +5,7 @@
|
||||
* @package WPALLSTARS\FixPluginDoesNotExistNotices
|
||||
*/
|
||||
|
||||
namespace WPALLSTARS\FixPluginDoesNotExistNotices;
|
||||
namespace WPALLSTARS\FixPluginDoesNotExistNotices\Admin;
|
||||
|
||||
/**
|
||||
* Admin Class
|
||||
@ -17,14 +17,14 @@ class Admin {
|
||||
/**
|
||||
* Core instance
|
||||
*
|
||||
* @var Core
|
||||
* @var \WPALLSTARS\FixPluginDoesNotExistNotices\Core
|
||||
*/
|
||||
private $core;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param Core $core Core instance.
|
||||
* @param \WPALLSTARS\FixPluginDoesNotExistNotices\Core $core Core instance.
|
||||
*/
|
||||
public function __construct($core) {
|
||||
$this->core = $core;
|
||||
@ -45,7 +45,9 @@ class Admin {
|
||||
return;
|
||||
}
|
||||
|
||||
// Always load our version fix script on the plugins page
|
||||
// Version fix script is no longer needed after refactoring
|
||||
// Commented out for testing
|
||||
/*
|
||||
wp_enqueue_script(
|
||||
'fpden-version-fix',
|
||||
FPDEN_PLUGIN_URL . 'admin/js/version-fix.js',
|
||||
@ -53,6 +55,7 @@ class Admin {
|
||||
FPDEN_VERSION,
|
||||
true // Load in footer
|
||||
);
|
||||
*/
|
||||
|
||||
// Get invalid plugins to decide if other assets are needed
|
||||
$invalid_plugins = $this->core->get_invalid_plugins();
|
@ -5,7 +5,7 @@
|
||||
* @package WPALLSTARS\FixPluginDoesNotExistNotices
|
||||
*/
|
||||
|
||||
namespace WPALLSTARS\FixPluginDoesNotExistNotices;
|
||||
namespace WPALLSTARS\FixPluginDoesNotExistNotices\Admin;
|
||||
|
||||
/**
|
||||
* Modal Class
|
2
build.sh
2
build.sh
@ -43,6 +43,8 @@ mkdir -p $BUILD_DIR/admin/css
|
||||
cp -r admin/css/* $BUILD_DIR/admin/css/
|
||||
mkdir -p $BUILD_DIR/admin/js
|
||||
cp -r admin/js/* $BUILD_DIR/admin/js/
|
||||
mkdir -p $BUILD_DIR/admin/lib
|
||||
cp -r admin/lib/* $BUILD_DIR/admin/lib/
|
||||
|
||||
# Create assets directory structure
|
||||
mkdir -p $BUILD_DIR/assets
|
||||
|
@ -52,7 +52,7 @@ class Plugin {
|
||||
/**
|
||||
* Admin functionality instance
|
||||
*
|
||||
* @var Admin
|
||||
* @var Admin\Admin
|
||||
*/
|
||||
private $admin;
|
||||
|
||||
@ -110,9 +110,9 @@ class Plugin {
|
||||
}
|
||||
|
||||
// Load required files
|
||||
require_once $this->plugin_dir . 'includes/Core.php';
|
||||
require_once $this->plugin_dir . 'includes/Admin.php';
|
||||
require_once $this->plugin_dir . 'includes/Modal.php';
|
||||
require_once $this->plugin_dir . 'includes/core.php';
|
||||
require_once $this->plugin_dir . 'admin/lib/admin.php';
|
||||
require_once $this->plugin_dir . 'admin/lib/modal.php';
|
||||
}
|
||||
|
||||
/**
|
||||
@ -125,7 +125,7 @@ class Plugin {
|
||||
$this->core = new Core();
|
||||
|
||||
// Initialize admin functionality
|
||||
$this->admin = new Admin($this->core);
|
||||
$this->admin = new Admin\Admin($this->core);
|
||||
|
||||
// Initialize Git Updater fixes
|
||||
$this->init_git_updater_fixes();
|
||||
@ -136,158 +136,23 @@ class Plugin {
|
||||
}
|
||||
|
||||
// Initialize the modal for update source selection
|
||||
new Modal();
|
||||
new Admin\Modal();
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize Git Updater fixes
|
||||
*
|
||||
* This function adds filters to fix Git Updater's handling of 'main' vs 'master' branches
|
||||
* This function previously added filters to fix Git Updater's handling of 'main' vs 'master' branches.
|
||||
* These fixes are no longer needed with proper plugin headers.
|
||||
* See: https://git-updater.com/knowledge-base/required-headers/
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function init_git_updater_fixes() {
|
||||
// Fix for Git Updater looking for 'master' branch instead of 'main'
|
||||
add_filter('gu_get_repo_branch', array($this, 'override_branch'), 999, 3);
|
||||
|
||||
// Fix for Git Updater API URLs
|
||||
add_filter('gu_get_repo_api', array($this, 'override_api_url'), 999, 3);
|
||||
|
||||
// Fix for Git Updater download URLs
|
||||
add_filter('gu_download_link', array($this, 'override_download_link'), 999, 3);
|
||||
|
||||
// Fix for Git Updater repository metadata
|
||||
add_filter('gu_get_repo_meta', array($this, 'override_repo_meta'), 999, 2);
|
||||
|
||||
// Fix for Git Updater API responses
|
||||
add_filter('gu_api_repo_type_data', array($this, 'override_repo_type_data'), 999, 3);
|
||||
// No fixes needed - we're using the proper plugin headers
|
||||
// Git Updater reads version information from the readme.txt file in the main branch
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the branch name for our plugin
|
||||
*
|
||||
* @param string $branch The current branch name
|
||||
* @param string $git The git service (github, gitlab, etc.)
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return string The modified branch name
|
||||
*/
|
||||
public function override_branch($branch, $git, $repo = null) {
|
||||
// If repo is null or not an object, just return the branch unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $branch;
|
||||
}
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
return 'main';
|
||||
}
|
||||
return $branch;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the API URL for our plugin
|
||||
*
|
||||
* @param mixed $api_url The current API URL (can be string or object)
|
||||
* @param string $git The git service (github, gitlab, etc.)
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return mixed The modified API URL (same type as input)
|
||||
*/
|
||||
public function override_api_url($api_url, $git, $repo = null) {
|
||||
// If repo is null or not an object, just return the URL unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $api_url;
|
||||
}
|
||||
|
||||
// Check if this is our plugin
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
|
||||
// Only apply str_replace if $api_url is a string
|
||||
if (is_string($api_url)) {
|
||||
return str_replace('/master/', '/main/', $api_url);
|
||||
}
|
||||
|
||||
// If $api_url is an object, just return it unchanged
|
||||
// This handles the case where Git Updater passes a GitHub_API object
|
||||
return $api_url;
|
||||
}
|
||||
|
||||
// Return unchanged if not our plugin
|
||||
return $api_url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the download link for our plugin
|
||||
*
|
||||
* @param string $download_link The current download link
|
||||
* @param string $git The git service (github, gitlab, etc.)
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return string The modified download link
|
||||
*/
|
||||
public function override_download_link($download_link, $git, $repo = null) {
|
||||
// If repo is null or not an object, just return the link unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $download_link;
|
||||
}
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
return str_replace('/master.zip', '/main.zip', $download_link);
|
||||
}
|
||||
return $download_link;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override repository metadata for our plugin
|
||||
*
|
||||
* @param array $repo_meta The repository metadata
|
||||
* @param object $repo The repository object
|
||||
* @return array The modified repository metadata
|
||||
*/
|
||||
public function override_repo_meta($repo_meta, $repo) {
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
|
||||
// Set the correct repository information
|
||||
$repo_meta['github_updater_repo'] = 'wp-fix-plugin-does-not-exist-notices';
|
||||
$repo_meta['github_updater_branch'] = 'main';
|
||||
$repo_meta['github_updater_api'] = 'https://api.github.com';
|
||||
$repo_meta['github_updater_raw'] = 'https://raw.githubusercontent.com/wpallstars/wp-fix-plugin-does-not-exist-notices/main';
|
||||
}
|
||||
return $repo_meta;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override repository type data for our plugin
|
||||
*
|
||||
* @param array $data The repository data
|
||||
* @param object $response The API response
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return array The modified repository data
|
||||
*/
|
||||
public function override_repo_type_data($data, $response, $repo = null) {
|
||||
// If repo is null or not an object, just return the data unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $data;
|
||||
}
|
||||
|
||||
// Check if this is our plugin
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
|
||||
// Set the correct branch
|
||||
if (isset($data['branch'])) {
|
||||
$data['branch'] = 'main';
|
||||
}
|
||||
|
||||
// Set the correct version
|
||||
if (isset($data['version'])) {
|
||||
$data['version'] = FPDEN_VERSION;
|
||||
}
|
||||
}
|
||||
return $data;
|
||||
}
|
||||
// Git Updater override methods have been removed as they're no longer needed
|
||||
// We now use the proper plugin headers for Git Updater integration
|
||||
}
|
||||
|
@ -2,14 +2,14 @@
|
||||
# This file is distributed under the GPL-2.0+.
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Fix 'Plugin file does not exist' Notices 2.1.1\n"
|
||||
"Project-Id-Version: Fix 'Plugin file does not exist' Notices 2.4.0\n"
|
||||
"Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/wp-fix-plugin-does-not-exist-notices\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"POT-Creation-Date: 2025-04-13T00:00:00+00:00\n"
|
||||
"POT-Creation-Date: 2025-04-17T00:00:00+00:00\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"X-Generator: WP-CLI 2.9.0\n"
|
||||
"X-Domain: wp-fix-plugin-does-not-exist-notices\n"
|
||||
|
49
readme.txt
49
readme.txt
@ -3,9 +3,9 @@ Contributors: surferking, wpallstars
|
||||
Donate link: https://www.wpallstars.com/
|
||||
Tags: plugins, missing plugins, cleanup, error fix, admin tools, plugin file does not exist, wordpress error, plugin error, deactivated plugin, remove plugin reference, fix plugin error, plugin does not exist, plugin file does not exist error
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.7.2
|
||||
Tested up to: 6.8
|
||||
Requires PHP: 7.0
|
||||
Stable tag: 2.2.0
|
||||
Stable tag: 2.4.0
|
||||
License: GPL-2.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
@ -179,6 +179,51 @@ Manually editing the WordPress database is risky and requires technical knowledg
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 2.4.0 =
|
||||
* Added: Comprehensive documentation for working in multi-repository workspaces
|
||||
* Added: Guidelines to prevent feature hallucination in multi-repo environments
|
||||
* Added: New .ai-workflows/multi-repo-workspace.md file with detailed best practices
|
||||
* Improved: AI assistant documentation with repository context verification
|
||||
* Improved: Wiki documentation to accurately reflect plugin functionality
|
||||
|
||||
= 2.3.1 =
|
||||
* Updated: Tested compatibility with WordPress 6.8
|
||||
* Improved: Documentation to reflect WordPress 6.8 compatibility
|
||||
|
||||
= 2.3.0 =
|
||||
* Added: Improved time-efficient development workflow documentation
|
||||
* Added: New git workflow guidelines for better branch management
|
||||
* Added: Comprehensive incremental development approach
|
||||
* Improved: Documentation for local vs. remote testing
|
||||
* Improved: Version management process for more efficient development
|
||||
|
||||
= 2.2.5 =
|
||||
* Added: Documentation for the developer preferences memory file in .ai-workflows/
|
||||
* Improved: AI assistant instructions for maintaining developer preferences
|
||||
* Updated: Version numbers across all files for consistency
|
||||
|
||||
= 2.2.4 =
|
||||
* Added: Developer preferences memory file for AI assistants
|
||||
* Improved: AI assistant documentation with instructions for maintaining developer preferences
|
||||
* Updated: WordPress.org documentation with correct plugin slug and version numbers
|
||||
|
||||
= 2.2.3 =
|
||||
* Improved: Moved admin-specific files to admin/lib directory for better organization
|
||||
* Improved: Updated namespaces to reflect the new file locations
|
||||
* Added: Comprehensive folder structure documentation
|
||||
* Fixed: File references in the main plugin file
|
||||
|
||||
= 2.2.2-stable =
|
||||
* Changed: Renamed includes files to lowercase for consistency with the rest of the codebase
|
||||
* Removed: Redundant Git Updater patches and version-fix.js as they're no longer needed
|
||||
* Improved: Documentation for Git Updater integration and release process
|
||||
* Fixed: Token-efficient documentation with references to .ai-workflows files
|
||||
* Added: Comprehensive release process documentation with emphasis on merging to main branch
|
||||
|
||||
= 2.2.1 =
|
||||
* Changed: Commented out version-fix.js script as it's no longer needed after refactoring
|
||||
* Fixed: Version consistency across all files
|
||||
|
||||
= 2.2.0 =
|
||||
* Added: Completely refactored plugin to use OOP best practices
|
||||
* Added: New class structure with proper namespaces
|
||||
|
@ -3,7 +3,7 @@
|
||||
* Plugin Name: Fix 'Plugin file does not exist' Notices
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references.
|
||||
* Version: 2.2.0
|
||||
* Version: 2.4.0
|
||||
* Author: Marcus Quinn & The WPALLSTARS Team
|
||||
* Author URI: https://www.wpallstars.com
|
||||
* License: GPL-2.0+
|
||||
@ -15,8 +15,14 @@
|
||||
* Primary Branch: main
|
||||
* Release Branch: main
|
||||
* Release Asset: true
|
||||
* Requires at least: 5.0
|
||||
* Requires PHP: 7.0
|
||||
* Update URI: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
*
|
||||
* Gitea Plugin URI: https://gitea.wpallstars.com/wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
* Gitea Branch: main
|
||||
* Gitea Languages: languages
|
||||
*
|
||||
* @package WPALLSTARS\FixPluginDoesNotExistNotices
|
||||
*/
|
||||
|
||||
@ -26,7 +32,8 @@ if (!defined('WPINC')) {
|
||||
}
|
||||
|
||||
// Load the main plugin class
|
||||
require_once plugin_dir_path(__FILE__) . 'includes/Plugin.php';
|
||||
require_once plugin_dir_path(__FILE__) . 'includes/plugin.php';
|
||||
|
||||
// Initialize the plugin
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.0');
|
||||
// This is a test change for our new workflow
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.4.0');
|
||||
|
Reference in New Issue
Block a user