skycosmic 0.0.6
skycosmic: ^0.0.6 copied to clipboard
A professional Flutter package providing ready-to-use UI components with CLI support, enabling rapid and consistent UI development.
SkyCosmic 🚀 #
SkyCosmic is a professional Flutter package designed to streamline UI development. It provides a robust CLI tool and a collection of ready-to-use, customizable UI component templates, enabling developers to rapidly build consistent and beautiful interfaces.
✨ Features #
- ⚡ CLI Support: Built-in command-line interface to generate components instantly.
- 🎨 Pre-designed Templates: Includes templates for common UI elements like Buttons, Cards, and ListTiles.
- 🛠️ Automated Boilerplate: Saves time by automatically generating component files with necessary imports and structure.
- 📦 Easy Integration: Simple commands to add components directly to your project's
lib/componentsdirectory.
🚀 Installation #
Global Activation (Recommended for CLI) #
To use the skycosmic command anywhere in your terminal, activate it globally:
dart pub global activate skycosmic
Add as Dependency #
To use the library symbols in your project, add it to your pubspec.yaml:
dependencies:
skycosmic: ^0.0.5
Or run:
flutter pub add skycosmic
📖 Usage #
Using the CLI #
The SkyCosmic CLI allows you to generate new components effortlessly.
Syntax:
skycosmic create <ComponentName>
Examples:
Generate a standard Button component:
skycosmic create Button
Creates lib/components/button.dart from the Button template.
Generate a Card component:
skycosmic create Card
Creates lib/components/card.dart from the Card template.
Generate a ListTile component:
skycosmic create Listile
Creates lib/components/listile.dart from the ListTile template.
Note: The CLI attempts to match the
<ComponentName>(case-insensitive) to an available template in thetemplates/directory. If no specific template matches, it defaults to the Button template but preserves your specified Component Name in the code.
📂 Project Structure #
- bin/: Contains the CLI entry point (
skycosmic.dart). - lib/:
skycosmic.dart: Core library and generator logic.components/: Generated components will be placed here by the CLI.
- templates/: Source Dart templates (
.tpl) used for generation.button.dart.tplcard.dart.tpllistile.dart.tpl
🤝 Contributing #
Contributions are welcome! If you'd like to improve SkyCosmic or add new templates:
- Fork the repository.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
📄 License #
This project is licensed under the MIT License - see the LICENSE file for details.