Added experimental ZSH completion, some more commands and cleanup

Author: JohnnyCrazy

.gitignore

@@ -359,3 +359,4 @@ MigrationBackup/
 
 # End of https://www.toptal.com/developers/gitignore/api/csharp
 sp0_aur/
+Sp0.Core/sp0-dev

README.md

@@ -46,6 +46,48 @@ This configuration does not allow to manage and access user related endpoints, l
 
 Afterwards, login via `sp0 login` and follow the instructions.
 
+## Examples
+
+### Transfer Playback using fzf
+
+```bash
+#!/bin/sh
+device="$(sp0 player devices | jq -r "map(.name + \":\" + .id) | join(\"\n\")" | fzf | cut -d':' -f2)"
+if [ "$device" ]; then
+  sp0 player transfer "$device" --play
+fi
+```
+
+### Export a Playlist
+
+```bash
+#!/bin/sh
+backupFile="${1:-backup.txt}"
+
+playlist="$(sp0 playlists of-user | jq -sr "map(.name + \":\" + .id) | join(\"\n\")" | fzf)"
+playlistId="$(echo "$playlist" | rev | cut -d':' -f 1 | rev)"
+playlistName="$(echo "$playlist" | rev | cut -d':' -f 2- | rev)"
+file="$(printf '%q' "$playlistName")"
+if [ "$playlistId" ]; then
+  sp0 playlists get-items "$playlistId" --output uri > "$backupFile"
+  echo "Playlist track/epsiode URIs can be found in $backupFile"
+fi
+```
+
+### Import a Playlist
+
+```bash
+#!/bin/sh
+backupFile="${1:-backup.txt}"
+playlistName="${2:-Imported Playlist}"
+
+if [[ -f "$backupFile" ]]; then
+  uris="$(cat "$backupFile" | xargs echo -n | tr ' ' ',')"
+  paylistId="$(sp0 playlists create "$playlistName" --private --output id)"
+  sp0 playlists add-items "$playlistId" "$uris"
+fi
+```
+
 ## File Size & Exectution Notes
 
 As you may have noted, the binary size of ~26MB is higher than usual form similar CLI Tools. This is because the binary includes the full .NET environment in a compressed form, accomplished by [dotnet-warp](https://github.com/Hubert-Rybak/dotnet-warp).

Sp0.Core/src/App.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 using McMaster.Extensions.CommandLineUtils;
@@ -41,6 +42,8 @@ public async Task<int> RunApp(string[] args, ServiceProvider services)
         () => $"sp0 version {Version.AppVersion}"
       );
 
+      app.CompletionCommand("completion", new List<ICompletionProvider> { new ZSHCompletionProvider() });
+
       try
       {
         return await app.ExecuteAsync(args);

Sp0.Core/src/Arguments/PagingArguments.cs

@@ -31,34 +31,39 @@ public void Register(CommandLineApplication app)
       {
         login.Description = "Log into a user account via OAuth2. Only required when accessing user related data.";
 
-        var addressCmd = login.Option<Uri?>(
+        var addressCmd = login.OptionalOption<Uri?>(
           "-a|--address",
-          $"Optional: URI of the webserver used to authenticate. Also needs to be added as redirect uri to your spotify app. Default: {addressDefault}",
+          $"URI of the webserver used to authenticate. Also needs to be added as redirect uri to your spotify app",
+          addressDefault,
           CommandOptionType.SingleValue
         );
         addressCmd.Validators.Add(new AbsoluteURIValidator());
 
-        var portOpt = login.Option<int?>(
+        var portOpt = login.OptionalOption<int?>(
           "-p|--port",
-          $"Optional: Listen port of the authentication webserver. Default: {portDefault}",
+          $"Listen port of the authentication webserver",
+          portDefault,
           CommandOptionType.SingleValue
         );
 
-        var scopesOpt = login.Option<List<string>?>(
+        var scopesOpt = login.OptionalOption<List<string>?>(
           "-s|--scopes",
-          $"Optional: A comma seperated list of scopes to request. Default: All",
+          $"A comma seperated list of scopes to request",
+          "All",
           CommandOptionType.SingleValue
         );
 
-        var timeoutOpt = login.Option<int?>(
+        var timeoutOpt = login.OptionalOption<int?>(
           "-t|--timeout",
-          $"Optional: Timeout of command in seconds. Default: ${timeoutDefault}",
+          $"Timeout of command in seconds",
+          timeoutDefault,
           CommandOptionType.SingleValue
         );
 
-        var stateOpt = login.Option<int?>(
+        var stateOpt = login.OptionalOption<int?>(
           "--state",
-          $"Optional: State value used for the authentcation. Default: random generated string",
+          $"State value used for the authentcation",
+          "random generated string",
           CommandOptionType.SingleValue
         );
 

Sp0.Core/src/Commands/LoginCommand.cs

@@ -40,9 +40,10 @@ public void Register(CommandLineApplication app)
 
     private CommandOption DeviceIdOption(CommandLineApplication app)
     {
-      return app.Option(
+      return app.OptionalOption<string>(
         "-d|--device-id",
-        "Optional: The id of the device this command is targeting. If not supplied, the user’s currently active device is the target.",
+        "The id of the device this command is targeting",
+        "the user’s currently active device",
         CommandOptionType.SingleValue
       );
     }
@@ -104,9 +105,10 @@ private void CurrentPlaybackCommand(CommandLineApplication player)
       {
         currentPlayback.Description = "Get information about the user’s current playback state, including track or episode, progress, and active device.";
 
-        var market = currentPlayback.Option<string>(
+        var market = currentPlayback.OptionalOption<string>(
           "-m|--market",
-          "Optional: The specifc market, used for track re-linking",
+          "The specifc market, used for track re-linking",
+          "User's market",
           CommandOptionType.SingleValue
         );
 
@@ -251,27 +253,31 @@ private void PlayCommand(CommandLineApplication player)
 
         var deviceId = DeviceIdOption(play);
 
-        var contextUri = play.Option(
+        var contextUri = play.OptionalOption<string>(
           "-c|--context-uri",
-          "Optional: Spotify URI of the context to play. Valid contexts are albums, artists, playlists.",
+          "Spotify URI of the context to play. Valid contexts are albums, artists, playlists.",
+          "none",
           CommandOptionType.SingleValue
         );
 
-        var uris = play.Option<List<string>>(
+        var uris = play.OptionalOption<List<string>>(
           "-u|--uris",
-          "Optional: A list of Spotify track URIs to play, seperated by comma",
+          "A list of Spotify track URIs to play, seperated by comma",
+          "none",
           CommandOptionType.SingleValue
         );
 
-        var positionMs = play.Option<int?>(
+        var positionMs = play.OptionalOption<int?>(
           "-p|--positon-ms",
-          "Optional: Indicates from what position to start playback. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.",
+          "Indicates from what position to start playback. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.",
+          "none",
           CommandOptionType.SingleValue
         );
 
-        var offset = play.Option<string>(
+        var offset = play.OptionalOption<string>(
           "-o|--offset",
-          "Optional: Indicates from where in the context playback should start. Only available when context-uri corresponds to an album or playlist object, or when the uris parameter is used. Either a zero based position or URI",
+          "Indicates from where in the context playback should start. Only available when context-uri corresponds to an album or playlist object, or when the uris parameter is used. Either a zero based position or URI",
+          "none",
           CommandOptionType.SingleValue
         );