feat: add dartTest (#3)

Author: felangel

CHANGELOG.md

@@ -0,0 +1,8 @@
+# 0.1.0 (2022-03-09)
+
+### Features
+
+- add dartTest ([#3](https://github.com/VeryGoodOpenSource/very_good_test_runner/issues/3)) ([6686fdd](https://github.com/VeryGoodOpenSource/very_good_test_runner/commit/6686fdd6871fd3b401259ac3b1453112614a81a7))
+- add flutterTest ([#2](https://github.com/VeryGoodOpenSource/very_good_test_runner/issues/2)) ([4db0c6b](https://github.com/VeryGoodOpenSource/very_good_test_runner/commit/4db0c6b0da2d99acad0582a33b8e5885bdc6bf36))
+- export TestEvents ([#1](https://github.com/VeryGoodOpenSource/very_good_test_runner/issues/1)) ([1de845a](https://github.com/VeryGoodOpenSource/very_good_test_runner/commit/1de845a0f6ce3fcbdfc77d10f76fe38f4c77a858))
+- generate package via very_good_cli 🦄 ([3001cef](https://github.com/VeryGoodOpenSource/very_good_test_runner/commit/3001cef12ee5fb5c52a1652ff24209037a225ece))

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faqs

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to Very Good Test Runner
+
+First off, thanks for taking the time to contribute! 🎉👍
+
+This project is opinionated and follows patterns and practices used by the team at [Very Good Ventures][very_good_ventures_link]. **At this time, we welcome bug tickets but will not be accepting feature requests because the roadmap and scope of this project is still being defined.**
+
+## Creating a Bug Report
+
+We highly recommend [creating an issue][bug_report_link] if you have found a bug rather than immediately opening a pull request. This lets us reach an agreement on a fix before you put significant effort into a pull request. Please use the built-in [Bug Report][bug_report_link] template and provide as much information as possible including detailed reproduction steps. Once one of the package maintainers has reviewed the issue and an agreement is reached regarding the fix, a pull request can be created.
+
+## Creating a Pull Request
+
+Before creating a pull request please:
+
+1. Fork the repository and create your branch from `main`.
+1. Install all dependencies (`flutter packages get` or `pub get`).
+1. Squash your commits and ensure you have a meaningful, [semantic][conventional_commits_link] commit message.
+1. Add tests! Pull Requests without 100% test coverage will not be approved.
+1. Ensure the existing test suite passes locally.
+1. Format your code (`dart format .`).
+1. Analyze your code (`dart analyze --fatal-infos --fatal-warnings .`).
+1. Create the Pull Request.
+1. Verify that all status checks are passing.
+
+While the prerequisites above must be satisfied prior to having your
+pull request reviewed, the reviewer(s) may ask you to complete additional
+work, tests, or other changes before your pull request can be ultimately
+accepted.
+
+[conventional_commits_link]: https://www.conventionalcommits.org/en/v1.0.0
+[bug_report_link]: https://github.com/VeryGoodOpenSource/very_good_test_runner/issues/new?assignees=&labels=bug&template=bug_report.md&title=fix%3A+
+[very_good_ventures_link]: https://verygood.ventures

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Very Good Ventures
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -19,9 +19,15 @@ A test runner for Flutter and Dart created by Very Good Ventures.
 import 'package:very_good_test_runner/very_good_test_runner.dart';
 
 void main() {
+  // Run `dart test` in `path/to/project`.
+  dartTest(workingDirectory: 'path/to/project').listen((TestEvent event) {
+    // React to `TestEvent` instances.
+    print(event);
+  });
+
+  // Run `flutter test` in `path/to/project`.
   flutterTest(workingDirectory: 'path/to/project').listen((TestEvent event) {
     // React to `TestEvent` instances.
-    // See https://github.com/dart-lang/test/blob/master/pkgs/test/doc/json_reporter.md#json-reporter-protocol
     print(event);
   });
 }

lib/example/main.dart renamed to example/main.dart

@@ -15,6 +15,33 @@ typedef StartProcess = Future<Process> Function(
   ProcessStartMode mode,
 });
 
+/// Runs `dart test` and returns a stream of [TestEvent]
+/// reported by the process.
+///
+/// ```dart
+/// void main() {
+///   // React to `TestEvent` instances.
+///   dartTest().listen(print);
+/// }
+/// ```
+Stream<TestEvent> dartTest({
+  List<String>? arguments,
+  String? workingDirectory,
+  Map<String, String>? environment,
+  bool runInShell = false,
+  StartProcess startProcess = Process.start,
+}) {
+  return _runTestProcess(
+    () => startProcess(
+      'dart',
+      ['test', ...?arguments, '--reporter=json'],
+      environment: environment,
+      workingDirectory: workingDirectory,
+      runInShell: runInShell,
+    ),
+  );
+}
+
 /// Runs `flutter test` and returns a stream of [TestEvent]
 /// reported by the process.
 ///
@@ -31,19 +58,27 @@ Stream<TestEvent> flutterTest({
   bool runInShell = false,
   StartProcess startProcess = Process.start,
 }) {
+  return _runTestProcess(
+    () => startProcess(
+      'flutter',
+      ['test', ...?arguments, '--reporter=json'],
+      environment: environment,
+      workingDirectory: workingDirectory,
+      runInShell: runInShell,
+    ),
+  );
+}
+
+Stream<TestEvent> _runTestProcess(
+  Future<Process> Function() processRunner,
+) {
   final controller = StreamController<TestEvent>();
   late StreamSubscription testEventSubscription;
   late StreamSubscription errorSubscription;
   late Future<Process> processFuture;
 
   Future<void> _onListen() async {
-    processFuture = startProcess(
-      'flutter',
-      ['test', ...?arguments, '--reporter=json'],
-      environment: environment,
-      workingDirectory: workingDirectory,
-      runInShell: runInShell,
-    );
+    processFuture = processRunner();
     final process = await processFuture;
     final errors = process.stderr.map((e) => utf8.decode(e).trim());
     final testEvents = process.stdout.mapToTestEvents();
@@ -72,20 +107,24 @@ Stream<TestEvent> flutterTest({
 extension on Stream<List<int>> {
   Stream<TestEvent> mapToTestEvents() {
     return map(utf8.decode)
-        .expand<String>((msg) sync* {
-          for (final value in msg.split('\n')) {
-            final trimmedValue = value.trim();
-            if (trimmedValue.isNotEmpty) yield trimmedValue;
-          }
-        })
-        .expand<Object?>((j) {
-          try {
-            return [json.decode(j)];
-          } on FormatException {
-            return [];
-          }
-        })
-        .cast<Map<Object?, Object?>>()
-        .map((json) => TestEvent.fromJson(Map<String, dynamic>.from(json)));
+        .expand<String>(_splitLines)
+        .map<Map<String, Object?>>(_tryDecode)
+        .where((value) => value.isNotEmpty)
+        .map(TestEvent.fromJson);
+  }
+
+  Iterable<String> _splitLines(String content) sync* {
+    for (final line in content.split('\n')) {
+      yield line.trim();
+    }
+  }
+
+  Map<String, Object?> _tryDecode(String value) {
+    try {
+      if (value.isEmpty) return const {};
+      return json.decode(value) as Map<String, Object?>;
+    } on FormatException {
+      return const {};
+    }
   }
 }

lib/src/flutter_test_runner.dart renamed to lib/src/very_good_test_runner.dart

@@ -1,5 +1,5 @@
 /// A test runner for Flutter and Dart created by Very Good Ventures.
 library very_good_test_runner;
 
-export 'src/flutter_test_runner.dart' show flutterTest;
 export 'src/models/models.dart';
+export 'src/very_good_test_runner.dart' show dartTest, flutterTest;

lib/very_good_test_runner.dart

@@ -1,7 +1,6 @@
 name: very_good_test_runner
 description: A test runner for Flutter and Dart created by Very Good Ventures
-version: 1.0.0+1
-publish_to: none
+version: 0.1.0
 
 environment:
   sdk: ">=2.16.0 <3.0.0"