[Feature] Make function command

README.md

@@ -48,7 +48,13 @@ Every Sidecar Function requires two things:
 - A PHP Class
 - Files that you want deployed to Lambda
 
-For example, if we were wanting to use Node on Lambda to generate an og:image for all of our blog posts, we would first set up a simple class in PHP called `OgImage`.
+For example, if we were wanting to use Node on Lambda to generate an `og:image` for all of our blog posts, we would first set up a simple class in PHP called `OgImage`.
+To do this we can run the command:
+
+```bash
+php artisan make:lambda-function OgImage
+```
+
 
 `App\Sidecar\OgImage.php`
 

docs/commands.md

@@ -13,18 +13,33 @@ php artisan sidecar:install
 
 ## Configure
 
-The configure command is an interactive command that walks you through setting up your AWS credentials. Dealing with AWS IAM can be a pain, so we wrote this command to do it for you. 
+The configure command is an interactive command that walks you through setting up your AWS credentials. Dealing with AWS IAM can be a pain, so we wrote this command to do it for you.
 
 ```text
 php artisan sidecar:configure
 ```
 
+## Make
+
+The make command will create a new function class in your `app/Sidecar` directory.
+
+```text
+php artisan make:lambda-function MyFunction
+```
+
+You can also pass a `--runtime=` flag to specify the runtime you want to use. The default runtime for newly created functions is `nodejs20.x`.
+To see a list of available runtimes, see the [Runtime](functions/customization#runtime) section.
+
+```text
+php artisan make:lambda-function MyFunction --runtime=python3.10
+```
+
 ## Deploy
 
 The deploy command deploys your functions to Lambda, and can optionally activate them.
 
-To deploy but not activate, run the command without any arguments. 
- 
+To deploy but not activate, run the command without any arguments.
+
 ```text
 php artisan sidecar:deploy
 ```

src/Commands/MakeLambdaFunction.php

@@ -0,0 +1,99 @@
+<?php
+
+/**
+ * @author Wilsen Hernández <[email protected]|https://github.com/wilsenhc>
+ */
+
+namespace Hammerstone\Sidecar\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+#[AsCommand(name: 'make:lambda-function')]
+class MakeLambdaFunction extends GeneratorCommand
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'make:lambda-function {name} {--runtime= : The runtime that will be used to create the lambda function}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new Sidecar Lambda function class';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Lambda';
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return $this->resolveStubPath('/stubs/lambda-function.stub');
+    }
+
+    /**
+     * Resolve the fully-qualified path to the stub.
+     *
+     * @param  string  $stub
+     * @return string
+     */
+    protected function resolveStubPath($stub)
+    {
+        return file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))
+            ? $customPath
+            : __DIR__ . $stub;
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return "{$rootNamespace}\Sidecar";
+    }
+
+    /**
+     * Replace the class name for the given stub.
+     *
+     * @param  string  $stub
+     * @param  string  $name
+     * @return string
+     */
+    protected function replaceClass($stub, $name)
+    {
+        $stub = parent::replaceClass($stub, $name);
+
+        $runtime = $this->option('runtime') ?: 'nodejs20.x';
+
+        return str_replace(['nodejs20.x', '{{ runtime }}'], $runtime, $stub);
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return [
+            ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the lambda function already exists'],
+            ['runtime', null, InputOption::VALUE_OPTIONAL, 'The runtime that will be used to create the lambda function'],
+        ];
+    }
+}

src/Commands/Warm.php

@@ -7,7 +7,6 @@
 namespace Hammerstone\Sidecar\Commands;
 
 use Hammerstone\Sidecar\Sidecar;
-use Illuminate\Console\Command;
 
 class Warm extends EnvironmentAwareCommand
 {

src/Commands/stubs/lambda-function.stub

@@ -0,0 +1,31 @@
+<?php
+
+namespace {{ namespace }};
+
+use Hammerstone\Sidecar\LambdaFunction;
+
+class {{ class }} extends LambdaFunction
+{
+    /**
+     * The function within your code that Lambda calls to begin execution.
+     * @inheritDoc
+     *
+     * @return string
+     */
+    public function handler()
+    {
+        return 'sidecar/function.handler';
+    }
+
+    /**
+     * The runtime environment for the Lambda function.
+     *
+     * @see https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html
+     *
+     * @return string
+     */
+    public function runtime()
+    {
+        return '{{ runtime }}';
+    }
+}

src/Providers/SidecarServiceProvider.php

@@ -14,6 +14,7 @@
 use Hammerstone\Sidecar\Commands\Configure;
 use Hammerstone\Sidecar\Commands\Deploy;
 use Hammerstone\Sidecar\Commands\Install;
+use Hammerstone\Sidecar\Commands\MakeLambdaFunction;
 use Hammerstone\Sidecar\Commands\Warm;
 use Hammerstone\Sidecar\Contracts\AwsClientConfiguration as AwsClientConfigurationContract;
 use Hammerstone\Sidecar\Manager;
@@ -56,6 +57,7 @@ public function boot()
                 Warm::class,
                 Deploy::class,
                 Install::class,
+                MakeLambdaFunction::class,
             ]);
         }