MokoConsulting/moko-platform
1
0
Fork 0
Code Issues 6 Pull Requests 1 Releases 8 Wiki Activity

refactor: consolidate CLIApp + CliBase into CliFramework #234

New Issue
Closed
opened 2026-05-31 14:19:34 +00:00 by jmiller · 3 comments
jmiller commented 2026-05-31 14:19:34 +00:00
Owner
Copy Link
Copy Source

Problem

Three overlapping base classes exist for CLI tools:

  1. CliFramework (lib/Enterprise/CliFramework.php, lines 703-1461) - Current standard
  2. CLIApp (lib/Enterprise/CliFramework.php, lines 30-702) - Legacy, same file
  3. CliBase (lib/CliBase.php, 595 lines) - Separate lightweight alternative

Both CliBase and CLIApp duplicate features already in CliFramework: progress bars, banners, colored output, argument parsing.

Impact

  • ~1,300 lines of redundant code
  • Confusion about which base class to use
  • Inconsistent feature sets across tools

Proposal

  1. Migrate any unique CliBase/CLIApp features into CliFramework
  2. Update all tools that extend CLIApp or CliBase to extend CliFramework
  3. Remove CLIApp class and CliBase.php
  4. Update CLAUDE.md to reflect single base class

Acceptance Criteria

  • Single base class: CliFramework
  • CLIApp removed from CliFramework.php
  • CliBase.php deleted
  • All tools compile and run with new base class
  • No functionality regression
## Problem Three overlapping base classes exist for CLI tools: 1. **CliFramework** (lib/Enterprise/CliFramework.php, lines 703-1461) - Current standard 2. **CLIApp** (lib/Enterprise/CliFramework.php, lines 30-702) - Legacy, same file 3. **CliBase** (lib/CliBase.php, 595 lines) - Separate lightweight alternative Both CliBase and CLIApp duplicate features already in CliFramework: progress bars, banners, colored output, argument parsing. ## Impact - ~1,300 lines of redundant code - Confusion about which base class to use - Inconsistent feature sets across tools ## Proposal 1. Migrate any unique CliBase/CLIApp features into CliFramework 2. Update all tools that extend CLIApp or CliBase to extend CliFramework 3. Remove CLIApp class and CliBase.php 4. Update CLAUDE.md to reflect single base class ## Acceptance Criteria - [ ] Single base class: CliFramework - [ ] CLIApp removed from CliFramework.php - [ ] CliBase.php deleted - [ ] All tools compile and run with new base class - [ ] No functionality regression
jmiller added the phppriority: medium labels 2026-05-31 14:19:34 +00:00
jmiller commented 2026-05-31 14:19:36 +00:00
Author
Owner
Copy Link
Copy Source

Branch created: feature/234-refactor-consolidate-cliapp-clibase-into

git fetch origin
git checkout feature/234-refactor-consolidate-cliapp-clibase-into
Branch created: [`feature/234-refactor-consolidate-cliapp-clibase-into`](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/src/branch/feature/234-refactor-consolidate-cliapp-clibase-into) ```bash git fetch origin git checkout feature/234-refactor-consolidate-cliapp-clibase-into ```
jmiller commented 2026-05-31 15:36:55 +00:00
Author
Owner
Copy Link
Copy Source

Partial progress:

CliBase migration complete:

  • All 4 fix/ scripts migrated from CliBase → CliFramework
  • CliBase now has zero consumers in the codebase (only referenced in template for client repos)
  • CliBase.php can be safely deprecated

CLIApp still used by:

  • deploy/deploy-sftp.php (578 lines)
  • cli/deploy_joomla.php (1130 lines)

These are complex deployment scripts — migrating them requires careful testing. Leaving this issue open for the remaining CLIApp → CliFramework migration.

CliFramework enhancements added:

  • confirm() method (was in CLIApp/CliBase but missing from CliFramework)
  • input(), select(), table() interactive methods
  • jsonOutput() standard JSON envelope
  • EXIT_* constants
Partial progress: **CliBase migration complete:** - All 4 `fix/` scripts migrated from CliBase → CliFramework - CliBase now has zero consumers in the codebase (only referenced in template for client repos) - CliBase.php can be safely deprecated **CLIApp still used by:** - `deploy/deploy-sftp.php` (578 lines) - `cli/deploy_joomla.php` (1130 lines) These are complex deployment scripts — migrating them requires careful testing. Leaving this issue open for the remaining CLIApp → CliFramework migration. **CliFramework enhancements added:** - `confirm()` method (was in CLIApp/CliBase but missing from CliFramework) - `input()`, `select()`, `table()` interactive methods - `jsonOutput()` standard JSON envelope - `EXIT_*` constants
jmiller commented 2026-05-31 15:56:00 +00:00
Author
Owner
Copy Link
Copy Source

Consolidation complete.

Changes:

  • deploy/deploy-sftp.php — migrated from CLIApp → CliFramework (getOption→getArgument, log order fix)
  • cli/deploy_joomla.php — migrated from CLIApp → CliFramework (same pattern)
  • fix/fix_*.php — 4 scripts already migrated in previous commit
  • tests/test_enterprise_libraries.php — updated to use CliFramework
  • lib/Enterprise/CliFramework.php — removed 673-line CLIApp body, replaced with 40-line compatibility shim
  • CLIApp now extends CliFramework with bridge methods (getOption→getArgument, setupArguments→configure)
  • CliFramework.php reduced from ~1500 → ~1030 lines

