Skip to content

Update CLI #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.dart_tool/
.packages
build/
pubspec.lock
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ The `Flutter Starter CLI` is a very useful tool that provides commands for the e
While working with the Flutter projects we have to write the same repetitive code multiple times but using this CLI, we can create a Flutter template on the fly.\
Also, the basic structure of all the tests in Flutter is the same. So this CLI also provides a basic starter pack for the Flutter test as well.

`Flutter Starter CLI` under the hood uses mason to generate the project template.\
Mason is an open-source tool that generates code from custom templates called bricks.

Out of the box, `Flutter Starter CLI` includes:-

- ✅ **State Management**
Expand All @@ -35,10 +32,9 @@ Currently, the `Flutter Starter CLI` depends on the following packages:-
| Package | Version | Description |
| ------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| args | 2.3.1 | Parses raw command-line arguments into a set of options and values. |
| mason | 0.1.0 | A template generator which helps to generate files quickly and consistently. |
| mason_logger | 0.1.3 | Simple logging library for CLI requests. |
| path | 1.8.2 | The path package provides common operations for manipulating paths: joining, splitting, normalizing, etc. |
| pub_updater | 0.2.1 | A Dart package which enables checking whether packages are up to date and supports updating them. |
| build_runner | 2.0.0 | The build_runner package provides a concrete way of generating files using Dart code, outside of tools like pub. |
| build_version | 2.0.0 | Include the version of the package in the source code. |
| flutter_lints | 2.0.1 | This package contains a recommended set of lints for Flutter apps, packages, and plugins to encourage good coding practices. |

## Getting Started
Expand Down Expand Up @@ -74,7 +70,10 @@ $ flutter_starter_cli create
# Shorthand to create project with git
$ flutter_starter_cli create <project_name> --api=<api_service> -g

# Shorthand to create project without git
# Shorthand to create project with test
$ flutter_starter_cli create <project_name> --api=<api_service> -t

# Shorthand to create project without git and test
$ flutter_starter_cli create <project_name> --api=<api_service>

# Available API services (dio, http)
Expand All @@ -89,14 +88,15 @@ The complete usage of the create command with options and flags.
Creates a new flutter starter project.

Usage: flutter_starter_cli create <project_name>
-h, --help Print this usage information.
--desc The description for the project.
(defaults to "A New Flutter Project.")
--org The organization for the project.
(defaults to "com.example")
-a, --api The API service for the project.
[dio, http]
-g, --[no-]git Initialize Git Repository.
-h, --help Print this usage information.
--desc The description for the project.
(defaults to "A New Flutter Project.")
--org The organization for the project.
(defaults to "com.example")
-a, --api The API service for the project.
[dio, http]
-t, --[no-]test Setup Test Cases.
-g, --[no-]git Initialize Git Repository.

Run "flutter_starter_cli help" to see global options.
```
Expand Down
File renamed without changes.
File renamed without changes.
Binary file removed bricks/.DS_Store
Binary file not shown.
3 changes: 0 additions & 3 deletions bricks/.mason/bricks.json

This file was deleted.

Binary file removed bricks/flutter_starter/__brick__/.DS_Store
Binary file not shown.
49 changes: 0 additions & 49 deletions bricks/flutter_starter/__brick__/{{name}}/.gitignore

This file was deleted.

3 changes: 0 additions & 3 deletions bricks/flutter_starter/__brick__/{{name}}/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions bricks/flutter_starter/__brick__/{{name}}/android/.gitignore

This file was deleted.

71 changes: 0 additions & 71 deletions bricks/flutter_starter/__brick__/{{name}}/android/app/build.gradle

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

This file was deleted.

This file was deleted.

This file was deleted.

31 changes: 0 additions & 31 deletions bricks/flutter_starter/__brick__/{{name}}/android/build.gradle

This file was deleted.

This file was deleted.

Loading