@git.zone/cli 6.6.2 → 6.7.2

package/readme.plan.md

@@ -1,176 +0,0 @@
-# GitZone Services Command Implementation Plan
-
-## Overview
-
-Implement the `gitzone services` command to manage MongoDB, ObjectStorage, and Elasticsearch containers for development projects.
-
-## Tasks
-
-### Module Structure Setup
-
-- [x] Create `ts/mod_services/` directory
-- [x] Create `mod.plugins.ts` with required imports
-- [x] Create `helpers.ts` with utility functions
-- [x] Create `classes.serviceconfiguration.ts` for config handling
-- [x] Create `classes.dockercontainer.ts` for Docker operations
-- [x] Create `classes.servicemanager.ts` for service management
-- [x] Create `index.ts` with main command logic
-
-### Core Functionality
-
-- [x] Implement ServiceConfiguration class
-  - [x] Load/create `.nogit/env.json` configuration
-  - [x] Generate random available ports (20000-30000 range)
-  - [x] Preserve existing custom values
-  - [x] Provide default values for missing fields
-
-- [x] Implement DockerContainer class
-  - [x] Check container status
-  - [x] Start/stop/restart containers
-  - [x] Execute Docker commands
-  - [x] Handle container logs
-  - [x] Manage volumes and port bindings
-
-- [x] Implement ServiceManager class
-  - [x] Manage MongoDB containers
-  - [x] Manage ObjectStorage containers
-  - [x] Handle container lifecycle
-  - [x] Generate project-specific container names
-  - [x] Manage data directories in `.nogit/`
-  - [x] Generate MongoDB Compass connection strings
-
-### Commands Implementation
-
-- [x] `start` command - Start enabled services or target mongo|objectstorage|s3|elasticsearch
-- [x] `stop` command - Stop all services or target mongo|objectstorage|s3|elasticsearch
-- [x] `restart` command - Stop all then start enabled services, or restart target mongo|objectstorage|s3|elasticsearch
-- [x] `status` command - Show service status
-- [x] `config` command - Show current configuration
-- [x] `compass` command - Show MongoDB Compass connection string
-- [x] `logs` command - Show service logs with line count
-- [x] `remove` command - Remove containers (preserve data)
-- [x] `clean` command - Remove containers and data
-
-### Integration
-
-- [x] Add `@push.rocks/smartshell` to main plugins.ts
-- [x] Add `@push.rocks/smartnetwork` to main plugins.ts
-- [x] Add `@push.rocks/smartinteract` to main plugins.ts
-- [x] Register services command in `gitzone.cli.ts`
-
-### Features
-
-- [x] Auto-configuration with smart defaults
-- [x] Random port assignment to avoid conflicts
-- [x] Project isolation with unique container names
-- [x] Data persistence in `.nogit/` directories
-- [x] Status display (running/stopped/not installed)
-- [x] Interactive confirmations for destructive operations
-- [x] Colored console output
-- [x] ObjectStorage bucket auto-creation and authenticated verification
-- [x] MongoDB Compass connection string with network IP
-
-### Testing
-
-- [x] Test service start/stop operations
-- [x] Test configuration creation and updates
-- [ ] Test port collision handling
-- [ ] Test data persistence
-- [ ] Test MongoDB Compass connection string generation
-- [ ] Test all command variations
-
-## Configuration Format
-
-```json
-{
-  "PROJECT_NAME": "derived-from-package-name",
-  "MONGODB_HOST": "localhost",
-  "MONGODB_NAME": "project-name",
-  "MONGODB_PORT": "random-port",
-  "MONGODB_USER": "defaultadmin",
-  "MONGODB_PASS": "defaultpass",
-  "MONGODB_URL": "derived connection URL",
-  "MONGODB_AUTH_ENABLED": true,
-  "S3_HOST": "localhost",
-  "S3_PORT": "random-port",
-  "S3_UI_PORT": "first available port at or above s3-port+1",
-  "S3_ACCESSKEY": "defaultadmin",
-  "S3_SECRETKEY": "defaultpass",
-  "S3_ADMIN_PASSWORD": "random-secret",
-  "S3_REGION": "us-east-1",
-  "S3_BUCKET": "project-name-documents",
-  "S3_ENDPOINT": "localhost",
-  "S3_USESSL": false,
-  "ELASTICSEARCH_HOST": "localhost",
-  "ELASTICSEARCH_PORT": "9200",
-  "ELASTICSEARCH_USER": "elastic",
-  "ELASTICSEARCH_PASS": "elastic",
-  "ELASTICSEARCH_URL": "derived connection URL"
-}
-```
-
-## Command Examples
-
-```bash
-gitzone services start          # Start all enabled services
-gitzone services start mongo    # Start only MongoDB
-gitzone services stop           # Stop all services
-gitzone services status         # Check service status
-gitzone services config         # Show configuration
-gitzone services compass        # Show MongoDB Compass connection string
-gitzone services logs mongo 50  # Show last 50 lines of MongoDB logs
-gitzone services remove         # Remove containers (preserve data)
-gitzone services clean          # Remove containers and data
-```
-
-## Progress Notes
-
-Implementation started: 2025-08-14
-Implementation completed: 2025-08-14
-
-## Summary
-
-Successfully implemented the `gitzone services` command in TypeScript, providing a complete replacement for the `services.sh` shell script. The implementation includes:
-
-1. **Complete Docker service management** for MongoDB, ObjectStorage, and Elasticsearch containers
-2. **Smart configuration management** with automatic port assignment and conflict avoidance
-3. **MongoDB Compass support** with network IP detection for remote connections
-4. **Project isolation** using project-specific container names
-5. **Data persistence** in `.nogit/` directories
-6. **Interactive confirmations** for destructive operations
-7. **Comprehensive command set** including start, stop, restart, status, config, compass, logs, remove, and clean commands
-
-The module is integrated into the gitzone CLI and covered by unit tests. A real
-authenticated Docker smoke still requires an explicitly isolated harness; it
-must never run against user-managed containers.
-
-## Destructive-command audit — remaining items
-
-Audit performed alongside the `mod_docker` rewrite. Fixed in that pass:
-`docker system prune -a -f --volumes` (mod_docker), `git clean -fd` on every
-`meta` subcommand, unconfirmed `meta remove` plus its path escape,
-`services cleanup -g` unregistering projects whose containers still exist,
-`tools update` deleting shims of packages it does not manage, and the
-undisclosed `--dangerously-skip-permissions` behind `-y`.
-
-Still open, in rough hazard order:
-
-- [ ] `ts/mod_meta/meta.classes.meta.ts` — `syncToRemote()` runs
-      `git push origin master` as a side effect of `readDirectory()`, so a read
-      publishes to a remote. Branch is hardcoded to `master`.
-- [ ] `ts/mod_deprecate/index.ts:47` — `npm deprecate <pkg>@*` runs against every
-      configured registry with no confirm-before-execute step and no dry run.
-      Also `validate: (s) => s !== '' && !process.env.CI` can never pass in CI.
-- [ ] `ts/mod_start/index.ts:17` — `gitzone start` hardcodes `git checkout master`
-      and runs `npm ci`, which contradicts the repo's pnpm-only policy and needs
-      a `package-lock.json` this ecosystem does not produce.
-- [ ] `ts/mod_meta/meta.classes.meta.ts` — the "delete superfluous directory"
-      prompt logs `Deleting >>...<<!` and then never deletes anything. Either
-      implement it or drop the prompt; the log line is currently false.
-- [ ] `ts/mod_commit/mod.helpers.ts:178` — `bumpProjectVersion()` is dead code
-      that commits and tags. No callers; remove it before it gets re-wired.
-- [ ] `ts/mod_format/index.ts:449` — `migrateConfigFile()` deletes
-      `npmextra.json` before the plan is shown and before confirmation, so
-      declining still leaves the old filename gone. Content is copied first, so
-      it is a rename rather than data loss.
-- [ ] `ts/mod_audit/index.ts` is a one-line stub and is not routed. Dead file.