slidy 2.0.0+1

  • Readme
  • Changelog
  • Example
  • Installing
  • 80

Pub GitHub stars Telegram

Actions Status Actions Status Actions Status Actions Status Actions Status

Acesse a documentação em Português-Brasil

Slidy #

CLI package manager and template generator for Flutter. Generate Modules, Pages, Widgets, BLoCs, Controllers and tests.

Slidy supports rxBLoC, flutter_bloc and mobx.

Why should I use? #

Slidy's goal is to help you structure your project in a standardized way. Organizing your app in Modules formed by pages, repositories, widgets, BloCs, and also create unit tests automatically. The Module gives you a easier way to inject dependencies and blocs, including automatic dispose. Also helps you installing the dependencies and packages, updating and removing them. The best is that you can do all of this running a single command.

Motivations #

We realized that the project pattern absence is affecting the productivity of most developers, so we're proposing a development pattern along with a tool that imitates NPM (NodeJS) functionality as well as template generation capabilities (similar to Scaffold ).

About the Proposed Pattern #

The structure that slidy offers you, it's similar to MVC, where a page keeps it's own business logic classes(BloC).

We recommend you to use flutter_modular when structuring with slidy. It offers you the module structure(extending the ModuleWidget) and dependency/bloc injection, or you will probably get an error.

To understand flutter_modular, take a look at the README.

We also use the Repository Pattern, so the folder structure it's organized in local modules and a global module. The dependencies(repositories, BloCs, models, etc) can be accessed throughout the application.

Sample folder structure generated by slidy:

Folder example

Installation #

  1. First of all you need install the Dart:

    https://dart.dev/get-dart

  2. Activate the slidy using the pub:

 pub global activate slidy
  1. Type slidy --version to make sure everything is working properly. This command should return the installed version.

Commands: #

upgrade: #

Updates slidy's version:

slidy upgrade

create: #

Create a new project with same structure describe in start command.

slidy create **myproject**

start: #

