Add list for local tools

dotnet · Dec 4, 2018 · 2f260f7 · 2f260f7
1 parent 9ed8cf2
commit 2f260f7
Show file tree

Hide file tree

Showing 23 changed files with 306 additions and 123 deletions.
diff --git a/src/dotnet/ToolManifest/IToolManifestInspector.cs b/src/dotnet/ToolManifest/IToolManifestInspector.cs
@@ -0,0 +1,14 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+using Microsoft.Extensions.EnvironmentAbstractions;
+
+namespace Microsoft.DotNet.ToolManifest
+{
+    internal interface IToolManifestInspector
+    {
+        IReadOnlyCollection<(ToolManifestPackage toolManifestPackage, FilePath SourceManifest)> Inspect(
+            FilePath? filePath = null);
+    }
+}
diff --git a/src/dotnet/ToolManifest/ToolManifestFinder.cs b/src/dotnet/ToolManifest/ToolManifestFinder.cs
@@ -9,7 +9,7 @@
 
 namespace Microsoft.DotNet.ToolManifest
 {
-    internal class ToolManifestFinder : IToolManifestFinder
+    internal class ToolManifestFinder : IToolManifestFinder, IToolManifestInspector
     {
         private readonly DirectoryPath _probeStart;
         private readonly IFileSystem _fileSystem;
@@ -48,6 +48,19 @@ public IReadOnlyCollection<ToolManifestPackage> Find(FilePath? filePath = null)
             return toolManifestPackageAndSource.Select(t => t.toolManifestPackage).ToArray();
         }
 
+        public IReadOnlyCollection<(ToolManifestPackage toolManifestPackage, FilePath SourceManifest)> Inspect(
+            FilePath? filePath = null)
+        {
+            IEnumerable<(FilePath manifestfile, DirectoryPath _)> allPossibleManifests =
+                filePath != null
+                    ? new[] {(filePath.Value, filePath.Value.GetDirectoryPath())}
+                    : EnumerateDefaultAllPossibleManifests();
+
+            TryFindToolManifestPackages(allPossibleManifests, out var toolManifestPackageAndSource);
+
+            return toolManifestPackageAndSource.ToArray();
+        }
+
         private bool TryFindToolManifestPackages(
             IEnumerable<(FilePath manifestfile, DirectoryPath _)> allPossibleManifests, 
             out List<(ToolManifestPackage toolManifestPackage, FilePath SourceManifest)> toolManifestPackageAndSource)

diff --git a/src/dotnet/commands/dotnet-tool/list/LocalizableStrings.Designer.cs b/src/dotnet/commands/dotnet-tool/list/LocalizableStrings.Designer.cs
diff --git a/src/dotnet/commands/dotnet-tool/list/LocalizableStrings.resx b/src/dotnet/commands/dotnet-tool/list/LocalizableStrings.resx
@@ -142,6 +142,9 @@
   <data name="CommandsColumn" xml:space="preserve">
     <value>Commands</value>
   </data>
+  <data name="ManifestFileColumn" xml:space="preserve">
+    <value>Manifest</value>
+  </data>
   <data name="InvalidToolPathOption" xml:space="preserve">
     <value>Tool path '{0}' does not exist.</value>
   </data>

diff --git a/src/dotnet/commands/dotnet-tool/list/ToolListCommand.cs b/src/dotnet/commands/dotnet-tool/list/ToolListCommand.cs
@@ -19,6 +19,7 @@ internal class ToolListCommand : CommandBase
         private readonly AppliedOption _options;
         private readonly ParseResult _result;
         private readonly ToolListGlobalOrToolPathCommand _toolListGlobalOrToolPathCommand;
+        private readonly ToolListLocalCommand _toolListLocalCommand;
         private readonly bool _global;
         private readonly bool _local;
         private readonly string _toolPath;
@@ -29,14 +30,17 @@ internal class ToolListCommand : CommandBase
         public ToolListCommand(
             AppliedOption options,
             ParseResult result,
-            ToolListGlobalOrToolPathCommand toolListGlobalOrToolPathCommand = null
+            ToolListGlobalOrToolPathCommand toolListGlobalOrToolPathCommand = null,
+            ToolListLocalCommand toolListLocalCommand = null
         )
             : base(result)
         {
             _options = options ?? throw new ArgumentNullException(nameof(options));
             _result = result ?? throw new ArgumentNullException(nameof(result));
             _toolListGlobalOrToolPathCommand
                 = toolListGlobalOrToolPathCommand ?? new ToolListGlobalOrToolPathCommand(_options, _result);
+            _toolListLocalCommand
+                = toolListLocalCommand ?? new ToolListLocalCommand(_options, _result);
             _global = options.ValueOrDefault<bool>(GlobalOption);
             _local = options.ValueOrDefault<bool>(LocalOption);
             _toolPath = options.SingleArgumentOrDefault(ToolPathOption);
@@ -46,7 +50,14 @@ public override int Execute()
         {
             EnsureNoConflictGlobalLocalToolPathOption();
 
-            return _toolListGlobalOrToolPathCommand.Execute();
+            if (_global || !string.IsNullOrWhiteSpace(_toolPath))
+            {
+                return _toolListGlobalOrToolPathCommand.Execute();
+            }
+            else
+            {
+                return _toolListLocalCommand.Execute();
+            }
         }
 
         private void EnsureNoConflictGlobalLocalToolPathOption()

diff --git a/src/dotnet/commands/dotnet-tool/list/ToolListLocalCommand.cs b/src/dotnet/commands/dotnet-tool/list/ToolListLocalCommand.cs
@@ -0,0 +1,60 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+using System.IO;
+using System.Linq;
+using Microsoft.DotNet.Cli;
+using Microsoft.DotNet.Cli.CommandLine;
+using Microsoft.DotNet.Cli.Utils;
+using Microsoft.DotNet.ToolManifest;
+using Microsoft.Extensions.EnvironmentAbstractions;
+
+namespace Microsoft.DotNet.Tools.Tool.List
+{
+    internal class ToolListLocalCommand : CommandBase
+    {
+        private readonly IToolManifestInspector _toolManifestInspector;
+        private readonly IReporter _reporter;
+        private const string CommandDelimiter = ", ";
+
+        public ToolListLocalCommand(
+            AppliedOption appliedCommand,
+            ParseResult parseResult,
+            IToolManifestInspector toolManifestInspector = null,
+            IReporter reporter = null)
+            : base(parseResult)
+        {
+            if (appliedCommand == null)
+            {
+                throw new ArgumentNullException(nameof(appliedCommand));
+            }
+
+            _reporter = (reporter ?? Reporter.Output);
+
+            _toolManifestInspector = toolManifestInspector ??
+                                     new ToolManifestFinder(new DirectoryPath(Directory.GetCurrentDirectory()));
+        }
+
+        public override int Execute()
+        {
+            var table = new PrintableTable<(ToolManifestPackage toolManifestPackage, FilePath SourceManifest)>();
+
+            table.AddColumn(
+                LocalizableStrings.PackageIdColumn,
+                p => p.toolManifestPackage.PackageId.ToString());
+            table.AddColumn(
+                LocalizableStrings.VersionColumn,
+                p => p.toolManifestPackage.Version.ToNormalizedString());
+            table.AddColumn(
+                LocalizableStrings.CommandsColumn,
+                p => string.Join(CommandDelimiter, p.toolManifestPackage.CommandNames.Select(c => c.Value)));
+            table.AddColumn(
+                LocalizableStrings.ManifestFileColumn,
+                p => p.SourceManifest.Value);
+
+            table.PrintRows(_toolManifestInspector.Inspect(), l => _reporter.WriteLine(l));
+            return 0;
+        }
+    }
+}
diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.cs.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.cs.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Verze</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.de.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.de.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Version</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.es.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.es.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Versión</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.fr.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.fr.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Version</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.it.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.it.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Versione</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.ja.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.ja.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">バージョン</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.ko.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.ko.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">버전</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.pl.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.pl.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Wersja</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.pt-BR.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.pt-BR.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Versão</target>

diff --git a/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.ru.xlf b/src/dotnet/commands/dotnet-tool/list/xlf/LocalizableStrings.ru.xlf
@@ -22,6 +22,11 @@
         <target state="new">List the tools installed in the local tool manifest.</target>
         <note />
       </trans-unit>
+      <trans-unit id="ManifestFileColumn">
+        <source>Manifest</source>
+        <target state="new">Manifest</target>
+        <note />
+      </trans-unit>
       <trans-unit id="VersionColumn">
         <source>Version</source>
         <target state="translated">Версия</target>