Merge pull request #106 from joedixon/chore/document-command-options

Documents command options

Author: aarondfrancis

src/Commands/Activate.php

@@ -16,14 +16,15 @@ class Activate extends EnvironmentAwareCommand
      *
      * @var string
      */
-    protected $signature = 'sidecar:activate {--pre-warm}';
+    protected $signature = 'sidecar:activate
+                            {--pre-warm : Send warming requests to Sidecar functions}';
 
     /**
      * The console command description.
      *
      * @var string
      */
-    protected $description = 'Activate Sidecar functions that have already been deployed.';
+    protected $description = 'Activate Sidecar functions that have already been deployed';
 
     /**
      * @throws NoFunctionsRegisteredException

src/Commands/Configure.php

@@ -28,7 +28,7 @@ class Configure extends Command
      *
      * @var string
      */
-    protected $description = 'Interactively configure your Sidecar AWS environment variables.';
+    protected $description = 'Interactively configure your Sidecar AWS environment variables';
 
     /**
      * @var string
@@ -70,11 +70,11 @@ public function handle()
 
         $this->line(' ');
         $this->info('Done! Here are your environment variables:');
-        $this->line('SIDECAR_ACCESS_KEY_ID=' . $credentials['key']);
-        $this->line('SIDECAR_SECRET_ACCESS_KEY=' . $credentials['secret']);
-        $this->line('SIDECAR_REGION=' . $this->region);
-        $this->line('SIDECAR_ARTIFACT_BUCKET_NAME=' . $bucket);
-        $this->line('SIDECAR_EXECUTION_ROLE=' . $role);
+        $this->line('SIDECAR_ACCESS_KEY_ID='.$credentials['key']);
+        $this->line('SIDECAR_SECRET_ACCESS_KEY='.$credentials['secret']);
+        $this->line('SIDECAR_REGION='.$this->region);
+        $this->line('SIDECAR_ARTIFACT_BUCKET_NAME='.$bucket);
+        $this->line('SIDECAR_EXECUTION_ROLE='.$role);
         $this->line(' ');
         $this->info('They will work in any environment.');
     }
@@ -92,9 +92,9 @@ public function client($class)
                 'version' => 'latest',
                 'credentials' => [
                     'key' => $this->key,
-                    'secret' => $this->secret
-                ]
-            ]
+                    'secret' => $this->secret,
+                ],
+            ],
         ]);
     }
 

src/Commands/Deploy.php

@@ -16,14 +16,16 @@ class Deploy extends EnvironmentAwareCommand
      *
      * @var string
      */
-    protected $signature = 'sidecar:deploy {--activate} {--pre-warm}';
+    protected $signature = 'sidecar:deploy 
+                            {--activate : Activate the deployment after deploying} 
+                            {--pre-warm : Send warming requests to Sidecar functions}';
 
     /**
      * The console command description.
      *
      * @var string
      */
-    protected $description = 'Deploy Sidecar functions.';
+    protected $description = 'Deploy Sidecar functions';
 
     /**
      * @throws NoFunctionsRegisteredException

src/Commands/Install.php

@@ -23,7 +23,7 @@ class Install extends Command
      *
      * @var string
      */
-    protected $description = 'Install the Sidecar config file into your app.';
+    protected $description = 'Install the Sidecar config file into your app';
 
     public function __construct()
     {
@@ -40,7 +40,7 @@ public function __construct()
     public function handle()
     {
         Artisan::call('vendor:publish', [
-            '--provider' => SidecarServiceProvider::class
+            '--provider' => SidecarServiceProvider::class,
         ]);
 
         $this->info('Config file published!');

src/Commands/Warm.php

@@ -22,7 +22,7 @@ class Warm extends EnvironmentAwareCommand
      *
      * @var string
      */
-    protected $description = 'Send warming requests to Sidecar functions.';
+    protected $description = 'Send warming requests to Sidecar functions';
 
     /**
      * @throws Exception