Merge pull request #57 from nventive/dev/lebo/pub-dev-score

chore: CLI improvements for pub.dev score

Author: lesterbotello

CONTRIBUTING.md

@@ -83,4 +83,21 @@ information on using pull requests.
 ## Community Guidelines
 
 This project follows [Google's Open Source Community
-Guidelines](https://opensource.google.com/conduct/).
+Guidelines](https://opensource.google.com/conduct/).
+
+## pub.dev score
+
+When making changes to the CLI, it's important to ensure that the resulting package is scored with the highest pub.dev score. The pub.dev score is a rating system that evaluates the quality of the package by evaluating common metrics (more info [here](https://pub.dev/help/scoring)). Before submitting your changes, please follow the following steps:
+
+1. Open a terminal / command prompt window and navigate to the project directory.
+2. Navigate to the `src/cli` directory.
+3. Run the `build_runner` to ensure the creation of required generated code, for example:
+```
+$ dart run build_runner build --delete-conflicting-outputs
+```
+4. Activate the `pana` tool by running `dart pub global activate pana`
+5. Run the `pana` tool by executing the `pana` command and save its output to a markdown file, for example:
+```
+$ pana > ~/temp/pana-analysis.md
+```
+6. Open the markdown file and observe the scores for each category, make sure that each (except the first one) has a perfect score (for example 20/20). If not, resolve any issues before submitting a pull request. The first category will resolve itself before being shipped to pub.dev (as it depends on automated tasks in the CI)

src/cli/CHANGELOG.md

@@ -1,10 +1,13 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 Prefix your items with `(Template)` if the change is about the template and not the resulting application.
 
+## 0.24.2
+- General improvements, including sample documentation (see `src/cli/example/README.md`).
+
 ## 0.24.1
 - Add `getFromStream` to have ViewModel properties that automatically update based on `Stream` sources.
 

src/cli/bin/flutter_application_generator.dart

@@ -3,7 +3,8 @@ import 'dart:io';
 import 'package:flutter_application_generator/src/command_runner.dart';
 
 Future<void> main(List<String> arguments) async {
-  await _flushThenExit(await FlutterApplicationGeneratorCommandRunner().run(arguments));
+  await _flushThenExit(
+      await FlutterApplicationGeneratorCommandRunner().run(arguments));
 }
 
 /// Flushes the stdout and stderr streams, then exits the program with the given

src/cli/example/README.md

@@ -0,0 +1,9 @@
+## Dad Jokes app example
+
+The `flutter_application_generator` source code includes a complete working example in the `src/app/` folder. It's a simple joke browser app that uses the Reddit API to display jokes posted to the `r/dadjokes` subreddit and allows you to manage favorites (add / remove). It also includes an authentication example.
+
+Before running the example, it's neccessary to run the `build_runner` package in order to create the required generated files. Using your terminal of choice, navigate to the `src/app/` folder and run the following:
+
+```bash
+dart run build_runner build --delete-conflicting-outputs
+```

src/cli/pubspec.yaml

@@ -10,16 +10,16 @@ dependencies:
   args: ^2.4.2
   path: ^1.9.0
   cli_completion: ^0.5.0
-  mason_logger: ^0.2.12
-  pub_updater: ^0.4.0
-  archive: ^3.6.0
+  mason_logger: ^0.3.2
+  pub_updater: ^0.5.0
+  archive: ^4.0.2
   http: ^1.2.1
 
 dev_dependencies:
   build_runner: ^2.4.8
   build_verify: ^3.1.0
   build_version: ^2.1.1
-  lints: ^3.0.0
+  lints: ^5.1.1
   test: ^1.24.0
 
 executables: