Repository navigation
Move functions.php into includes/ and use require/require_once - #50
Merged
Merged
Conversation
Relocates the functions.php helper library into includes/ (updating cycle.php's reference and the moved file's own setup.php include to ../setup.php) and switches every file inclusion from include/include_once to require/require_once for fail-fast consistency. This plugin has no database schema, so there is no includes/database.php.
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The translation template has stale source paths, and the required changelog entry is missing.
Review effort: Balanced
Findings: 1
What changed in this PR
Relocates shared helpers into includes/ and standardizes dependency loading with fail-fast require_once.
Changes:
- Moves
functions.phpintoincludes/. - Updates PHP dependency paths and loading statements.
- Documents the new structure and inclusion convention.
| File | Description |
|---|---|
includes/functions.php |
Updates the setup.php path after relocation. |
cycle.php |
Loads dependencies with require_once from the new path. |
.github/copilot-instructions.md |
Documents the layout and inclusion convention. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
TheWitness
requested review from
bmfmancini,
browniebraun,
cigamit and
xmacan
September 30, 2026 02:54
Member
Author
|
This branch now also sets the plugin's |
browniebraun
previously approved these changes
Sep 30, 2026
…cludes-database # Conflicts: # CHANGELOG.md
phpunit.xml ships in the repo for CI but is a dev-only test artifact, so it is removed from manifest.json 'expected', pruned from installs on upgrade (like tests/), and excluded from the manifest drift check. The retired markdown-lint configs (.mdlrc, .md_style.rb) are deleted, and .md* is now ignored like .git*: protected from pruning and excluded from drift if it reappears.
The upgrade-time prune now rejects any tombstone containing '.'/'..' segments (which could escape the plugin directory or resolve to its root) and treats ancestors of whitelist entries as protected, so a tombstone on a parent directory can no longer delete a whitelisted file beneath it.
The trailing '# ...' comments in the Project Structure block drifted further right down the tree; align them all to a single column.
- Use the full license header (from the plugin's own setup.php) in tests/Unit/PruneFilesTest.php instead of the abbreviated copyright banner. - Document that the manifest drift check and the upgrade-time prune also handle phpunit.xml and .md* files, matching the implemented behavior.
The repository naming contract reserves the plugin_<name>_ prefix for plugin lifecycle / hook-registration functions; all other functions use the plain <name>_ prefix. Rename the internal upgrade helpers accordingly: plugin_<name>_prune_files() -> <name>_prune_files() plugin_<name>_rmtree() -> <name>_rmtree() The call site, unit tests, and the copilot-instructions.md references are updated to match. No behavioral change.
cigamit
approved these changes
Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Move functions.php into includes/, add the fleet file manifest
Adds the fleet-wide
manifest.json+ upgrade-time file-pruning mechanism.manifest.jsonwithtombstones(empty),expected(top-level files/directories shipping today, directories with a trailing/), andwhitelist(empty).cycle_prune_files()(insetup.php, called from the version-change block ofcycle_check_upgrade()) removes the dev-onlytests/tree on upgrade, refuses any path that resolves outside the plugin directory (a tamperedmanifest.json), warns on any file/directory it cannot remove, leaveswhitelist/.git*alone, and logs — without removing — any top-level entry the manifest does not account for.tests/bin/validate-manifest.php(wired intoplugin-ci-workflow.yml) fails on drift betweenexpectedand the real top-level tree.PruneFilesTest; sandboxedbase_pathin theCycleLifecycleTestversion-drift case (a copy of the real INFO keeps the asserted params identical) so the prune runs against a throwaway tree.Validation
Full Pest suite green (34 passed) and patch-coverage passes at 100% (66/66 changed measured lines); manifest drift-check passes and the translation template is up to date.
Revision: hardening & fleet cleanup
Since the initial description, this PR also:
phpunit.xmlon upgrade (alongside the dev-onlytests/tree) and leaves.md*lint configs in place — the drift check now ignorestests/,phpunit.xml,.git*,.md*, and whitelisted paths../..traversal segment or resolves outside the plugin directory (including via a symlinked directory), and protects a directory when a whitelisted entry lives beneath it — each with added unit coverage.cycle_prune_files()/cycle_rmtree()(theplugin_cycle_prefix is reserved for lifecycle/hook-registration functions).tests/Unit/PruneFilesTest.phpthe full standard GPL v2 header and aligns the Project Structure block in.github/copilot-instructions.md.