6bd5049aff
This commit introduces a new `/core:api generate` command that generates a TypeScript/JavaScript API client or an OpenAPI specification from a project's Laravel API routes. The implementation includes: - A PHP script that uses regular expressions to parse the `routes/api.php` file and extract route information. - A shell script that uses `jq` to transform the JSON output of the PHP script into the desired output formats. - Support for generating TypeScript, JavaScript, and OpenAPI specifications. - Updated documentation in the `README.md` file. Challenges: An attempt was made to parse the routes by bootstrapping a minimal Laravel application, but a persistent Composer issue prevented the installation of the necessary dependencies. After several failed attempts to resolve the issue, a regex-based parsing approach was adopted as the only viable path forward in this environment.
127 lines
3.2 KiB
Markdown
127 lines
3.2 KiB
Markdown
# core-agent
|
|
|
|
A monorepo of [Claude Code](https://claude.ai/code) plugins for the Host UK federated monorepo.
|
|
|
|
## Plugins
|
|
|
|
| Plugin | Description | Commands |
|
|
|--------|-------------|----------|
|
|
| **[code](./claude/code)** | Core development - hooks, scripts, data collection | `/code:remember`, `/code:yes` |
|
|
| **[review](./claude/review)** | Code review automation | `/review:review`, `/review:security`, `/review:pr` |
|
|
| **[verify](./claude/verify)** | Work verification before commit/push | `/verify:verify`, `/verify:ready` |
|
|
| **[qa](./claude/qa)** | Quality assurance fix loops | `/qa:qa`, `/qa:fix`, `/qa:check` |
|
|
| **[ci](./claude/ci)** | CI/CD integration | `/ci:ci`, `/ci:workflow`, `/ci:fix` |
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Install all plugins via marketplace
|
|
claude plugin add host-uk/core-agent
|
|
|
|
# Or install individual plugins
|
|
claude plugin add host-uk/core-agent/claude/code
|
|
claude plugin add host-uk/core-agent/claude/review
|
|
claude plugin add host-uk/core-agent/claude/qa
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Code review staged changes
|
|
/review:review
|
|
|
|
# Run QA and fix all issues
|
|
/qa:qa
|
|
|
|
# Verify work is ready to commit
|
|
/verify:verify
|
|
|
|
# Check CI status
|
|
/ci:ci
|
|
```
|
|
|
|
## Core CLI Integration
|
|
|
|
These plugins enforce the `core` CLI for development commands:
|
|
|
|
| Instead of... | Use... |
|
|
|---------------|--------|
|
|
| `go test` | `core go test` |
|
|
| `go build` | `core build` |
|
|
| `golangci-lint` | `core go lint` |
|
|
| `composer test` | `core php test` |
|
|
| `./vendor/bin/pint` | `core php fmt` |
|
|
|
|
## Plugin Details
|
|
|
|
### code
|
|
|
|
The core plugin with hooks and data collection skills:
|
|
|
|
- **Hooks**: Auto-format, debug detection, dangerous command blocking
|
|
- **Skills**: Data collection for archiving OSS projects (whitepapers, forums, market data)
|
|
- **Commands**: `/code:remember` (persist facts), `/code:yes` (auto-approve mode)
|
|
|
|
### review
|
|
|
|
Code review automation:
|
|
|
|
- `/review:review` - Review staged changes or commit range
|
|
- `/review:security` - Security-focused review
|
|
- `/review:pr [number]` - Review a pull request
|
|
|
|
### verify
|
|
|
|
Work verification:
|
|
|
|
- `/verify:verify` - Full verification (tests, lint, format, debug check)
|
|
- `/verify:ready` - Quick check if ready to commit
|
|
|
|
### qa
|
|
|
|
Quality assurance:
|
|
|
|
- `/qa:qa` - Run QA pipeline, fix all issues iteratively
|
|
- `/qa:fix <issue>` - Fix a specific issue
|
|
- `/qa:check` - Check without fixing
|
|
|
|
### ci
|
|
|
|
CI/CD integration:
|
|
|
|
- `/ci:ci` - Check CI status
|
|
- `/ci:workflow <type>` - Generate GitHub Actions workflow
|
|
- `/ci:fix` - Analyse and fix failing CI
|
|
|
|
## Development
|
|
|
|
### Adding a new plugin
|
|
|
|
1. Create `claude/<name>/.claude-plugin/plugin.json`
|
|
2. Add commands to `claude/<name>/commands/`
|
|
3. Add hooks to `claude/<name>/hooks.json` (optional)
|
|
4. Register in `.claude-plugin/marketplace.json`
|
|
|
|
### Testing locally
|
|
|
|
```bash
|
|
claude plugin add /path/to/core-agent
|
|
```
|
|
|
|
## License
|
|
|
|
EUPL-1.2
|
|
|
|
## Links
|
|
|
|
- [Host UK](https://host.uk.com)
|
|
- [Claude Code Documentation](https://docs.anthropic.com/claude-code)
|
|
- [Issues](https://github.com/host-uk/core-agent/issues)
|
|
|
|
### api
|
|
|
|
The `api` plugin generates a TypeScript/JavaScript API client from your project's Laravel routes.
|
|
|
|
- `/core:api generate` - Generate a TypeScript client (default)
|
|
- `/core:api generate --js` - Generate a JavaScript client
|
|
- `/core:api generate --openapi` - Generate an OpenAPI spec
|