No scripts depend on CLIApp directly anymore. The shim exists only for backward compatibility with client repos that may still reference it.

CliBase status: Zero consumers in codebase (only template reference). Can be deleted when ready.

27 tests pass, 44 assertions.

Consolidation complete. **Changes:** - `deploy/deploy-sftp.php` — migrated from CLIApp → CliFramework (getOption→getArgument, log order fix) - `cli/deploy_joomla.php` — migrated from CLIApp → CliFramework (same pattern) - `fix/fix_*.php` — 4 scripts already migrated in previous commit - `tests/test_enterprise_libraries.php` — updated to use CliFramework - `lib/Enterprise/CliFramework.php` — removed 673-line CLIApp body, replaced with 40-line compatibility shim - CLIApp now extends CliFramework with bridge methods (getOption→getArgument, setupArguments→configure) - CliFramework.php reduced from ~1500 → ~1030 lines **No scripts depend on CLIApp directly anymore.** The shim exists only for backward compatibility with client repos that may still reference it. **CliBase status:** Zero consumers in codebase (only template reference). Can be deleted when ready. **27 tests pass, 44 assertions.**
Sign in to join this conversation.
Labels
Clear labels
automation
Automated processes or scripts
 breaking-change
Breaking API or functionality change
 build
Build system changes
 ci-cd
CI/CD pipeline changes
 config
Configuration file changes
 css
CSS/styling changes
 dependencies
Dependency updates
 deploy-failure
Automated deploy failure tracking
 docker
Docker configuration changes
 documentation
Documentation changes
 dolibarr
Dolibarr module or extension
 generic
Generic project or library
 good first issue
Good for newcomers
 health-check
Repository health check results
 health: excellent
Health score 90-100
 health: fair
Health score 50-69
 health: good
Health score 70-89
 health: poor
Health score below 50
 help wanted
Extra attention needed
 html
HTML template changes
 javascript
JavaScript code changes
 joomla
Joomla extension or component
 mokostandards
MokoStandards compliance
 needs-review
Awaiting code review
 php
PHP code changes
 priority: critical
Critical priority, must be addressed immediately
 priority: high
High priority
 priority: low
Low priority
 priority: medium
Medium priority
 push-failure
File push failure requiring attention
 python
Python code changes
 security
Security-related changes
 size/l
Large change (101-300 lines)
 size/m
Medium change (31-100 lines)
 size/s
Small change (11-30 lines)
 size/xl
Extra large change (301-1000 lines)
 size/xs
Extra small change (1-10 lines)
 size/xxl
Extremely large change (1000+ lines)
 standards-drift
Repository drifted from MokoStandards
 standards-update
MokoStandards sync update
 status: blocked
Blocked by another issue or dependency
 status: in-progress
Currently being worked on
 status: needs-review
Awaiting code review
 status: on-hold
Temporarily on hold
 status: pending
Pending action or decision
 status: wontfix
This will not be worked on
 sync-failure
Bulk sync failure requiring attention
 sync-report
Bulk sync run report
 template-validation-failure
Template workflow validation failure
 tests
Test suite changes
 type: bug
Something isn't working
 type: chore
Maintenance tasks
 type: enhancement
Enhancement to existing feature
 type: feature
New feature or request
 type: refactor
Code refactoring
 type: version
Version-related change
 typescript
TypeScript code changes
 version
Version bump or release
 version-drift
Version mismatch detected
 work-in-progress
Work in progress, not ready for merge
bug
Something is not working
 chore
Maintenance and housekeeping
 documentation
Documentation improvements
 enhancement
Improvement to existing functionality
 feature
New feature or request
 pending: dependency
Blocked by another issue or external dependency
 pending: deployment
Tested and approved, awaiting deployment to production
 pending: design
Needs UI/UX or architecture design before implementation
 pending: documentation
Feature works, needs documentation/wiki update
 pending: feedback
Awaiting feedback or decision from stakeholder
 pending: review
Implementation complete, awaiting code review
 pending: testing
Feature implemented but not yet tested
 priority: critical
Must fix immediately
 priority: high
Should fix soon
 priority: low
Nice to have
 priority: medium
Fix when convenient
 refactor
Code restructuring without behavior change
 roadmap
Planned feature or enhancement tracked on the roadmap
 scope: client
Client-specific work
 scope: dolibarr
Dolibarr modules and customizations
 scope: infrastructure
Server, CI, backups, monitoring
 scope: joomla
Joomla templates and extensions
 scope: waas
MokoWaaS platform
 security
Security vulnerability or hardening
 status: blocked
Waiting on external dependency
 status: duplicate
Duplicate of another issue
 status: in-progress
Being worked on
 status: needs-review
Ready for review
 status: wontfix
Will not be addressed
No labels php priority: medium
Milestone
No items
No Milestone
Assignees
Clear assignees
jmiller (Jonathan Miller)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: MokoConsulting/moko-platform#234
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?