When to use Vyuh Feature Developer
The **Vyuh Feature Developer** package is a lightweight, developer‑centric utility designed for applications built on the Vyuh framework. It surfaces a clear, scrollable list of all features that have been registered with the Vyuh core, allowing you to verify that feature modules are correctly wired, to debug missing routes, and to generate quick documentation snapshots. By rendering feature metadata directly in the UI, the package eliminates the need for manual logging or digging through configuration files, making it an indispensable tool during the early stages of development and continuous integration testing.
When you are constructing a modular Flutter app where each business domain lives in its own feature package, keeping track of the feature registry can become cumbersome. **Vyuh Feature Developer** solves this problem by providing a single widget – `VyuhFeatureList` – that reads the global `VyuhFeatureRegistry` and presents each entry with its name, version, and a short description. The UI is fully customizable via theming parameters, but the default styling follows Material Design guidelines, ensuring a seamless look and feel across mobile, web, and desktop platforms.
Integrating the package fits naturally into a typical Vyuh architecture. After adding the dependency, you simply import the widget and place it behind a debug flag or behind a hidden route such as `/dev/features`. Because the widget only reads from the registry and does not perform any network calls, it adds negligible overhead and can safely be included in production builds behind a feature flag if you need runtime inspection in the field. For CI pipelines, you can render the widget to a screenshot and compare it against a baseline to catch accidental feature removals.
Setup is straightforward: run `flutter pub add vyuh_feature_developer`, then wrap the widget in a conditional that checks `kDebugMode` or your own feature‑toggle service. The package declares compatibility with Flutter 3.10 and later, and it works on all platforms supported by Flutter – Android, iOS, web, macOS, Linux, and Windows. No additional native code or backend configuration is required, making it a pure‑Dart solution that respects the same licensing and null‑safety guarantees as the rest of your codebase.
While the package shines in development and testing environments, there are a few production considerations. Because the widget reveals internal feature names and versions, you may want to hide it from end users to avoid exposing implementation details. Additionally, the list can become lengthy in large applications; you can enable lazy loading or pagination via the provided `maxItems` parameter. Finally, remember that the widget reflects the state of the registry at the time it is built – if you dynamically load features after the widget has rendered, you will need to call `setState` or use a state‑management solution to refresh the view.
Overall, **Vyuh Feature Developer** streamlines the workflow for developers building feature‑driven Vyuh applications. It reduces manual verification steps, improves test coverage, and offers a quick visual reference for onboarding new team members. Whether you are a solo developer prototyping a new module or part of a large team maintaining a complex feature set, this package provides a clear, maintainable way to keep your feature registry in sync with your code.
Pros
- zero runtime overhead in production when hidden
- pure‑Dart, no native dependencies
- works across all Flutter platforms
- helps maintain feature registry consistency
- easy to integrate with existing debug routes
Watch outs
- exposes internal feature names if not hidden
- list can become long in very large apps
- specific to Vyuh, not useful for non‑Vyuh projects
Setup notes
Add the dependency with the exact command: ``` flutter pub add vyuh_feature_developer ``` Then import the package and place `VyuhFeatureList()` in a debug‑only route or widget tree. Remember to run `flutter pub get` after adding the package.
Requires Flutter 3.10+ and Dart 2.19+. Works on Android, iOS, web, macOS, Linux, and Windows. No platform‑specific native code, so no additional setup for iOS or Android. Compatible with null‑safety enabled projects.
import 'package:flutter/material.dart';
import 'package:vyuh_feature_developer/vyuh_feature_developer.dart';
void main() => runApp(const MyApp());
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Vyuh Feature Demo',
home: Scaffold(
appBar: AppBar(title: const Text('Vyuh Features')),
body: const VyuhFeatureList(), // shows all registered features
),
);
}
}