fast 0.3.2

A sample command-line application.

FAST CLI

An incredible command line interface for Flutter.

With this CLI, you can create your custom templates and define how your project will start.

The generated directories and files are defined from the outside in, that is, the users define the templates, the CLI only creates them.

That way you are not forced to use the project structure set by someone else and you can easily modify templates already created.

Features

• Templates generator
• Aplication Scaffold generator
• Snippet generator for Visual Studio Code
• Custom commands
• Standard line commands (Some commands already included in the CLI)
  • install (Add a package to the project dependencies)

Table Of Contents

• Template generator example
• Snippet generator
• Scaffold generator Example
• Commands example
• Installation

Template generator example

Template example:

First we define the files that are generated. In this example, the '@Name' tag will be replaced by the '--name' argument when the file is generated.

file: @name_page.dart

import 'package:flutter/material.dart';

class @NamePage extends StatefulWidget {
  @override
  _@NamePageState createState() => _@NamePageState();
}

class _@NamePageState extends State<@NamePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Container(
        child: Text("Hello"),
      ),
    );
  }
}

In the same folder as the file above we have the yaml file that defines how the template should be created.

file: template.yaml

#Yaml file for configuring the template.
#The template name
name: page
#The template description
description: Create_flutter_page.
#Path where files should be sent
to: lib/ui/pages/@name
#Arguments to be passed when executing this template
# You can define as many arguments as you want.
args:
  - name
# - other1
# - other2
# - other3

Running the template

Run this command so that your template is generated.

fast <template_name> <templates_arg1, templates_arg2, templates_arg3....>

example: run on cmd: fast page --name home

Result

You will now have the following file in the path lib/ui/pages/home

import 'package:flutter/material.dart';

class HomePage extends StatefulWidget {
  @override
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Container(
        child: Text("Hello"),
      ),
    );
  }
}

Snippets generator

A command to generate snippets for the VC Code based on the template files. Reuse the code inserted in the template files to generate snippets for Visual Studio Code.

Example

First we create the template file and template.yaml. And then set a snippe to be generated.

file: @name_page.dart

import 'package:flutter/material.dart';

class @NamePage extends StatefulWidget {
  @override
  _@NamePageState createState() => _@NamePageState();
}

class _@NamePageState extends State<@NamePage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Container(
        child: Text("Hello"),
      ),
    );
  }
}

file: template.yaml

name: page
description: Create_flutter_page.
to: lib/ui/pages/@name
# You can define as many arguments as you want.
args:
  - name

# Set up a list of snippests.
snippets:
  # The file containing the snippet code to be generated
  # Reuse the code inserted in one of the template files to generate a VC Code snippets.
  - file: '@name_page.dart'
    prefix: page
    #File lines that will not be included in the snippet.
    excluded:
      - 0
      - 1
# It is possible to create snippests for each template file.
# - file: '@name_other1.dart'
#    prefix: other1
#    excluded:
#      - 0
# - file: '@name_other2.dart'
#    prefix: other2
#    excluded:
#      - 0   

Generate snippests

Run the command below to generate the snippets.

fast snippets

Result

It will be possible to use the generated snippet.

Scaffold generator example

Scaffold example:

file: scaffold.yaml

# The scaffold name.
name: sample
description: A sample scaffold.
author: Pedro Bissonho <[e-mail]>

# The folder structure that will be generated inside the 'lib' folder.
structure:
  - ui:
    - pages
    - shared 
    - themes
  - data:
    - models
    - repositorys
  - blocs
# The folder structure that will be generated inside the 'test' folder.
test_structure:
  - ui:
  - data:
  - fixtures:

# The standard dependencies that the project will have.
# Your project will start with all these dependencies.
# If the version is not informed, the version will be configured as the last version available in Dart Pub.
dependencies: 
  koin: 
  flutter_bloc: 

# The standard dev_dependencies that the project will have.
dev_dependencies:
  koin_test:  

Create a APP with the sample scaffold

Run this command for your application to be created.

fast create --name <app_name> --scafoold <scafoold_name>

run on cmd:

fast create --name myapp --scafoold sample

Result

An application created with structure and dependencies selects no sample of scaffolding.

Commands example

Commands YAML example:

file: commands.yaml

commands:
  runner: flutter build runner build
  push: git push origin master
  mkdir: mkdir myFolder

Running a command

fast run <command_name>

example:

fast run runner

Installation

Install

Install this package globally. To do this, you must have the Dart SDK installed and configured See the guide referring to the installation of packages globally if you have any doubts on how to do it.

run on cmd: pub global activate fast

Config

Before using the CLI, it is necessary to configure where your templates, commands and scaffolds are. If these paths are not defined, the CLI will not work correctly, because by default the CLI does not come with resources, it is necessary to create new ones or use resources already created by the community.

In the resources repository you can download a set of resources already created.

Configure the path of the templates that will be used by the CLI.

fast config templates <templates_path>

fast config scaffolds <scaffolds_path>

fast config commands <commands_yaml_file_path>

example

fast config templates /home/pedro/Documentos/fast_resources/templates/

fast config scaffolds /home/pedro/Documentos/fast_resources/scaffolds/

fast config commands /home/pedro/Documentos/fast_resources/

License

license.