ftk-scaffold-project

Files (1)

• SKILL.md

SKILL.md (first lines)

Create a new Flutter project using the FTK standard stack.

Resolve the toolkit root from `toolkitPath` in `~/.config/flutter-tools-kit/ftk-settings.json`, then read `knowledge/architecture.md` and `knowledge/riverpod-patterns.md` from it before scaffolding.

## Gather inputs

Ask only for what is missing: app name (snake_case), org id, target platforms (default: android,ios), whether dev/prod flavors are needed (default: no), whether go_router is needed (default: yes).

## Scaffold

1. `flutter create --org <org> --platforms <platforms> <app_name>` and `cd` into it.
2. Add dependencies:
   - `flutter pub add flutter_riverpod riverpod_annotation dio obra_icons`
   - `flutter pub add --dev riverpod_generator build_runner custom_lint riverpod_lint very_good_analysis icons_launcher`
   - `flutter pub add --dev integration_test --sdk flutter`
   - Add `go_router` when routing was confirmed.
   - Defaults: networking is dio (via `dioProvider`), UI icons come from `obra_icons` (`Icon(ObraIcons.name)`) unless the design ships custom icon assets.
3. Create the folder layout from `knowledge/architecture.md`: `lib/core/{router,theme,network,storage,utils}` and `lib/features/`, each non-empty dir seeded with its first real file (no placeholder `.gitkeep`). Seed `lib/core/network/dio_provider.dart` with the `dioProvider` skeleton from `knowledge/riverpod-patterns.md`.
4. Rewrite `lib/main.dart` to `ProviderScope(child: App())` and create `lib/app.dart` with `MaterialApp.router` (or `MaterialApp` without routing).
5. Create `lib/core/theme/app_theme.dart` with a minimal `ThemeData` plus empty `AppColors`/`AppSpacing` classes ready to receive design values.
6. Replace `analysis_options.yaml` to include `package:very_good_analysis/analysis_options.yaml` and enable the `custom_lint` plugin for riverpod_lint. Disable individual very_good_analysis rules only with an inline justification comment.
7. If flavors were requested, configure `--dart-define=ENV=<dev|prod>` entrypoints `lib/main_dev.dart` and `lib/main_prod.dart` sharing a common `bootstrap()`; do not touch Gradle product flavors unless the user asks.
8. App icon: when the user provides an icon image, create `icons_launcher.yaml` (image path + `platforms: android/ios: enable: true`) and run `dart run icons_launcher:create`; otherwise note the pending icon in the report.
9. Seed the test pyramid per `knowledge/testing.md`: one unit test (the smoke-adjusted default test moved under `test/`), one golden test for `App`'s first screen under `test/goldens/`, and one `integration_test/app_test.dart` boot-and-render flow.

## Verify

Run `flutter analyze` (expect zero issues) and `flutter test` (expect the default smoke test passing after adjusting it to the new `App` widget). Then run `flutter run` only if the user asks.

Report the created structure as a tree and list the next suggested step: `ftk-scaffold-feature <name>` for the first feature.

From adiwirya/flutter-tools-kit, MIT.

More from adiwirya/flutter-tools-kit