chico_flutter_devkit 1.0.0-dev.12
chico_flutter_devkit: ^1.0.0-dev.12 copied to clipboard
Professional Flutter development toolkit — project creation, code generation, diagnostics, and Chico ecosystem integration. Installable as `devkit`.
Chico Flutter DevKit #
Professional Flutter development toolkit — create apps, generate Clean Architecture features, integrate Chico packages, diagnose projects, and generate OpenAPI clients.
CLI: devkit · Version: 1.0.0-dev.10 · License: MIT
On Git Bash (Windows), Pub installs
devkit.bat. Usedevkit.bat …or run commands from CMD / PowerShell wheredevkitworks.
Table of contents #
- Install
- 60-second quick start
- What you can do
- Documentation map
- Chico packages
- Safety defaults
- Library example
- Support
Install #
Global (recommended) #
dart pub global activate chico_flutter_devkit
devkit --version
devkit --help
Ensure Pub’s global bin folder is on your PATH
(%LOCALAPPDATA%\Pub\Cache\bin on Windows).
From this repository (contributors) #
dart pub get
dart run bin/devkit.dart --help
60-second quick start #
# 1. Create a Flutter app (Clean Architecture + Bloc + Chico + go_router)
devkit create shop_app --architecture clean --state bloc --no-interactive
cd shop_app
# 2. Diagnose
devkit doctor
# 3. Generate a feature scaffold
devkit generate feature products --crud --pagination --search
# 4. Generate a model and a screen
devkit generate model Sku --fields id:String,code:String,price:double?
devkit generate screen SkuDetails --no-tests
# 5. Quality gates
devkit format
devkit analyze
devkit test
flutter run
Full walkthrough: doc/GETTING_STARTED.md
End-to-end recipes: doc/COOKBOOK.md
What you can do #
| Goal | Command | Guide |
|---|---|---|
| Create a new app | devkit create <name> |
Create an app |
| Configure a project | devkit config init / show / set |
Configuration |
| Add Chico packages | devkit add / setup chico |
Cookbook |
| Generate features, models, UI, state | devkit generate … |
Generator guide |
| Generate OpenAPI clients | devkit generate api |
OpenAPI |
| Diagnose / repair | devkit doctor [--fix] |
Command reference |
| Analyze / format / test / clean | devkit analyze etc. |
Command reference |
| Upgrade Chico constraints | devkit upgrade |
Command reference |
| List commands / generators | devkit list |
Command reference |
Documentation map #
| Doc | Audience | Contents |
|---|---|---|
| Getting started | New users | Install, first project, first generate |
| Create an app | New users | Every create flag with examples |
| Command reference | Everyone | All commands, flags, exit codes |
| Generator guide | Everyday use | Every generator with copy-paste examples |
| Cookbook | Everyday use | Real workflows (feature, JSON model, OpenAPI, …) |
| Configuration | Everyday use | .chico/devkit.yaml schema |
| OpenAPI clients | API work | Supported subset + fail-closed rules |
| OpenAPI support matrix | API work | Construct-by-construct matrix |
| Troubleshooting | When stuck | PATH, analyze, deps, repository prereqs |
| Architecture | Contributors | How the CLI is structured |
| Template development | Contributors | Template engine notes |
| Release checklist | Maintainers | Publish gates |
| Example | pub.dev / library | Runnable public-API sample |
| Changelog | Everyone | Version history |
Chico packages #
Created apps (or devkit setup chico) can integrate:
| Package | Default constraint | Role |
|---|---|---|
chico_ui |
^1.7.0 |
ChicoApp, design-system widgets |
chico_kit |
^1.4.0 |
Helpers; re-exports chico_ui |
chico_services |
^1.4.0 (≥ 1.4.1 on Flutter 3.44) |
ChicoServices.init(baseUrl: …) |
Versions are configurable in .chico/devkit.yaml. UI generators fail closed
if required Chico deps are missing (or use --add-missing-chico).
Safety defaults #
- No silent overwrites — re-generation refuses unless
--force --dry-run— preview files without writing- Backups — overwrite can keep
.bak.*files (config) - Repository generator — requires an existing feature; never emits broken imports
- OpenAPI — unsupported constructs (
oneOf, OAuth2, …) abort with clear errors - Features are scaffolds — TODOs /
UnimplementedErrorwhere you must wire real code
Library example #
Most people use the CLI. The package also exposes a Dart API:
cd example
dart pub get
dart run devkit_example.dart
See example/README.md.
Support #
- Issues: GitHub Issues
- Source: GitHub Repository
License #
MIT