8000 Productize `configu init` Command Based on Users Feedback · Issue #737 · configu/configu · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Productize configu init Command Based on Users Feedback #737
@rannn505

Description

@rannn505

Suggestion

The configu init command is currently exposed in the CLI but is not stable or production-ready. This issue proposes to fully productize and support configu init as a core CLI feature, including a clean set of working presets, user-facing documentation, and guardrails to prevent broken generation paths.

What is the problem this feature would solve?

Existing init presets are either broken or misleading:
1. Fully Featured Schema - Fails validation (/keys must have 1 or more properties) and hangs on asset generation.
2. Complete Pack - CLI says “Assets generated”, but nothing is created.
3. Configu Module - Same as above: message appears but no output is generated.
4. Starter Pack - Filename mismatch - CLI says starter.cfgu.yaml will be generated, but actually produces service.cfgu.yaml.
5. Starter Pack - Validation bug - The generated schema includes a test: validator.isPort($.value), which fails if the value is a number (e.g., 1234) - Correct alternatives: validator.isPort(String($.value)) or validator.isPort($.stringValue).

This leads to confusion, failed onboarding attempts, and wasted time for users expecting a smooth out-of-the-box experience.

  • Clean up existing presets:
    • Remove or fix broken ones (e.g., Fully Featured, Complete Pack, Configu Module).
    • Align filenames with what the CLI output promises (e.g., Starter Pack).
    • Ensure schema files are syntactically valid and semantically meaningful.
    • Fix test expressions to use valid patterns (e.g., use $.stringValue when required).
  • Improve the user experience:
    • Add progress feedback and error handling.
    • Output a clear summary of what was generated.
  • Document configu init usage in the CLI help and docs site.
  • Add a contribution model for custom community presets.

Motivation

Making configu init a stable, reliable experience would significantly improve time-to-value and reduce friction for new users.

Context

This request is based on a customer report during a schema onboarding session.

Metadata

Metadata

Assignees

Labels

featNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0