Console create:plugin - PascalCase namespace

[WebVPF]

Winter CMS Build

dev-develop

PHP Version

8.0

Database engine

MySQL/MariaDB

Plugins installed

No response

Issue description

Winter CMS 1.2
Console command create:plugin incorrectly changes namespace. Camelcase names are changed to capitalized names.
Example:

php artisan create:plugin WebVPF.MyName

Plugin.php file generation result:

<?php namespace Webvpf\Myname;
...

Must be:

<?php namespace WebVPF\MyName;

Steps to replicate

Create a plugin

Workaround

No response

[arvislacis]

Some comments for clarification:

1. Issue name and description should contain PascalCase not camelCase;
2. Issue is probably more relevant in wintercms/storm repository but that's just side node;
3. If we look at https://wintercms.com/docs/help/developer/guide#vendor-naming then it states - "The vendor or author code in a namespace must begin with an uppercase character and should not contain underscores or dashes." - nothing much about Pascal case here.
4. Pascal Case is mentioned under https://wintercms.com/docs/help/developer/guide#class-naming
5. If we look into WinterCMS own plugins then it looks like mostly PascalCase is used in the namespace names, for example:

• https://github.com/wintercms/wn-pwnedpasswords-plugin/blob/main/Plugin.php
• https://github.com/wintercms/wn-mailchimp-plugin/blob/main/Plugin.php
• https://github.com/wintercms/wn-drivermandrill-plugin/blob/main/Plugin.php
• etc.

So, yes, could be an issue.

[LukeTowers]

Just need to change a single line here: https://github.com/wintercms/winter/blob/wip%2F1.2/modules/system/console/BaseScaffoldCommand.php#L47. PRs welcome.

[RomainMazB]

@LukeTowers Actually, to be synced with the scaffold methods' code style, we'll need another modification here to add the ucfirst case: https://github.com/wintercms/storm/blob/develop/src/Scaffold/GeneratorCommand.php#L144-L146

[LukeTowers]

@RomainMazB I'm not sure I understand, could you expand on that?

[RomainMazB]

Sure @LukeTowers.

To convert "WebVPF" to "WebVPF" and ensuring the first letter is uppercase to keep the PascalCase style, we need to use the php native ucfirst function, or the Str::ucfirst laravel helper.

So, to me, we have two ways to fix this:
The cheap:

// Using native ucfirst function or Str::ucfirst directly inside the method you mentioned
$ucfirst_author = ucfirst($vars['author']);
$ucfirst_plugin = ucfirst($vars['plugin']);
$vars['plugin_namespace'] = "{$ucfirst_author}\\{$ucfirst_plugin}";

The good (to me):

// GeneratorCommand.php
    protected function processVars($vars)
    {
        $cases = ['upper', 'lower', 'snake', 'studly', 'camel', 'title', 'ucfirst']; // Add ucfirst casing

// BaseScaffoldCommand.php
$vars['plugin_namespace'] = "{$vars['ucfirst_author']}\\{$vars['ucfirst_plugin']}";

---

The second one looks prettier with the rest of the method:

$vars = parent::processVars($vars);

$vars['plugin_id'] = "{$vars['lower_author']}.{$vars['lower_plugin']}";
$vars['plugin_code'] = "{$vars['studly_author']}.{$vars['studly_plugin']}";
$vars['plugin_url'] = "{$vars['lower_author']}/{$vars['lower_plugin']}";
$vars['plugin_folder'] = "{$vars['lower_author']}/{$vars['lower_plugin']}";
$vars['plugin_namespace'] = "{$vars['ucfirst_author']}\\{$vars['ucfirst_plugin']}";

return $vars;

instead of this:

$vars = parent::processVars($vars);

$ucfirst_author = ucfirst($vars['author']);
$ucfirst_plugin = ucfirst($vars['plugin']);

$vars['plugin_id'] = "{$vars['lower_author']}.{$vars['lower_plugin']}";
$vars['plugin_code'] = "{$vars['studly_author']}.{$vars['studly_plugin']}";
$vars['plugin_url'] = "{$vars['lower_author']}/{$vars['lower_plugin']}";
$vars['plugin_folder'] = "{$vars['lower_author']}/{$vars['lower_plugin']}";
$vars['plugin_namespace'] = "{$ucfirst_author}\\{$ucfirst_plugin}";

return $vars;

[arvislacis]

@LukeTowers I think that @RomainMazB was referrencing that we would need to add ucfirst modifier (https://www.php.net/manual/en/function.ucfirst.php) to make the first character of the string uppercase. However, that is not needed as studly case is basically equal to PascalCase (https://www.php-fig.org/psr/psr-12/#21-basic-coding-standard).

[RomainMazB]

@arvislacis you've got a point. So now the question is: why php artisan create:plugin WebVPF.MyName generates these studly variables:

"studly_author" => "Webvpf"
"studly_plugin" => "Myname"

and Str::studly('WebVPF') generates the good studly case 🤔

>>> Str::studly('WebVPF');
=> "WebVPF"
>>> Str::studly('MyName');
=> "MyName"