A CLI generator for flutter stateless/stateful widget page, router and bloc
npm install flutter-generatorA CLI generator for flutter stateless/stateful widget page, router and bloc.
``console`
$ npm install -g flutter-generator
The most basic command runs a wizard to create a page.
`console`
$ dg
Note: Names can be given in any format (slug-case, camelCase, PascalCase, UPPERCASE, lowercase etc.).
#### stateful widget page
Directly create a component based on the current settings with stateful widget.
`console`
$ dg stateful-page
Arguments:
- name: The name you want to use for the page.
Options:
- -d, --destination : Override the destination for component.-p, --template-path
- : Override template path.-t, --template
- : Override template type. By default it uses the 'pages' folder from the template path. With this option you can use a different template folder.-f, --force
- : Force creation of a page. By default it's impossible to create a page if the destination path doesn't exist. This option forces the creation of a page and will generates the destination folders if they don't exist.
Examples:
`console`
$ dg stateful-page home-page
$ dg stateful-page setting-page -d ./my-component/ui
$ dg stateful-page detail-page -d ./src/widget/players/ -t details -f
The generated file will be
`console`
$ home_page.dart
#### stateless widget page
Directly create a component based on the current settings with stateless widget.
`console`
$ dg stateless-page
Arguments:
- name: The name you want to use for the page.
Options:
- -d, --destination : Override the destination for page.-p, --template-path
- : Override template path.-t, --template
- : Override template type. By default it uses the 'pages' folder from the template path. With this option you can use a different template folder.-f, --force
- : Force creation of a page. By default it's impossible to create a page if the destination path doesn't exist. This option forces the creation of a page and will generates the destination folders if they don't exist.
Examples:
`console`
$ dg stateless-page home-page
$ dg stateless-page setting-page -d ./my-component/ui
$ dg stateless-page detail-page -d ./src/widget/players/ -t details -f
The generated file will be
`console`
$ home_page.dart
#### bloc
Directly create a bloc module based on the current settings.
`console`
$ dg bloc
Arguments:
name: The name you want to use for the bloc module.
Options:
- -d, --destination : Override the destination for bloc module.-p, --template-path
- : Override template path.-t, --template
- : Override template type. By default it uses the 'bloc' folder from the template path. With this option you can use a different template folder.-f, --force
- : Force creation of a bloc. By default it's impossible to create a bloc if the destination path doesn't exist. This option forces the creation of a bloc and will generates the destination folders if they don't exist.
Examples:
`
$ dg bloc user
$ dg bloc shopping-cart -d ./modules
$ dg bloc Car -t bloc
The generated file will be
`console`
$ name_bloc.dart
#### settings
Set or display settings. Without any options it will display the settings. By default it will set the settings locally in a .fluttergenerator file.
You can also set global settings by using the global option -g --global.
`console`
$ dg settings
Options:
- -v, --view-destination : Set default view destination.-c, --component-destination
- : Set default component destination.-s, --store-destination
- : Set default store destination.-t, --template-path
- : Set template path.-l, --log
- : Log global or local settings depending on the global flag.-g, --global
- : Set global settings.
Examples:
`console`
$ dg settings -l
$ dg settings -v ./view -c ./widgets -s ./models/store -t ./template
$ dg settings -g -c ./widgets
#### reset
Reset global settings to the defaults.
`console`
$ dg reset
#### show-templates
Open the default template directory. The default templates can be edited to fit your needs.
`console`
$ dg show-templates
#### copy-templates
Copy the default templates to another directory. This is handy when you want to customize the default templates.
Don't forget to run dg init or set the template path with dg settings.
`console``
$ dg copy-templates