Merge pull request #112 from christyjacob4/fix-cli-issues

Fix cli issues

Author: eldadfux

example.php

@@ -337,7 +337,17 @@ function getSSLPage($url) {
     $sdk->generate(__DIR__ . '/examples/dotnet');
 
     // CLI
-    $sdk  = new SDK(new CLI(), new Swagger2($spec));
+    $cli = new CLI();
+    $cli->setExecutableName('appwrite');
+    $cli->setLogo("
+    _                            _ _           ___   __   _____ 
+   /_\  _ __  _ ____      ___ __(_) |_ ___    / __\ / /   \_   \
+  //_\\| '_ \| '_ \ \ /\ / / '__| | __/ _ \  / /   / /     / /\/
+ /  _  \ |_) | |_) \ V  V /| |  | | ||  __/ / /___/ /___/\/ /_  
+ \_/ \_/ .__/| .__/ \_/\_/ |_|  |_|\__\___| \____/\____/\____/  
+       |_|   |_|                                                  
+ ");
+    $sdk  = new SDK($cli, new Swagger2($spec));
     $sdk
         ->setName('NAME')
         ->setDescription('Repo description goes here')

src/SDK/Language/CLI.php

@@ -4,6 +4,39 @@
 
 class CLI extends PHP {
 
+    /**
+     * @var array
+     */
+    protected $params = [
+        'composerVendor' => 'vendor-name',
+        'composerPackage' => 'package-name',
+        'executableName' => 'executable',
+        'logo' => ''
+    ];
+
+    /**
+     * @param string $name
+     * @return $this
+     */
+    public function setExecutableName($name)
+    {
+        $this->setParam('executableName', $name);
+
+        return $this;
+    }
+
+    /**
+     * @param string $logo
+     * @return $this
+     */
+    public function setLogo($logo)
+    {
+        $this->setParam('logo', $logo);
+
+        return $this;
+    }
+
+
     /**
      * @return string
      */
@@ -139,6 +172,18 @@ public function getFiles()
                 'template'      => '/cli/bin/client.twig',
                 'minify'        => false,
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/install.sh',
+                'template'      => '/cli/install.sh.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/install.ps1',
+                'template'      => '/cli/install.ps1.twig',
+                'minify'        => false,
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => '/bin/help',

templates/cli/README.md.twig

@@ -21,73 +21,73 @@ You can install the CLI by getting our installation script.
 
 ### Linux / MacOS 
 ```bash
-$ wget -q https://appwrite.io/cli/install.sh  -O - | /bin/bash  
+$ wget -q https://{{ spec.title | lower }}.io/cli/install.sh  -O - | /bin/bash  
 ```
 
 ### Windows
 ```powershell
-$ iwr -useb https://appwrite.io/cli/install.ps1 | iex
+$ iwr -useb https://{{ spec.title | lower }}.io/cli/install.ps1 | iex
 ```
 
 ## Initialisation 
 The CLI needs to be initialised with your project settings. This can be done using 
 ```sh
-$ appwrite init 
+$ {{ language.params.executableName }} init 
 ```
 
-The CLI requires an endpoint, project ID, API key and a locale to be able to communicate with the Appwrite backend server. There are two ways to achieve this 
+The CLI requires an endpoint, project ID, API key and a locale to be able to communicate with the {{ spec.title | caseUcfirst }} backend server. There are two ways to achieve this 
 
 ### 1. Environment file 
 ```sh
-$ appwrite --env-file path/to/your/environment/file init     
+$ {{ language.params.executableName }} --env-file path/to/your/environment/file init     
 ```
 The .env file must have the following keys 
 ```sh
 endpoint=http://192.168.1.6/v1
-X-Appwrite-Project=5ff450422d42f
-X-Appwrite-Key=0773c7...a2672a
-X-Appwrite-Locale=en-US
+X-{{ spec.title | caseUcfirst }}-Project=5ff450422d42f
+X-{{ spec.title | caseUcfirst }}-Key=0773c7...a2672a
+X-{{ spec.title | caseUcfirst }}-Locale=en-US
 ```
 
 ### 2. Using the prompt
 
-Invoking `appwrite init` without an env file triggers an interactive prompt where you can manually enter the details. These values are saved locally so that you dont have to re-enter them everytime. 
+Invoking `{{ language.params.executableName }} init` without an env file triggers an interactive prompt where you can manually enter the details. These values are saved locally so that you dont have to re-enter them everytime. 
 
 ## Usage 
 
-The Appwrite CLI follows the following general syntax.
+The {{ spec.title | caseUcfirst }} CLI follows the following general syntax.
 ```sh
-$ appwrite [SERVICE] [COMMAND] --[OPTIONS]
+$ {{ language.params.executableName }} [SERVICE] [COMMAND] --[OPTIONS]
 ```
 
 A few sample commands to get you started 
 
 ```sh
-$ appwrite users create --email="hello@appwrite.io" --password="very_strong_password"
-$ appwrite users list 
+$ {{ language.params.executableName }} users create --email="hello@{{ spec.title | lower }}.io" --password="very_strong_password"
+$ {{ language.params.executableName }} users list 
 ```
 
 To get information about the different services available, you can use 
 ```sh
-$ appwrite help
+$ {{ language.params.executableName }} help
 ```
 
 To get information about a particular service and the commands available in a service you can use 
 ```sh
-$ appwrite users help
-$ appwrite accounts help
+$ {{ language.params.executableName }} users help
+$ {{ language.params.executableName }} accounts help
 ```
 
 To get information about a particular command and the parameters it accepts, you can use
 
 ```sh
-$ appwrite users list --help
-$ appwrite account get --help 
+$ {{ language.params.executableName }} users list --help
+$ {{ language.params.executableName }} account get --help 
 ```
 
 ## Contribution
 
-This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
+This library is auto-generated by {{ spec.title | caseUcfirst }} custom [SDK Generator](https://github.com/{{ spec.title | lower }}/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/{{ spec.title | lower }}/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
 
 ## License
 

templates/cli/app/services/client.php.twig

@@ -8,20 +8,43 @@ use {{ spec.title | caseUcfirst }}\Client;
 use Utopia\CLI\CLI;
 use Utopia\Validator\Mock;
 use Utopia\CLI\Console;
+use {{ spec.title | caseUcfirst }}\Parser;
 
 $client = new Client();
 $cli = new CLI();
+$parser = new Parser();
+
+$cli->
+      init(function() use ($cli, $parser) {
+        
+        if (array_key_exists('help', $cli->getArgs())) {
+            $taskName = $cli->match()->getName();
+            $task = $cli->getTasks()[$taskName];
+            $description = $task->getLabel('description', '');
+            $params = $task->getParams();
+
+            Console::log("\e[0;31;m {{ language.params.logo | raw }} \e[0m") ;
+            Console::log("\nUsage : {{ language.params.executableName }} client {$taskName} --[OPTIONS] \n");
+            Console::log($description);
+            Console::log("Options:");
+            array_walk($params, function(&$key) {
+                $key = $key['description'];
+            });
+            $parser->formatArray($params);
+            Console::exit(0);
+        }
+      });
 
 $cli
     ->task('setEndpoint')
-    ->param('endpoint', '', new Mock(), 'Your Appwrite endpoint', false)
+    ->param('endpoint', '', new Mock(), 'Your {{ spec.title | title }} endpoint', false)
     ->action(function($endpoint) use ($client) {
         $client->setPreference('endpoint', $endpoint);
         $result = $client->savePreferences();
         if ($result === false) {
-            Console::error('Could not save preferences.');
+            Console::error('❌ Could not save preferences.');
         } else {
-            Console::success('Preferences saved successfully');
+            Console::success('✅ Preferences saved successfully');
         }
     });
 
@@ -34,9 +57,9 @@ $cli
         $client->setPreference('{{ header.name }}', ${{ header.key | lower }});
         $result = $client->savePreferences();
         if ($result === false) {
-            Console::error('Could not save preferences.');
+            Console::error('❌ Could not save preferences.');
         } else {
-            Console::success('Preferences saved successfully');
+            Console::success('✅ Preferences saved successfully');
         }
     });
 
