fiberx

README

fiberx

中文说明

fiberx is a CLI-first Fiber project generator repository.

The repository is intentionally focused on the generator mainline itself: assets, planning rules, validation, rendering, upgrade inspection, build automation, and regression coverage.

Release

• v0.1.0: completed
• v0.1.1: completed
• v0.1.2: completed
• v0.1.3: completed
• v0.1.4: in progress

Docs

• Docs index
• Usage guide
• Release process
• Build hook safety
• Generator architecture
• Template boundaries
• Repository rules
• Contributing
• Changelog
• Roadmap

Current Generator Tracks

• medium: stable production baseline with Swagger and embedded UI by default
• heavy: production-oriented track with Swagger, embedded UI, metrics, scheduler jobs, and optional Redis
• light: lightweight HTTP service with SQLite-first CRUD and optional Swagger or embedded UI
• extra-light: minimal startable base with SQLite startup, health endpoints, and recover-only middleware
• default stack: Fiber v3 + Cobra + Viper
• compatibility stack: Fiber v2 + native-cli
• runtime options on medium / heavy / light: --logger, --db, --data-access
• generated projects include config profiles, runtime metadata, upgrade inspection, and project-level build automation

Quick Start

go run ./cmd/fiberx new demo --preset medium
cd demo
go run . serve

Compatibility example:

go run ./cmd/fiberx new demo-legacy --preset medium --fiber-version v2 --cli-style native

Runtime options example:

go run ./cmd/fiberx new demo-data --preset medium --logger slog --db pgsql --data-access sqlx

Build automation example:

go run ./cmd/fiberx build
go run ./cmd/fiberx build --dry-run
go run ./cmd/fiberx build --profile prod

Repository Layout

• sample/: reference snapshots and test-facing examples, not the maintained generator mainline
• output/: local scratch space for generated artifacts and local binaries; ignored by Git except for .gitkeep

v0.1.3 Release Scope

v0.1.3 closes the current CLI and scaffold-hardening pass:

• generation plan preview with new/init --print-plan [--json]
• build safety switches such as --no-hooks and --yes
• layered doctor output for generator, project, and standalone modes
• explain matrix for preset and capability visibility
• improved verbose output separators for validate, doctor, and explain matrix
• safer default error responses in generated projects
• full timeout coverage for multi-handler business routes
• explicit-false config loading fixes
• lightweight explicit service initialization in generated business modules
• SQLite parent directory creation for default database paths

v0.1.4 Current Scope

v0.1.4 is a scaffold-polish milestone focused on the generated common layer:

• refine the shared error and response layer for light, medium, and heavy
• simplify default controller error handling around the common response flow
• route top-level API registration through AppModules to avoid growth-driven router sprawl
• keep extra-light intentionally minimal
• continue hardening generation regressions without expanding the capability surface

Build Hook Safety

• fiberx build may execute project-defined hooks.
• Only run hooks in trusted repositories.
• Use fiberx build --dry-run to inspect planned commands before execution.

License

This project is licensed under the MIT License. See LICENSE for details.

Documentation

Index

• func Generate(req Request) error
• type Request

Functions

func Generate

func Generate(req Request) error

Types

type Request

type Request = core.Request