Shortcode artisan command make:shortcode (#83)

Author: umefarooq

README.md

@@ -27,7 +27,7 @@ If you are looking for Laravel 4.2, see: https://github.com/patrickbrouwers/Lara
 
 Via Composer
 
-``` bash
+```bash
 $ composer require "webwizo/laravel-shortcodes:1.0.*"
 ```
 
@@ -107,7 +107,7 @@ Shortcode::strip($contents);
 
 Create a new ServiceProvider where you can register all the shortcodes.
 
-``` bash
+```bash
 php artisan make:provider ShortcodesServiceProvider
 ```
 
@@ -128,6 +128,7 @@ php artisan make:provider ShortcodesServiceProvider
 ```
 
 ShortcodesServiceProvider.php Class File
+
 ```php
 <?php namespace App\Providers;
 
@@ -163,6 +164,7 @@ class ShortcodesServiceProvider extends ServiceProvider
 ### Default class for BoldShortcode
 
 You can store each shortcode within their class `app/Shortcodes/BoldShortcode.php`
+
 ```php
 namespace App\Shortcodes;
 
@@ -172,13 +174,14 @@ class BoldShortcode {
   {
     return sprintf('<strong class="%s">%s</strong>', $shortcode->class, $content);
   }
-  
+
 }
 ```
 
 ### Class with custom method
 
 You can store each shortcode within their class `app/Shortcodes/ItalicShortcode.php`
+
 ```php
 namespace App\Shortcodes;
 
@@ -188,7 +191,7 @@ class ItalicShortcode {
   {
     return sprintf('<i class="%s">%s</i>', $shortcode->class, $content);
   }
-  
+
 }
 ```
 
@@ -203,10 +206,43 @@ class BoldShortcode {
   {
     return '<strong '. $shortcode->get('class', 'default') .'>' . $content . '</strong>';
   }
-  
+
 }
 ```
 
+## Shortcode Artisan Generator Command
+
+This package provides an Artisan command to quickly generate shortcode classes:
+
+```php
+php artisan make:shortcode YourShortcodeName
+```
+
+-   By default, this creates a new class in `app/Shortcodes/YourShortcodeNameShortcode.php`.
+-   If the file already exists, use the `--force` option to overwrite:
+
+```bash
+php artisan make:shortcode YourShortcodeName --force
+```
+
+### Customizing the Stub
+
+You can publish the stub file to customize the generated class:
+
+```bash
+php artisan vendor:publish --tag=shortcode-stubs
+```
+
+This will copy the stub to `resources/stubs/shortcode.stub` in your Laravel app. Edit this file to change the template for new shortcode classes.
+
+## Testing
+
+To run the tests for the shortcode generator command:
+
+```bash
+composer test
+```
+
 ## Change log
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
@@ -221,8 +257,8 @@ If you discover any security related issues, please email [email protected] inst
 
 ## Credits
 
-- [Asif Iqbal][link-author]
-- [All Contributors][link-contributors]
+-   [Asif Iqbal][link-author]
+-   [All Contributors][link-contributors]
 
 ## Support me
 
@@ -238,7 +274,6 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
 [ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/webwizo/laravel-shortcodes.svg?style=flat-square
 [ico-code-quality]: https://img.shields.io/scrutinizer/g/webwizo/laravel-shortcodes.svg?style=flat-square
 [ico-downloads]: https://img.shields.io/packagist/dt/webwizo/laravel-shortcodes.svg?style=flat-square
-
 [link-packagist]: https://packagist.org/packages/webwizo/laravel-shortcodes
 [link-travis]: https://travis-ci.org/webwizo/laravel-shortcodes
 [link-scrutinizer]: https://scrutinizer-ci.com/g/webwizo/laravel-shortcodes/code-structure

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "webwizo/laravel-shortcodes",
     "type": "library",
-    "description": "Wordpress like shortcodes for Laravel 5, 6, 7, 8, 9, 10 and 11",
+    "description": "Wordpress like shortcodes for Laravel 5, 6, 7, 8, 9, 10, 11 and 12",
     "keywords": [
         "laravel",
         "wordpress",

resources/stubs/shortcode.stub

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Shortcodes;
+
+class {{class}}
+{
+    public function register($shortcode, $content, $compiler, $name, $viewData)
+    {
+        // Implement shortcode logic here
+        return $content;
+    }
+}

src/Console/MakeShortcodeCommand.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Webwizo\Shortcodes\Console;
+
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+
+class MakeShortcodeCommand extends Command
+{
+    protected $signature = 'make:shortcode {name} {--force}';
+    protected $description = 'Create a new shortcode class';
+
+    protected $files;
+
+    public function __construct(Filesystem $files)
+    {
+        parent::__construct();
+        $this->files = $files;
+    }
+
+    public function handle()
+    {
+        $name = $this->argument('name');
+        $className = ucfirst($name) . 'Shortcode';
+        $path = $this->getShortcodePath($className);
+        $force = $this->option('force');
+
+        if ($this->files->exists($path) && !$force) {
+            $this->error("Shortcode class already exists: {$className}. Use --force to overwrite.");
+            return 1;
+        }
+
+        $stub = $this->getStub($className);
+        $this->files->ensureDirectoryExists(dirname($path));
+        $this->files->put($path, $stub);
+
+        $this->info("Shortcode class created: {$path}");
+        return 0;
+    }
+
+    protected function getShortcodePath($className)
+    {
+        // Use Laravel's app_path helper if available, fallback to relative path
+        if (function_exists('app_path')) {
+            return app_path("Shortcodes/{$className}.php");
+        }
+        return getcwd() . "/app/Shortcodes/{$className}.php";
+    }
+
+    protected function getStub($className)
+    {
+        $stubPath = base_path('resources/stubs/shortcode.stub');
+        if (!$this->files->exists($stubPath)) {
+            // fallback to package stub if not published
+            $stubPath = __DIR__ . '/../../resources/stubs/shortcode.stub';
+        }
+        $stub = $this->files->get($stubPath);
+        return str_replace('{{class}}', $className, $stub);
+    }
+}

src/ShortcodesServiceProvider.php

@@ -16,6 +16,15 @@ class ShortcodesServiceProvider extends ServiceProvider
     public function boot()
     {
         $this->enableCompiler();
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                \Webwizo\Shortcodes\Console\MakeShortcodeCommand::class,
+            ]);
+            // Publish stub file for customization
+            $this->publishes([
+                __DIR__ . '/../resources/stubs/shortcode.stub' => resource_path('stubs/shortcode.stub'),
+            ], 'shortcode-stubs');
+        }
     }
 
     /**

tests/MakeShortcodeCommandTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Webwizo\Shortcodes\Tests;
+
+use Illuminate\Filesystem\Filesystem;
+use Webwizo\Shortcodes\Console\MakeShortcodeCommand;
+use Webwizo\Shortcodes\ShortcodesServiceProvider;
+use Orchestra\Testbench\TestCase;
+
+class MakeShortcodeCommandTest extends TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [ShortcodesServiceProvider::class];
+    }
+
+    public function test_it_creates_shortcode_class()
+    {
+        $filesystem = new Filesystem();
+        $name = 'Demo';
+        $className = 'DemoShortcode';
+        $path = app_path("Shortcodes/{$className}.php");
+
+        // Remove file if it exists
+        if ($filesystem->exists($path)) {
+            $filesystem->delete($path);
+        }
+
+        $this->artisan('make:shortcode', ['name' => $name])
+            ->expectsOutput("Shortcode class created: {$path}")
+            ->assertExitCode(0);
+
+        $this->assertTrue($filesystem->exists($path));
+        $contents = $filesystem->get($path);
+        $this->assertStringContainsString('class DemoShortcode', $contents);
+    }
+
+    public function test_force_overwrites_existing_class()
+    {
+        $filesystem = new Filesystem();
+        $name = 'Demo';
+        $className = 'DemoShortcode';
+        $path = app_path("Shortcodes/{$className}.php");
+
+        // Create file with dummy content
+        $filesystem->ensureDirectoryExists(dirname($path));
+        $filesystem->put($path, '<?php // dummy');
+
+        $this->artisan('make:shortcode', ['name' => $name, '--force' => true])
+            ->expectsOutput("Shortcode class created: {$path}")
+            ->assertExitCode(0);
+
+        $contents = $filesystem->get($path);
+        $this->assertStringContainsString('class DemoShortcode', $contents);
+    }
+}