@@ -49,4 +72,22 @@ $cli
        Console::log('Server Version : {{ spec.version | url_encode }}');
     });
 
+
+$cli
+    ->task('help')
+    ->action(function() use ($parser) {
+        Console::log("\e[0;31;m {{ language.params.logo | raw }} \e[0m") ;
+        Console::log("\nUsage : {{ language.params.executableName }} client [COMMAND]\n");
+        Console::log("Commands :");
+        $commands = [
+            "setEndpoint" => "Set your server endpoint.",
+            "setProject" => "Set the project you want to connect to.",
+            "setKey" => "Set the API key for the project.",
+            "setLocale" => "Set your preferred locale (eg: en-US)."
+        ];
+        $parser->formatArray($commands);
+        Console::log("\nRun '{{ language.params.executableName }} client COMMAND --help' for more information on a command.");
+    });
+    
+
 $cli->run();

templates/cli/app/services/help.php.twig

@@ -2,20 +2,20 @@
 
 namespace {{ spec.title | caseUcfirst }}\Services;
 
-echo "\e[0;31;m
-   _                            _ _       
-  /_\  _ __  _ ____      ___ __(_) |_ ___ 
- //_\\| '_ \| '_ \ \ /\ / / '__| | __/ _ \
-/  _  \ |_) | |_) \ V  V /| |  | | ||  __/
-\_/ \_/ .__/| .__/ \_/\_/ |_|  |_|\__\___|
-      |_|   |_|                           
-      
-      \e[0m" ;
+require_once './vendor/autoload.php';
 
-printf("\nUsage : appwrite [SERVICE] [COMMAND] --[OPTION]\n\n");
-printf("Services :\n");
-$mask = "\t%-20.20s %-125.125s\n";
+use Utopia\CLI\Console;
+use {{ spec.title | caseUcfirst }}\Parser;
+
+$parser = new Parser();
+
+Console::log("\e[0;31;m {{ language.params.logo | raw }} \e[0m") ;
+Console::log("\nUsage : {{ language.params.executableName }} [SERVICE] [COMMAND] --[OPTION]\n");
+Console::log("Services :");
+$commands = [
 {% for service in spec.services %}
-printf($mask, "{{ service.name }}", "{{ service.description | replace({'"':'\''}) | raw }}");
+        "{{ service.name }}" => "{{ service.description | replace({'"':'\''}) | raw }}",
 {% endfor %}
