Jonathan Miller
1799401db5
Branch Policy Check / Verify merge target (pull_request) Successful in 1s
- Add Copyright + FILE INFORMATION headers to 11 PHP enterprise classes - Add FILE INFORMATION blocks to 9 PHP files with incomplete headers - Add headers to 2 test files - Add markdown comment headers to 27 index/README files - Add headers to 5 root markdown files - Add FILE INFORMATION to 4 files with existing but incomplete headers All files now conform to moko-platform file header standard. Authored-by: Moko Consulting Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
94 lines
2.6 KiB
Markdown
94 lines
2.6 KiB
Markdown
<!--
|
|
Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
|
SPDX-License-Identifier: GPL-3.0-or-later
|
|
FILE INFORMATION
|
|
DEFGROUP: MokoStandards.Root
|
|
INGROUP: MokoStandards
|
|
REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
|
PATH: /PLUGIN_SCRIPTS.md
|
|
BRIEF: Plugin system CLI documentation
|
|
-->
|
|
|
|
# Plugin System CLI Scripts
|
|
|
|
Command-line scripts for validating, health checking, and managing projects using the MokoStandards plugin system.
|
|
|
|
## Available Scripts
|
|
|
|
| Script | Purpose |
|
|
|--------|---------|
|
|
| `plugin_validate.php` | Validate project structure and configuration |
|
|
| `plugin_health_check.php` | Run comprehensive health checks |
|
|
| `plugin_metrics.php` | Collect project metrics |
|
|
| `plugin_readiness.php` | Check release readiness |
|
|
| `plugin_list.php` | List all available plugins |
|
|
|
|
## Quick Examples
|
|
|
|
```bash
|
|
# List all available plugins
|
|
php api/plugin_list.php
|
|
|
|
# Validate a project (auto-detect type)
|
|
php api/plugin_validate.php --project-path /path/to/project
|
|
|
|
# Run health check
|
|
php api/plugin_health_check.php --project-path /path/to/project
|
|
|
|
# Collect metrics
|
|
php api/plugin_metrics.php --project-path /path/to/project --format table
|
|
|
|
# Check release readiness
|
|
php api/plugin_readiness.php --project-path /path/to/project
|
|
```
|
|
|
|
## Supported Project Types
|
|
|
|
- **joomla** - Joomla CMS projects and extensions
|
|
- **wordpress** - WordPress themes and plugins
|
|
- **nodejs** - Node.js applications and packages
|
|
- **python** - Python applications and packages
|
|
- **terraform** - Infrastructure as Code
|
|
- **mobile** - Mobile applications (iOS/Android)
|
|
- **api** - REST API and GraphQL services
|
|
- **dolibarr** - Dolibarr ERP/CRM modules
|
|
- **documentation** - Documentation projects
|
|
- **generic** - Generic project types
|
|
|
|
## Exit Codes
|
|
|
|
- **0** - Success
|
|
- **1** - Validation/check failed
|
|
- **2** - Script error (invalid arguments, plugin not found)
|
|
|
|
## Documentation
|
|
|
|
For detailed documentation, see:
|
|
- [Plugin Validation Workflow Templates](../templates/workflows/README.md)
|
|
- [Plugin System Implementation](lib/Enterprise/README.md)
|
|
- Script help: `php api/plugin_*.php --help`
|
|
|
|
## Integration
|
|
|
|
These scripts integrate with:
|
|
- GitHub Actions workflows (see `templates/workflows/`)
|
|
- Plugin system (see `lib/Enterprise/`)
|
|
- CI/CD pipelines (GitLab CI, Jenkins, etc.)
|
|
|
|
## Usage in CI/CD
|
|
|
|
```yaml
|
|
# GitHub Actions example
|
|
- name: Validate project
|
|
run: |
|
|
php api/plugin_validate.php --project-path . --json > validation.json
|
|
if jq -e '.valid == false' validation.json > /dev/null; then
|
|
exit 1
|
|
fi
|
|
```
|
|
|
|
For complete usage examples and documentation, run any script with `--help`:
|
|
```bash
|
|
php api/plugin_validate.php --help
|
|
```
|