slidy 1.1.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 77

Para ver em Português clique aqui

Slidy #

This CLI consists of a way to assemble your project structured by modules, pages, repositories, widgets always following the standards of good practices that has been applied by the community flutter in bigger and more structured projects. It also provides the libraries manager (libs or pubs) with it you can install multiple libraries with just one command line and even remove and update.

Migration from v0.2.1 to v1.0.0: #

Some commands have been improved for ease of usability for example the module, page and widget generation command have been shortened.

//vesion 0.2.1
slidy generate module page/search/search

//version 1.0.0
slidy generate module page/search

The main folder is no longer called "src" but "app"

Motivations #

We realized that the lack of a project pattern is affecting the productivity of several developers at that initial moment, so we are 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. #

We adopted the BLoC standard for business rule in a structure similar to MVC, where a page or widget has one or more BLoC to manage its business rule.

We are using the module structure and dependency injection of the package bloc_pattern. Read the bloc_pattern README to familiarize yourself with the concept of dependency injection, BLoC Provider and modules.

For services and provider we use the Repository Pattern.

In this way our folder structure is organized into local modules and a global module, as well as models, repositories and BLoC`s that can be accessed throughout the application in the shared folder.

Sample folder structure generated by slidy:

Folder example

Installation #

  • You need to have the Dart SDK installed. If you do not have download now.
  • Now just activate the slidy using the pub:
pub global activate slidy
  • Type slidy --version - if you return the slidy version you can consider the complete installation.
  • To update the slidy just use the command:
slidy upgrade

Ready now you can enjoy this new world.

Commands: #

start: Create a basic structure for your project (confirm that you have no data in the "lib" folder).

slidy start

run: Run scripts placed in the "scripts" parameter in pubspect.yaml

slidy run open_folder

Folder example

Install: Install (or update) a new package or packages:

slidy install rxdart dio bloc_pattern

You can also install a package as dev_dependency using the flag --dev

slidy i flutter_launcher_icons --dev

remove a package

 slidy uninstall dio 

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

Generate: #

Create a module, page, widget or repository according to the option.

Options:

Creates a new module with slidy generate module:

slidy generate module manager/product

Creates a new page and its respective Bloc

slidy generate page manager/product/pages/add_product

Creates a new widget and its respective Bloc:

slidy generate widget manager/product/widgets/product_detail

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

Create a new repository

slidy g r manager/product/repositories/product

Common errors: #

Windows:

Folder example

If you find out with the above error, when trying to run or the pub global activate slidy, then you will have to put in the environment variables manually:

Go to windows search and search for: Edit System variable

After click in Environment Variables

Search forPath

Then click in New and add the path that appeared on your console in case here is : C:\Users\1513 MX5-7\AppData\Roaming\Pub\Cache\Bin after that just restart your CMD.

For more details Telegram Group Flutterando

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/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

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: ^1.1.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support 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]
53
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
77
Learn more about scoring.

We analyzed this package on Oct 16, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: other

Primary library: package:slidy/slidy.dart with components: io, mirrors.

Health suggestions

Format lib/slidy.dart.

Run dartfmt to format lib/slidy.dart.

Format lib/src/command/sub_command/generate_repository_sub_command.dart.

Run dartfmt to format lib/src/command/sub_command/generate_repository_sub_command.dart.

Format lib/src/templates/generator/repository_test_generator.dart.

Run dartfmt to format lib/src/templates/generator/repository_test_generator.dart.

Format lib/src/utils/output_utils.dart.

Run dartfmt to format lib/src/utils/output_utils.dart.

Format lib/src/utils/utils.dart.

Run dartfmt to format lib/src/utils/utils.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.0 <3.0.0
ansicolor ^1.0.2 1.0.2
args ^1.5.2 1.5.2
http ^0.12.0+2 0.12.0+2
path ^1.6.2 1.6.4
pubspec ^0.1.1 0.1.2
yaml ^2.1.16 2.2.0
Transitive dependencies
async 2.4.0
charcode 1.1.2
collection 1.14.12
http_parser 3.1.3
matcher 0.12.5
meta 1.1.7
pedantic 1.8.0+1
pub_semver 1.4.2
quiver 2.0.5
source_span 1.5.5
stack_trace 1.9.3
string_scanner 1.0.5
stuff 0.1.0
term_glyph 1.1.0
typed_data 1.1.6
uri 0.11.3+1
utf 0.9.0+5