Merge pull request #39 from mikeartix/master

PHP files: avoid adding unnecessary newline

src/Command/UpdateLicensesCommand.php

@@ -337,12 +337,19 @@ private function addLicenseToNode(Stmt $node, SplFileInfo $file): void
     {
         if (!$node->hasAttribute('comments')) {
             $needle = '<?php';
-            $replace = "<?php\n" . $this->text . "\n";
+            $replace = "<?php\n" . $this->text;
             $haystack = $file->getContents();
 
             $pos = strpos($haystack, $needle);
             // Important, if the <?php is in the middle of the file, continue
             if ($pos === 0) {
+                // Check if an empty newline is present right after the <?php tag
+                // Append newline to replacement if missing
+                $checkNewline = substr($haystack, strlen($needle), 2) === "\n\n";
+                if (!$checkNewline) {
+                    $replace .= "\n";
+                }
+
                 $newstring = substr_replace($haystack, $replace, $pos, strlen($needle));
 
                 if (!$this->runAsDry) {

tests/integration/expected/smart-headers/emptynewlineheader.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+
+class EmptyNewlineHeader extends Module
+{
+    // This PHP file has no header comment but does have an empty newline right after the <?php tag
+    // Most editors/IDEs add this newline automatically
+    // It should add the license header without adding an unnecessary extra empty newline 
+    // This also keeps validator.prestashop.com happy :)
+}

tests/integration/module-samples/smart-headers/emptynewlineheader.php

@@ -0,0 +1,9 @@
+<?php
+
+class EmptyNewlineHeader extends Module
+{
+    // This PHP file has no header comment but does have an empty newline right after the <?php tag
+    // Most editors/IDEs add this newline automatically
+    // It should add the license header without adding an unnecessary extra empty newline 
+    // This also keeps validator.prestashop.com happy :)
+}

tests/integration/runner/run.php

@@ -15,6 +15,7 @@
     'dashproducts',
     'fakemodule',
     'existing-headers-discrimination',
+    'smart-headers',
 ];
 $workspaceID = 100;
 $filesystem = new Filesystem();