Fix #247: Allow configurable file headers for generated modules via .prestashopConsole/licence.txt

Author: nenes25

examples/custom-licence-template.txt

@@ -0,0 +1,15 @@
+/**
+ * 2024-{YEAR} Your Company Name
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License (AFL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/afl-3.0.php
+ *
+ * @author    Your Name <your.email@example.com>
+ * @copyright 2024-{YEAR} Your Company Name
+ * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+ */
+ 

src/PrestashopConsole/Command/Module/Generate/ControllerCommand.php

@@ -61,6 +61,7 @@ protected function configure(): void
         $this
             ->setName('module:generate:controller')
             ->setDescription('Generate module controller file')
+            ->setHelp('Create .prestashopConsole/licence.txt at PrestaShop root to customize generated file headers')
             ->addArgument('moduleName', InputArgument::REQUIRED, 'module name')
             ->addArgument('controllerName', InputArgument::REQUIRED, 'controller name')
             ->addArgument('controllerType', InputArgument::REQUIRED, 'controller type')

src/PrestashopConsole/Command/Module/Generate/ModuleCommand.php

@@ -48,6 +48,7 @@ protected function configure(): void
         $this
             ->setName('module:generate:module')
             ->setDescription('Generate module default file')
+            ->setHelp('Create .prestashopConsole/licence.txt at PrestaShop root to customize generated file headers')
             ->addArgument(
                 'name',
                 InputArgument::REQUIRED,

src/PrestashopConsole/Command/Module/Generate/ModuleHeader.php

@@ -22,9 +22,28 @@
 class ModuleHeader
 {
     /**
+     * Get file header for generated modules
+     * If .prestashopConsole/licence.txt exists, use it, otherwise use default header
+     *
      * @return string
      */
     public static function getHeader()
+    {
+        $customLicencePath = _PS_ROOT_DIR_ . '/.prestashopConsole/licence.txt';
+
+        if (file_exists($customLicencePath)) {
+            return file_get_contents($customLicencePath);
+        }
+
+        return self::getDefaultHeader();
+    }
+
+    /**
+     * Get default header template
+     *
+     * @return string
+     */
+    private static function getDefaultHeader()
     {
         return
 '/**

src/PrestashopConsole/Command/Module/Generate/ObjectModelCommand.php

@@ -43,6 +43,7 @@ protected function configure(): void
         $this
             ->setName('module:generate:model')
             ->setDescription('Generate module model object')
+            ->setHelp('Create .prestashopConsole/licence.txt at PrestaShop root to customize generated file headers')
             ->addArgument('moduleName', InputArgument::REQUIRED, 'module name')
             ->addArgument('objectClass', InputArgument::OPTIONAL, 'object class');
     }

src/PrestashopConsole/Command/Module/Generate/UpgradeCommand.php

@@ -43,6 +43,7 @@ protected function configure(): void
         $this
             ->setName('module:generate:upgrade')
             ->setDescription('Generate module upgrade file')
+            ->setHelp('Create .prestashopConsole/licence.txt at PrestaShop root to customize generated file headers')
             ->addArgument('moduleName', InputArgument::REQUIRED, 'module name')
             ->addArgument('moduleVersion', InputArgument::REQUIRED, 'module version');
     }