-printf("\nRun 'appwrite [SERVICE] help' for more information on a service.\n");
+        ];
+$parser->formatArray($commands);
+Console::log("\nRun '{{ language.params.executableName }} [SERVICE] help' for more information on a service.");

templates/cli/app/services/init.php.twig

@@ -1,13 +1,14 @@
 <?php
 
-namespace Appwrite\Services;
+namespace {{ spec.title | caseUcfirst }}\Services;
 
 require_once './vendor/autoload.php';
 
 use Exception;
 use Utopia\CLI\CLI;
 use Utopia\Validator\Mock;
 use Utopia\CLI\Console;
+use {{ spec.title | caseUcfirst }}\Parser;
 
 const USER_PREFERENCES_FILE = __DIR__."/../../.preferences/.prefs.json";
 const PREFERENCE_ENDPOINT = "endpoint";
@@ -110,7 +111,7 @@ function promptUser()
     }
 
     if(empty(getPreference('X-Appwrite-Project'))) {
-        $project = Console::confirm('🟢 Enter your project from the Appwrite console: ');
+        $project = Console::confirm('🟢 Enter your project from the {{ spec.title | caseUcfirst }} console: ');
         if (empty($project)) {
             Console::error("❌ You cannot continue without a project. Exiting...");
             exit();
@@ -119,7 +120,7 @@ function promptUser()
     }
 
     if(empty(getPreference('X-Appwrite-Key'))) {
-        $key = Console::confirm('🟢 Enter your key from the Appwrite console: ');
+        $key = Console::confirm('🟢 Enter your key from the {{ spec.title | caseUcfirst }} console: ');
         if (empty($key)) {
             Console::error("❌ You cannot continue without a key. Exiting...");
             exit();
@@ -141,10 +142,33 @@ function promptUser()
 }
 
 $cli = new CLI();
+$parser = new Parser();
+
+$cli->
+      init(function() use ($cli, $parser) {
+        
+        if (array_key_exists('help', $cli->getArgs())) {
+            $taskName = $cli->match()->getName();
+            $task = $cli->getTasks()[$taskName];
+            $description = $task->getLabel('description', '');
+            $params = $task->getParams();
+
+            Console::log("\e[0;31;m {{ language.params.logo | raw }} \e[0m") ;
+            Console::log("\nUsage : {{ language.params.executableName }} {$taskName} --[OPTIONS] \n");
+            Console::log($description);
+            Console::log("Options:");
+            array_walk($params, function(&$key) {
+                $key = $key['description'];
+            });
+            $parser->formatArray($params);
+            Console::exit(0);
+        }
+      });
 
 $cli
     ->task('init')
-    ->param('endpoint', '', new Mock(), 'Your Appwrite endpoint', true)
+    ->label('description', "The init command is used to initialise your CLI\n")
+    ->param('endpoint', '', new Mock(), 'Your {{ spec.title | caseUcfirst }} endpoint', true)
 {% for header in spec.global.headers %}
     ->param('{{ header.key | lower }}', '', new Mock(), '{{ header.description }}', true)
 {% endfor %}