Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/clawstudios/wholesome-cli

Command Line Tool for managing Flutter projects
https://github.com/clawstudios/wholesome-cli

bloc boilerplate command-line-tool dart facilitates flutter pub subcommands

Last synced: 3 months ago
JSON representation

Command Line Tool for managing Flutter projects

Awesome Lists containing this project

README 

        
![A Command Line Tool that facilitates code generation for Flutter projects.](https://www.clawstudios.com/assets/wholesome/icon.png)



Wholesome is a Command Line Tool that aims to facilitate code generation for [Flutter](https://flutter.dev/) projects, proposing a default architecture based on BLoC pattern.



## Requeriments

This tool is executed using [pub](https://pub.dev/) and generate code for [Flutter](https://flutter.dev/) projects this means that you will need:

 - [Dart SDK](https://dart.dev/get-dart)

 - [Flutter](https://flutter.dev/docs/get-started/install)



## Installation

Wholesome-cli now is a (pub.dev package)[https://pub.dev/packages/wholesome_cli/versions/1.0.0] and you can install the stable version from pub, or installit from this repo if you want the latest dev version.



### Pub

    pub global activate wholesome_cli



### Git Online

You can install the tool from this repo link by running the following line:



    pub global activate --source git https://github.com/clawstudios/wholesome-cli.git



### Git Local

If you cloned the repository, you can install the tool with the following line replacing `` with the path where the repo is located on your computer.



    pub global activate --source path 



### Add the executable folder to $PATH

To execute Wholesome from your command line, you need to add the [pub](https://pub.dev/) cache folder to the PATH.

Check out the [Running Script](https://dart.dev/tools/pub/cmd/pub-global#running-a-script) section in the [pub-global](https://dart.dev/tools/pub/cmd/pub-global) Dart documentation to add the path correctly for your system.



## Before Starting



This tool is based on the following folder structure.

*You can read more about each folder in the section of each subcommand of the generator.*



    / myproject

      |- .idea

      |- android

      |- assets

      |- ios

      |- lib

        |- common

        |- components

            |- mycomponent

                |- mycomponent.bloc.dart

                |- mycomponent.events.dart

                |- mycomponent.state.dart

                |- mycomponent.view.dart

        |- guards

        |- models

        |- pages

            |- mypage

                |- mypage.bloc.dart

                |- mypage.events.dart

                |- mypage.state.dart

                |- mypage.view.dart

        |- services

      |- test



## Commands

Every Wholesome command needs to be executed by the **wsm** binary. At the moment, it supports the following commands and subcommands:

 - [new](https://github.com/clawstudios/wholesome-cli#new)

 - [generate](https://github.com/clawstudios/wholesome-cli#generate)

     - [component](https://github.com/clawstudios/wholesome-cli#component)

     - [guard](https://github.com/clawstudios/wholesome-cli#guard)

     - [model](https://github.com/clawstudios/wholesome-cli#model)

     - [page](https://github.com/clawstudios/wholesome-cli#page)

     - [service](https://github.com/clawstudios/wholesome-cli#service)



## New



The **new** command generates a new Flutter project with the provided name, the [previously detailed folder](https://github.com/clawstudios/wholesome-cli/blob/master/README.md#before-starting) folder structure, and some boilerplate code.



    wsm new myproject

    

*This command will run 'flutter new' and then will generate the structure and files.*



This command also generates the following files inside the **common** folder:

 - assets.dart

 - colors.dart

 - helpers.dart

 - routes.dart

 - styles.dart



### Assets, Colors and Styles

These are files for storing constants with asset paths, custom colors, or custom styles that you need to reuse on every part of the app.



You can import the files in the following way:



    import  'package:myproject/common/assets.dart'  as ASSETS;

    import  'package:myproject/common/colors.dart'  as COLORS;

    import  'package:myproject/common/styles.dart'  as STYLES;



### Helpers

This is a file created to put all the helper functions that you will use to develop your app.



You need to import it like this:



    import  'package:myproject/common/helpers.dart'  as HELPERS;

 

And you will find two methods for printing to console.



    HELPERS.printError('This is an error message.');

    HELPERS.printWarn('This is a warning message.');



### Routes

In this file, you will find a ROUTES Map in where you can add routes and associate them with the generated Page constructor.



For more information about routing, please check [Flutter Routing Docs](https://flutter.dev/docs/development/ui/navigation).



## Generate



This command generates boilerplate code, it receives **one subcommand as a parameter** and you must **execute this command under a Flutter Project** 



    wsm generate 



### Component



A component is a reusable implementation of code that could have one or more files.



#### Stateful Component

For components that need state management, Wholesome generates a set of files inside a folder named the same as the component (as you can see in the [Before Starting](https://github.com/clawstudios/wholesome-cli/blob/master/README.md#before-starting) section, inside the 'components' folder)



    wsm generate component 



**Generated Files:** 



**name.bloc.dart**

This file contains all the Business Logic and also is intended to manage the State of the component through events.



**name.events.dart**

Contains an abstract class ready to be extended by custom events used to comunicate between BLoC and View.



**name.state.dart**

Contains a class with the State data of the component and only can be modified by the BLoC.



**name.view.dart:**

Is a StatefulWidget with a BLoC instance in it and a dispose implementation that includes the _bloc.dispose() call that is needed to shutdown the BLoC controllers when disposing the view.



#### Stateless Component

For components without state management, Wholesome will generate only a StatelessWidget that will be used as a view.



    wsm generate component  -s

    # or

    wsm generate component  -stateless



### Guard



Guard functionality is to manage the access to one or more views, that's why you will find a default **canActivate** method that returns a boolean ready to be used from a Page. Guards can be extended as needed.

*These files are created under the 'guards' folder as shown in the [Before Starting](https://github.com/clawstudios/wholesome-cli/blob/master/README.md#before-starting) section.*



    wsm generate guard 



#### Usage



Guards are implemented as mixins, you can use it on a generated page adding the 'with' keyword to the state class. 

*[More info about mixins here](https://github.com/dart-lang/language/blob/master/accepted/2.1/super-mixins/feature-specification.md#dart-2-mixin-declarations)*



    ...

    class _HomePageState extends State with ExampleGuard {



      HomePageBloc _bloc = HomePageBloc();



      @override

      void initState() {

          if (!this.canActivate(context)) {

              // Get out of here

          }

      }

    ...



### Model



Models are classes that represent different data models handled inside an app such as user data to show in a profile view.

*Models are located inside the 'models' folder. (check the [previously detailed folder](https://github.com/clawstudios/wholesome-cli/blob/master/README.md#before-starting) structure).*



    wsm generate model 



### Page



Pages are StatefulWidgets with the same structure as components, but they can be accessed navigating to their specific route that is also generated by this subcommand. 

In pages is where you will instantiate components and trigger events to the BLoC for handling state and model mutations.



*Pages are located inside 'pages' folder. (check the [previously detailed folder](https://github.com/clawstudios/wholesome-cli/blob/master/README.md#before-starting) folder structure).*



    wsm generate page 



*See the (Routes)[https://github.com/clawstudios/wholesome-cli/blob/master/README.md#routes] section if youe need to add a route manually.*



### Service



Services are singletons that expose methods to interact with external resources such as APIs or databases.



*Services are located inside the 'services' folder. (check the [previously detailed folder](https://github.com/clawstudios/wholesome-cli/blob/master/README.md#before-starting) folder structure).*



    wsm generate service 



## Credits

This tool is a development in progress by [Claw Studios](https://www.clawstudios.com/) and is under BSD License. 



If you want to help, contribute or report a bug please use the following channels

- [Slack](https://join.slack.com/t/clawstudios/shared_invite/enQtNzYyNTY2NzI1ODEwLWM1MzEzODc2ZDYxNDY5MmY4NWRkNWRhMzM4MTliM2I3NjM5MjIzM2Q5Y2U0ZTYwZmRkNjc0N2Q3NjRlYTA0MmI)

- [Discord](https://discord.gg/zyghfFq)

- [email protected]