Skip to content

Latest commit

 

History

History
375 lines (275 loc) · 9.54 KB

README-pt_BR.md

File metadata and controls

375 lines (275 loc) · 9.54 KB
Raw
Idiomas da documentação
pt_BR - Esse arquivo en_EN zh_CN

CLI oficial para a estrutura GetX ™.

// Para instalar, rode esse comando no terminal: 
pub global activate get_cli 
// (para usar adicione a seguinte linha às variáveis do sistema: [FlutterSDKDiretório]\bin\cache\dart-sdk\bin

// ou 
flutter pub global activate get_cli 

// Para criar um projeto de flutter no diretório atual:
// Nota: Por padrão, o nome da pasta será o nome do projeto
// Você pode nomear o projeto com `get create project: my_project`
// Se o nome tiver espaços, use `get create project:" my cool project "`
get create project 

// Para gerar uma estrutura em um projeto existente:
get init 

// Para criar uma Page:
// (Pages tem controller, view, and binding)
// Nota: você pode usar qualquer nome, ex: `get create page:login` 
// Nota: use essa opcão se a estrutura escolhida for Getx_pattern
get create page:home 

// Para criar uma Screen:
// (Screen tem controller, view, and binding)
// Nota: você pode usar qualquer nome, ex: `get create Screen:login` 
// Nota: use essa opcão se a estrutura escolhida for CLEAN (by Arktekko)
get create screen:home 

// Para criar um novo controller em uma pasta específica:
// Observação: você não precisa fazer referência à pasta,
// Getx irá procurar automaticamente pela pasta pessoal
// e adicione seu controlador lá.
get create controller:dialogcontroller on home

// Para criar uma nova view em uma pasta específica:
// Observação: você não precisa fazer referência à pasta,
// Getx irá procurar automaticamente pela pasta pessoal
// e inserir sua View lá.
get create view:dialogview on home

// Para criar um novo Provider em uma pasta específica: 
get create provider:user on home

// Para gerar um arquivo de localização:
// Nota: diretório 'assets/locales' com seus arquivos de tradução em formato json
get generate locales assets/locales

// Para gerar um modelo de classe:
// Nota: 'assets/models/user.json' é o diretório do seu arquivo modelo no formato .json
// Nota: on  == pasta onde seu arquivo será gerado
// Getx irá procurar automaticamente pela pasta inicial
// e inserir sua classe modelo lá.
get generate model on home with assets/models/user.json

// Para gerar um modelo sem Provider:
get generate model on home with assets/models/user.json --skipProvider

// Nota: a URL deve retorna um arquivo formato em json
get generate model on home from "https://api.github.com/users/CpdnCristiano"

// Para instalar um pacote em seu projeto (dependencies):
get install camera

// Para instalar vários pacotes em seu projeto:
get install http path camera

// Para instalar um pacote com uma versão específica:
get install path:1.6.4

// Você também pode especificar as versões e vários pacotes

// Para instalar um pacote dev em seu projeto (dependencies_dev):
get install flutter_launcher_icons --dev

// Para remover um pacote do seu projeto:
get remove http

// Para remover vários pacotes do seu projeto:
get remove http path

// Para atualizar a CLI:
get update
// ou `get upgrade`

// Mostra a versão CLI atual:
get -v 
// ou `get -version`

// Para obter ajudar
get help

Explorando a CLI

Bora explorar os comandos existentes na CLI

Criar projeto

  get create project

Usando esse comando parar gerar um novo projeto, você pode escolher entre Flutter e get_server, depois de criar o diretório padrão, será executado o comando get init

Iniciar

  get init

Use este comando com cuidado, pois ele sobrescreverá todos os arquivos na pasta lib. Ele permite que você escolha entre duas estruturas, getx_pattern e clean.

Criar uma Page

  get create page:name

Este comando permite criar módulos, é recomendado para usuários que optaram por usar getx_pattern.

Cria a View, o Controller e os arquivos de Binding, além de adicionar automaticamente a rota.

Você pode criar um módulo dentro de outro módulo.

  get create page:name on other_module