Create the basic structure of your project existing (make sure that your "lib" folder it's empty).

slidy start

Then choose your provider:

Folder example

Then choose your State Manager:

Mobx

Folder example

And you will get this Structure:

Folder example

Flutter Bloc:

Folder example

And you will get this Structure:

Folder example

Bloc With RxDart

Folder example

And you will get this Structure:

Folder example

If you have the flutter_bloc or flutter_mobx package in pubspec, the generation of pages, widgets, and bloc defaults to the installed manager default.

Options

The command allows to specify provider and state manager using the following options:

  • Provider:
-p <provider_name>

Options:
flutter_modular / bloc_pattern

Example:
slidy start -p flutter_modular
  • State manager:
-s <state_manager_name>

Options:
mobx / flutter_bloc / rxdart
Example:
slidy start -s mobx
  • Provider and state manager:
slidy start -p flutter_modular -s mobx

This command asks for permission to erase lib folder. If you don't want to see the warning, type the -e (erase) flag:

slidy start -p flutter_modular -s mobx -e

run: #

Runs the scripts in pubspec.yaml:

slidy run open_folder

Folder example

install: #

Installs or update the packages in dependencies:

Folder example

slidy install rxdart dio bloc_pattern

or you can just use the i command (both are the same)

slidy i rxdart dio bloc_pattern

Install packages as dev_dependency:

slidy i mockito --dev

Folder example

uninstall: #

Removes a package

slidy uninstall dio

You can also remove a dev_dependency using the flag --dev

generate: #

Creates a module, page, widget or repository including its BloC class.

NOTE: You can replace "g" with "generate" command.

Creates a new module:

slidy g module folder_name

or

slidy g m folder_name

Folder example

NOTE: You can create a "Complete Module" with Module, Page, Bloc/Controller, tests for Page and for Bloc/Controller using the flag -c

Creates a new page + BloC:

slidy g page folder_name/pages

or

slidy g p folder_name/pages

Creates a new widget + BloC:

slidy g widget folder_name/widgets

or

slidy g w folder_name/widgets

NOTE: You can create a page or widget using its respective BLoC using the flag -b

Create a new repository

slidy g r folder_name/repositories

Create a new service

slidy g s folder_name/services

Create a new model

slidy g mm folder_name/model

You can also use "repository" in "r"'s place, but it will have the same function.

Folder example

Unit Tests: #

Generate unit tests on the test folder for you.

slidy test folder_name/

Common errors: #

I cant update:

1 - First of all you need uninstall the Slidy on Flutter

flutter pub global deactivate slidy

2 - After you need uninstall the Slidy on Dart

pub global deactivate slidy

2 - And now install only in Dart

pub global activate slidy

3 - If you don't have the Pub you will need to install Dart:

https://dart.dev/get-dart

Windows:

Folder example

If you got this error when trying to run the pub global activate slidy, then you will have to set the environment variables manually:

  • In windows search, write: Edit System Variables

    Folder example

  • Then click at Environment Variables

    Folder example

  • Go to Path

    Folder example

  • Then click in New and add the path that appeared on your console.

    Folder example

If you have any doubt about setting up the system variables, watch this video.

For more details join our Telegram Group Flutterando

2.0.0+1 #

WE GET SLIDY VERSION 2 Thanks to everyone in the community

  • Added "Revert" command
slidy revert

Reverse the last generation command.

1.5.3 #

  • Fixed error in generated page in RXDart project

1.5.2 #

  • Generate Store Command
    slidy generate store /path/store 
    
  • Slidy create -m (state_managent) -p
  • Internal Core Modification
  • Now using ModularState in Generate Pages;

1.4.12 #

  • Create module withless named route system --noroute:
    slidy generate module /path/module --noroute [-n]
    
  • Added flag -p (provider system), -s (state management), -f (force) to start command (by lukelima);
  slidy start -p flutter_modular -s mobx -f 

1.4.7 #

  • Create reactive model template with --rx:
    slidy generate model /path/model_name --rx
    
  • flutter_modular as default provider;
  • Fix model template;

1.4.2+1 #

  • Fix test file generate error.

1.4.1 #

  • Slidy CLI Interative
  • Fix slidy create erro

1.2.2 #

  • Added command generate model

1.2.1 #

  • Fix error install in flutter dart.
  • removed dart:mirrors.

1.2.0+1 #

  • Added flutter_bloc and mobx support.
  slidy start --flutter_bloc [-f]
  or
  slidy start --mobx [-m]

If you have the flutter_bloc or flutter_mobx package in pubspec, the generation of pages, widgets, and bloc defaults to the installed manager default.

  • Added flags "--flutter_bloc | -f" and "--mobx | -m" to generate bloc.
  • Added command "generate controller" (to mobx).

1.1.4 #

  • Added initModule in tests (check the documentation)

1.1.3 #

  • Create unity test widget when generate pages or widgets.
  • Flutter Dart 100% compatible
     flutter pub global activate slidy
    

1.1.2 #

  • Added "service" command to generate auto disposed and injetable service.
     slidy generate service path-of-your-file
    

1.1.0 #

  • Now creating BLoCs or Repositories also creates Unitary Test files.
  • Added "test" command to "generate command".
     slidy generate test path-of-your-file
    

1.0.0 #

  • added command run, for exec your scripts in pubspec.yaml
  • Some commands have been improved for ease of usability for example the module, page and widget generation command have been shortened.
  • Fix errors

0.2.1 #

  • Removed folder App for main module.
  • File placement changes after "start -c" command.
  • The command "start -c" is being optimized to be the initial interface. We are working on the routes.

0.2.0 #

  • Added start -c, to start the project with routers, locations, and page structures

0.1.2 #

  • Added bloc command create;

0.1.1 #

  • Added param 'create';

0.0.1 #

  • Initial version, created by Stagehand

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:example/app/app_module.dart';

void main() => runApp(AppModule());

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate slidy

2. Use it

The package has the following executables:


$ slidy

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  slidy: ^2.0.0+1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:slidy/slidy.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
70
Health:
Code health derived from static analysis. [more]
98
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
80
Learn more about scoring.

We analyzed this package on Apr 1, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6

Health suggestions

Fix lib/src/utils/pubspec.dart. (-1 points)

Analysis of lib/src/utils/pubspec.dart reported 2 hints:

line 13 col 26: This function has a return type of 'Future

line 28 col 16: The stack trace variable 's' isn't used and can be removed.

Fix lib/src/modules/start.dart. (-0.50 points)

Analysis of lib/src/modules/start.dart reported 1 hint:

line 14 col 6: The declaration '_isContinue' isn't referenced.

Fix lib/src/modules/version.dart. (-0.50 points)

Analysis of lib/src/modules/version.dart reported 1 hint:

line 1 col 8: Unused import: 'package:slidy/src/utils/utils.dart'.

Fix additional 13 files with analysis or formatting issues. (-0.50 points)

Additional issues in the following files:

  • lib/src/utils/local_save_log.dart (1 hint)
  • lib/slidy.dart (Run dartfmt to format lib/slidy.dart.)
  • lib/src/command/start_command.dart (Run dartfmt to format lib/src/command/start_command.dart.)
  • lib/src/command/sub_command/generate_page_sub_command.dart (Run dartfmt to format lib/src/command/sub_command/generate_page_sub_command.dart.)
  • lib/src/command/sub_command/generate_repository_sub_command.dart (Run dartfmt to format lib/src/command/sub_command/generate_repository_sub_command.dart.)
  • lib/src/command/sub_command/generate_service_sub_command.dart (Run dartfmt to format lib/src/command/sub_command/generate_service_sub_command.dart.)
  • lib/src/command/sub_command/generate_widget_sub_command.dart (Run dartfmt to format lib/src/command/sub_command/generate_widget_sub_command.dart.)
  • lib/src/modules/install.dart (Run dartfmt to format lib/src/modules/install.dart.)
  • lib/src/modules/run.dart (Run dartfmt to format lib/src/modules/run.dart.)
  • lib/src/modules/uninstall.dart (Run dartfmt to format lib/src/modules/uninstall.dart.)
  • lib/src/templates/start/src/app_module.dart (Run dartfmt to format lib/src/templates/start/src/app_module.dart.)
  • lib/src/templates/templates.dart (Run dartfmt to format lib/src/templates/templates.dart.)
  • lib/src/utils/output_utils.dart (Run dartfmt to format lib/src/utils/output_utils.dart.)

Maintenance issues and suggestions

Support latest dependencies. (-20 points)

The version constraint in pubspec.yaml does not support the latest published versions for 2 dependencies (dart_console, recase).

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.7.0 <3.0.0
ansicolor ^1.0.2 1.0.2
args ^1.5.2 1.6.0
dart_console ^0.5.0 0.5.0 0.6.0
http ^0.12.0+2 0.12.0+4
path ^1.6.2 1.6.4
recase ^2.0.1 2.0.1 3.0.0
tuple ^1.0.3 1.0.3
yaml ^2.1.16 2.2.0
Transitive dependencies
async 2.4.1
charcode 1.1.3
collection 1.14.12
ffi 0.1.3
http_parser 3.1.4
matcher 0.12.6
meta 1.1.8
pedantic 1.9.0
quiver 2.1.3
source_span 1.7.0
stack_trace 1.9.3
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
test ^1.9.4