feat: add example app (#9)

Author: renancaraujo

.github/dependabot.yaml

@@ -1,11 +1,14 @@
 version: 2
-enable-beta-ecosystems: true
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"
   - package-ecosystem: "pub"
-    directory: "/"
+    directory: "/example"
     schedule:
       interval: "daily"
+  - package-ecosystem: "pub"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/example.yaml

@@ -0,0 +1,24 @@
+name: example
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/example.yaml"
+      - "example/lib/**"
+      - "example/test/**"
+      - "example/pubspec.yaml"
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/example.yaml"
+      - "example/lib/**"
+      - "example/test/**"
+      - "example/pubspec.yaml"
+
+jobs:
+  semantic-pull-request:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/semantic_pull_request.yml@v1
+
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1

.idea/cli_completion.iml

@@ -0,0 +1,17 @@
+# See https://www.dartlang.org/guides/libraries/private-files
+
+# Files and directories created by pub
+.dart_tool/
+.packages
+build/
+pubspec.lock
+
+# Files generated during tests
+.test_coverage.dart
+coverage/
+.test_runner.dart
+
+# Android studio and IntelliJ
+.idea
+
+/coverage

example/.gitignore

@@ -0,0 +1,7 @@
+## example
+
+Generated by the [Very Good CLI][very_good_cli_link] 🤖
+
+Example for cli_completion with the most common use cases for command completion.
+
+[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli

example/README.md

@@ -0,0 +1,4 @@
+include: package:very_good_analysis/analysis_options.3.1.0.yaml
+linter:
+  rules:
+    public_member_api_docs: false

example/analysis_options.yaml

@@ -0,0 +1,18 @@
+import 'dart:io';
+
+import 'package:example/src/command_runner.dart';
+
+Future<void> main(List<String> args) async {
+  await _flushThenExit(await ExampleCommandRunner().run(args));
+}
+
+/// Flushes the stdout and stderr streams, then exits the program with the given
+/// status code.
+///
+/// This returns a Future that will never complete, since the program will have
+/// exited already. This is useful to prevent Future chains from proceeding
+/// after you've decided to exit.
+Future<void> _flushThenExit(int status) {
+  return Future.wait<void>([stdout.close(), stderr.close()])
+      .then<void>((_) => exit(status));
+}

example/bin/example_cli.dart

@@ -0,0 +1,10 @@
+/// Example for cli_completion
+///
+/// ```sh
+/// # activate example
+/// dart pub global activate example
+///
+/// # see usage
+/// example_cli --help
+/// ```
+library example;

example/lib/example.dart

@@ -0,0 +1,68 @@
+import 'package:args/command_runner.dart';
+import 'package:example/src/commands/commands.dart';
+import 'package:mason_logger/mason_logger.dart';
+
+const executableName = 'example_cli';
+const packageName = 'example';
+const description = 'Example for cli_completion';
+
+/// {@template example_command_runner}
+/// A [CommandRunner] for the CLI.
+///
+/// ```
+/// $ example_cli --version
+/// ```
+/// {@endtemplate}
+class ExampleCommandRunner extends CommandRunner<int> {
+  /// {@macro example_command_runner}
+  ExampleCommandRunner({
+    Logger? logger,
+  })  : _logger = logger ?? Logger(),
+        super(executableName, description) {
+    // Add root options and flags
+    argParser.addFlag(
+      'rootFlag',
+      help: 'A flag in the root command',
+    );
+
+    // Add sub commands
+    addCommand(SomeCommand(_logger));
+    addCommand(SomeOtherCommand(_logger));
+  }
+
+  @override
+  void printUsage() => _logger.info(usage);
+
+  final Logger _logger;
+
+  @override
+  Future<int> run(Iterable<String> args) async {
+    try {
+      final topLevelResults = parse(args);
+
+      if (topLevelResults['rootFlag'] == true) {
+        _logger.info('You used the root flag, it does nothing :)');
+        return ExitCode.success.code;
+      }
+
+      return await runCommand(topLevelResults) ?? ExitCode.success.code;
+    } on FormatException catch (e, stackTrace) {
+      // On format errors, show the commands error message, root usage and
+      // exit with an error code
+      _logger
+        ..err(e.message)
+        ..err('$stackTrace')
+        ..info('')
+        ..info(usage);
+      return ExitCode.usage.code;
+    } on UsageException catch (e) {
+      // On usage errors, show the commands usage message and
+      // exit with an error code
+      _logger
+        ..err(e.message)
+        ..info('')
+        ..info(e.usage);
+      return ExitCode.usage.code;
+    }
+  }
+}

example/lib/src/command_runner.dart

@@ -0,0 +1,2 @@
+export 'some_commmand.dart';
+export 'some_other_commmand.dart';