CP-1794 Add completions.dart support

README.md

@@ -101,10 +101,14 @@ alias ddev='pub run dart_dev'
 
 #### Bash Completion
 
-Symlink or copy the file `tool/ddev-completion.sh` into
-`/etc/bash_completion.d/` (or wherever your completion scripts live, if you
-have installed Bash through Homebrew on a Mac, for instance, this will be
-`/usr/local/etc/bash_completion.d/`).
+Bash command completion is available and easy to use. You'll want to install
+dart_dev globally: `pub global activate dart_dev`.
+
+Add the following to your `.bashrc`:
+
+```
+eval "$(pub global run dart_dev bash-completion)"
+```
 
 If you are using Bash installed through Homebrew, you'll also need to install
 the completion machinery with `brew install bash-completion`. Then make sure
@@ -131,7 +135,7 @@ autoload -U compinit
 compinit
 autoload -U bashcompinit
 bashcompinit
-source <path/to/ddev-completion.sh>
+eval "$(pub global run dart_dev bash-completion)"
 ```
 
 #### Configuration

lib/bash-completion.sh

@@ -0,0 +1,62 @@
+#
+# Installation:
+#
+# Via shell config file  ~/.bashrc  (or ~/.zshrc)
+#
+#   Append the contents to config file
+#   'source' the file in the config file
+#
+# You may also have a directory on your system that is configured
+#    for completion files, such as:
+#
+#    /usr/local/etc/bash_completion.d/
+#
+
+###-begin-ddev-completion-###
+
+if type complete &>/dev/null; then
+  __ddev_completion() {
+    local si="$IFS"
+    IFS=$'\n' COMPREPLY=($(COMP_CWORD="$COMP_CWORD" \
+                           COMP_LINE="$COMP_LINE" \
+                           COMP_POINT="$COMP_POINT" \
+                           ddev completion -- "${COMP_WORDS[@]}" \
+                           2>/dev/null)) || return $?
+    IFS="$si"
+  }
+  complete -F __ddev_completion ddev
+elif type compdef &>/dev/null; then
+  __ddev_completion() {
+    si=$IFS
+    compadd -- $(COMP_CWORD=$((CURRENT-1)) \
+                 COMP_LINE=$BUFFER \
+                 COMP_POINT=0 \
+                 ddev completion -- "${words[@]}" \
+                 2>/dev/null)
+    IFS=$si
+  }
+  compdef __ddev_completion ddev
+elif type compctl &>/dev/null; then
+  __ddev_completion() {
+    local cword line point words si
+    read -Ac words
+    read -cn cword
+    let cword-=1
+    read -l line
+    read -ln point
+    si="$IFS"
+    IFS=$'\n' reply=($(COMP_CWORD="$cword" \
+                       COMP_LINE="$line" \
+                       COMP_POINT="$point" \
+                       ddev completion -- "${words[@]}" \
+                       2>/dev/null)) || return $?
+    IFS="$si"
+  }
+  compctl -K __ddev_completion ddev
+fi
+
+###-end-ddev-completion-###
+
+## Generated 2016-05-17 19:21:47.711257Z
+## By /Volumes/Workspace/dart_dev/.pub/bin/completion/shell_completion_generator.dart.snapshot
+

lib/src/dart_dev_cli.dart

@@ -18,7 +18,7 @@ import 'dart:async';
 import 'dart:io';
 
 import 'package:args/args.dart';
-
+import 'package:completion/completion.dart';
 import 'package:dart_dev/util.dart'
     show
         TaskProcess,
@@ -30,6 +30,7 @@ import 'package:dart_dev/src/tasks/cli.dart';
 import 'package:dart_dev/src/tasks/config.dart';
 
 import 'package:dart_dev/src/tasks/analyze/cli.dart';
+import 'package:dart_dev/src/tasks/bash_completion/cli.dart';
 import 'package:dart_dev/src/tasks/copy_license/cli.dart';
 import 'package:dart_dev/src/tasks/coverage/cli.dart';
 import 'package:dart_dev/src/tasks/docs/cli.dart';
@@ -55,6 +56,7 @@ String _topLevelUsage = _parser.usage;
 
 dev(List<String> args) async {
   registerTask(new AnalyzeCli(), config.analyze);
+  registerTask(new BashCompletionCli(), config.bashCompletion);
   registerTask(new CopyLicenseCli(), config.copyLicense);
   registerTask(new CoverageCli(), config.coverage);
   registerTask(new DocsCli(), config.docs);
@@ -101,7 +103,7 @@ Future _run(List<String> args) async {
 
   ArgResults env;
   try {
-    env = _parser.parse(args);
+    env = tryArgsCompletion(args, _parser);
   } on FormatException catch (e) {
     reporter.error('${e.message}\n', shout: true);
     reporter.log(_generateUsage(), shout: true);

lib/src/tasks/bash_completion/api.dart

@@ -0,0 +1,43 @@
+// Copyright 2015 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import 'dart:async';
+import 'dart:convert';
+
+import 'package:resource/resource.dart' as resource;
+
+import 'package:dart_dev/src/tasks/task.dart';
+
+BashCompletionTask bashCompletion() {
+  Completer done = new Completer();
+  BashCompletionTask task = new BashCompletionTask(done.future);
+
+  var script = new resource.Resource('package:dart_dev/bash-completion.sh');
+  script.readAsString(encoding: UTF8).then((content) {
+    task
+      ..completionScript = content
+      ..successful = true;
+    done.complete();
+  }).catchError((error) {
+    done.complete();
+  });
+
+  return task;
+}
+
+class BashCompletionTask extends Task {
+  final Future done;
+  String completionScript;
+  BashCompletionTask(Future this.done);
+}

lib/src/tasks/bash_completion/cli.dart

@@ -0,0 +1,41 @@
+// Copyright 2015 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import 'dart:async';
+
+import 'package:args/args.dart';
+
+import 'package:dart_dev/src/tasks/bash_completion/api.dart';
+import 'package:dart_dev/src/tasks/cli.dart';
+import 'package:dart_dev/util.dart' show reporter;
+
+class BashCompletionCli extends TaskCli {
+  final ArgParser argParser = new ArgParser();
+
+  final String command = 'bash-completion';
+
+  Future<CliResult> run(ArgResults parsedArgs, {bool color: true}) async {
+    // This is kind of a hack to suppress output coloring, which messes us up since
+    // we're outputting shell code (the control sequences are syntax errors).
+    reporter.color = false;
+
+    BashCompletionTask task = bashCompletion();
+    await task.done;
+    if (task.successful) {
+      return new CliResult.success(task.completionScript);
+    } else {
+      return new CliResult.fail('No completion script found.');
+    }
+  }
+}

lib/src/tasks/bash_completion/config.dart

@@ -0,0 +1,17 @@
+// Copyright 2015 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import 'package:dart_dev/src/tasks/config.dart';
+
+class BashCompletionConfig extends TaskConfig {}

lib/src/tasks/config.dart

@@ -15,6 +15,7 @@
 library dart_dev.src.tasks.config;
 
 import 'package:dart_dev/src/tasks/analyze/config.dart';
+import 'package:dart_dev/src/tasks/bash_completion/config.dart';
 import 'package:dart_dev/src/tasks/copy_license/config.dart';
 import 'package:dart_dev/src/tasks/coverage/config.dart';
 import 'package:dart_dev/src/tasks/docs/config.dart';
@@ -27,6 +28,7 @@ Config config = new Config();
 
 class Config {
   AnalyzeConfig analyze = new AnalyzeConfig();
+  BashCompletionConfig bashCompletion = new BashCompletionConfig();
   CopyLicenseConfig copyLicense = new CopyLicenseConfig();
   CoverageConfig coverage = new CoverageConfig();
   DocsConfig docs = new DocsConfig();

pubspec.yaml

@@ -12,10 +12,12 @@ homepage: https://github.com/Workiva/dart_dev
 dependencies:
   ansicolor: "^0.0.9"
   args: "^0.13.0"
+  completion: "^0.1.5"
   coverage: "^0.7.3"
   dart_style: ">=0.1.8 <0.3.0"
   dartdoc: ">=0.4.0 <0.9.0"
   path: "^1.3.6"
+  resource: "^1.1.0"
   test: "^0.12.0"
   uuid: "^0.5.0"
   yaml: "^2.1.0"

tool/generate_completions.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+
+set -e
+
+# We only support completions when the command is run through
+# the `ddev` alias detailed in the README.
+
+pub run completion:shell_completion_generator ddev> lib/bash-completion.sh