Agora ao criar um novo projeto e usar on para criar uma página, a CLI criará uma [Page filha] (https://github.com/jonataslaw/getx/blob/master/CHANGELOG.md#3210---big-update).

Criar uma Screen

  get create screen:name

Semelhante ao create page, mas adequado para aqueles que usam Clean

Criar um Controller

  get create controller:dialog on your_folder

Cria um Controller em uma pasta específica.

Usando com opção, agora você pode criar um arquivo de modelo, da maneira que preferir.

execute no terminal

  get create controller:auth with examples/authcontroller.dart on your_folder

ou com uma URL execute

  get create controller:auth with 'https://raw.githubusercontent.com/jonataslaw/get_cli/master/samples_file/controller.dart.example' on your_folder

input

@import

class @controller extends GetxController {
  final  email = ''.obs;
  final  password = ''.obs;
  void login() {
  }

}

output

import 'package:get/get.dart';

class AuthController extends GetxController {
  final email = ''.obs;
  final password = ''.obs;
  void login() {}
}

Criar uma View

  get create view:dialog on your_folder

Cria uma View em uma pasta específica

Gerar arquivos de idioma

Crie os arquivos de idioma json na pasta assets/locales.

input:

pt_BR.json

{
  "buttons": {
    "login": "Entrar",
    "sign_in": "Cadastrar-se",
    "logout": "Sair",
    "sign_in_fb": "Entrar com o Facebook",
    "sign_in_google": "Entrar com o Google",
    "sign_in_apple": "Entrar com a  Apple"
  }
}

en_EN.json

{
  "buttons": {
    "login": "Login",
    "sign_in": "Sign-in",
    "logout": "Logout",
    "sign_in_fb": "Sign-in with Facebook",
    "sign_in_google": "Sign-in with Google",
    "sign_in_apple": "Sign-in with Apple"
  }
}

Rode no terminal :

get generate locales assets/locales

output:

abstract class AppTranslation {

  static Map<String, Map<String, String>> translations = {
    'en_EN' : Locales.en_EN,
    'pt_BR' : Locales.pt_BR,
  };

}
abstract class LocaleKeys {
  static const buttons_login = 'buttons_login';
  static const buttons_sign_in = 'buttons_sign_in';
  static const buttons_logout = 'buttons_logout';
  static const buttons_sign_in_fb = 'buttons_sign_in_fb';
  static const buttons_sign_in_google = 'buttons_sign_in_google';
  static const buttons_sign_in_apple = 'buttons_sign_in_apple';
}

abstract class Locales {
  
  static const en_EN = {
   'buttons_login': 'Login',
   'buttons_sign_in': 'Sign-in',
   'buttons_logout': 'Logout',
   'buttons_sign_in_fb': 'Sign-in with Facebook',
   'buttons_sign_in_google': 'Sign-in with Google',
   'buttons_sign_in_apple': 'Sign-in with Apple',
  };
  static const pt_BR = {
   'buttons_login': 'Entrar',
   'buttons_sign_in': 'Cadastrar-se',
   'buttons_logout': 'Sair',
   'buttons_sign_in_fb': 'Entrar com o Facebook',
   'buttons_sign_in_google': 'Entrar com o Google',
   'buttons_sign_in_apple': 'Entrar com a  Apple',
  };

}

Agora basta adicionar a seguinte linha em GetMaterialApp:

    GetMaterialApp(
      ...
      translationsKeys: AppTranslation.translations,
      ...
    )

Gerar um modelo exemplo

Cria um arquivo modelo em json em assets/models/user.json

input: 

{
  "name": "",
  "age": 0,
  "friends": ["", ""]
}

Execute no terminal:

get generate model on home with assets/models/user.json

output:

class User {
  String name;
  int age;
  List<String> friends;

  User({this.name, this.age, this.friends});

  User.fromJson(Map<String, dynamic> json) {
    name = json['name'];
    age = json['age'];
    friends = json['friends'].cast<String>();
  }

  Map<String, dynamic> toJson() {
    final Map<String, dynamic> data = new Map<String, dynamic>();
    data['name'] = this.name;
    data['age'] = this.age;
    data['friends'] = this.friends;
    return data;
  }
}

Separador no formato do arquivo

Um dia um usuário me perguntou se era possível mudar o nome final do arquivo, ele achou mais legível usar: my_controller_name.controller.dart, ao invés do padrão gerado pelo cli: my_controller_name_controller. dart pensando em usuários como ele adicionamos a opção de você escolher seu próprio separador, basta adicionar esta informação em seu pubsepc.yaml

Exemplo:

get_cli:
  separator: "."

Seus imports estão desorganizadas?

Para ajudá-lo a organizar seus imports, um novo comando foi criado: get sort, além de organizar suas importações, o comando também formatará seu arquivo dart. graças a [dart_style] (https://pub.dev/packages/dart_style). Ao usar get sort, todos os arquivos são renomeados, com o [separador] (#separador-no-formato-do-arquivo). Para não renomear, use o sinalizador --skipRename.

Você é um daqueles que prefere usar imports relativos em vez de imports de projeto, use a opção --relative. o get_cli irá converter para você.

Internacionalização da cli

CLI agora tem um sistema de internacionalização.

para traduzir o cli para o seu idioma:

  1. crie um novo arquivo json com o seu idioma, na pasta translations
  2. Copie as chaves do [arquivo] (/translations/en.json) e traduza os valores
  3. envie seu PR.

A fazer:

  • Suporte para customModels
  • Incluir testes unitários
  • Melhorar a estrutura gerada
  • Adicionar um sistema de backup