Add evaluate api for dart test

Author: avenwu

README.md

@@ -14,7 +14,6 @@ Preview the health and quality of a Dart/Flutter package before publish.
 
 Install `pana_html` with pub.
 ```dart
-pub global activate pana
 pub global activate pana_html
 ``` 
 

cli/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.3
+- Add api for dart test;
+
 ## 0.1.2
 - Add options to control local server and strict mode;
 - Fix resource path;

cli/bin/main.dart

@@ -1,5 +1,6 @@
 import 'package:pana_html/pana_html.dart' as cli;
 
+/// cli entry point
 void main(List<String> arguments) {
  cli.main(arguments);
 }

cli/example/main.dart

@@ -1,6 +1,6 @@
-import 'package:pana_html/cli.dart' as cli;
+import 'package:pana_html/pana_html.dart' as cli;
 
 void main(List<String> args) {
  print('call pana_html');
- cli.main(arguments);
+ cli.evaluate(['--no-web', '--strict']);
 }

cli/lib/pana_html.dart

@@ -1,14 +1,22 @@
 import 'dart:async';
 import 'dart:io';
 
+import 'package:pana_html/src/result.dart';
+
 import 'src/runner.dart';
 
+/// entry point of application
 Future<void> main(List<String> args) async {
- var runner = ProjectRunner(args);
- var result = await runner.evaluate();
+ var result = await evaluate(args);
  var state = result.success ? 'success' : 'failed';
  print('Evaluate:$state, ${result.message}');
- if(!result.success){
+ if (!result.success) {
  exit(1);
  }
 }
+
+/// run project evaluation
+/// args example: ['--no-web', '--strict']
+Future<EvaluateResult> evaluate(List<String> args) async {
+ return ProjectRunner(args).evaluate();
+}

cli/lib/src/result.dart

@@ -1,7 +1,14 @@
 /// Result bean
 class EvaluateResult {
+ /// text message.
  final String message;
+
+ /// evaluate state.
  final bool success;
 
- EvaluateResult({this.message, this.success});
+ /// url of local server.
+ final String url;
+
+ /// New instance
+ EvaluateResult({this.message, this.success, this.url});
 }

cli/lib/src/runner.dart

@@ -35,6 +35,7 @@ class ProjectRunner {
  negatable: false,
  help: 'Print this usage information.');
 
+ /// Construct a runner according to the cli parameters
  ProjectRunner(this.args) {
  var argResults = _parser.parse(args);
  _webServer = argResults['web'];
@@ -90,8 +91,9 @@ class ProjectRunner {
  if (json != null) {
  print('analyze completed');
  }
+ var url = '';
  if (_webServer) {
- await _genHtml(result);
+ url = await _genHtml(result);
  }
  var scores = json['scores'];
  var health = scores != null ? scores['health'] : 0;
@@ -102,19 +104,21 @@ class ProjectRunner {
  return EvaluateResult(
  success: false,
  message: 'health:$health, maintenance=$maintenance',
+ url: url,
  );
  }
  }
 
  return EvaluateResult(
  success: true,
  message: 'health:$health, maintenance=$maintenance',
+ url: url,
  );
  }
 }
 
 /// generate html report and deploy as local service
-Future<void> _genHtml(String result) async {
+Future<String> _genHtml(String result) async {
  var exist = await Directory('pana_visual').exists();
  if (!exist) {
  Directory('pana_visual').createSync();
@@ -123,6 +127,7 @@ Future<void> _genHtml(String result) async {
  // update data.json
  var dataFile = join('pana_visual', 'assets', 'assets', 'data.json');
  File(dataFile).writeAsStringSync(result);
- await serve('pana_visual');
+ var url = await serve('pana_visual');
  print('Terminate as you like');
+ return url;
 }

cli/lib/src/static_file_server.dart

@@ -3,7 +3,7 @@ import 'dart:io';
 import 'package:http_server/http_server.dart';
 
 /// static file server
-void serve(String root) async {
+Future<String> serve(String root) async {
  var staticFiles = VirtualDirectory(root);
  staticFiles.allowDirectoryListing = true;
  staticFiles.directoryHandler = (dir, request) {
@@ -15,6 +15,7 @@ void serve(String root) async {
  server.listen((event) {
  staticFiles.serveRequest(event);
  });
- print('Pana report are served at http://127.0.0.1:${server.port}#/home');
-// await server.forEach(staticFiles.serveRequest);
+ var url = 'http://127.0.0.1:${server.port}#/home';
+ print('Pana report are served at $url');
+ return url;
 }

cli/pubspec.yaml

@@ -1,6 +1,6 @@
 name: pana_html
 description: Preview the health and quality of a Dart/Flutter package before publish.
-version: 0.1.2
+version: 0.1.3
 homepage: https://github.com/hacktons/pana_visual
 
 environment: