Avoids duplicated headers. Closes #54.

Author: raphaelstolt

src/Commands/ValidateCommand.php

@@ -36,6 +36,10 @@ final class ValidateCommand extends Command
 
     protected string $defaultPreset = 'Php';
 
+    protected string $generatedHeader = '# This file was generated by the lean package validator (http://git.io/lean-package-validator).';
+
+    protected string $modifiedHeader = '# This file was partly modified by the lean package validator (http://git.io/lean-package-validator).';
+
     /**
      * Package analyser.
      *
@@ -446,8 +450,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 if ($createGitattributesFile || $overwriteGitattributesFile) {
                     try {
                         if ($omitHeader === false) {
-                            $headerContent = '# This file was generated by the lean package validator (http://git.io/lean-package-validator).' . PHP_EOL;
-                            $expectedGitattributesFileContent = $headerContent . PHP_EOL . $expectedGitattributesFileContent;
+                            $expectedGitattributesFileContent = $this->generatedHeader . PHP_EOL . PHP_EOL . $expectedGitattributesFileContent;
                         }
 
                         $outputContent .= $this->createGitattributesFile(
@@ -541,10 +544,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                         }
                         $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
 
-
                         if ($omitHeader === false) {
-                            $headerContent = '# This file was partly modified by the lean package validator (http://git.io/lean-package-validator).' . PHP_EOL;
-                            $expectedGitattributesFileContent = $headerContent . PHP_EOL . $expectedGitattributesFileContent;
+                            if (\str_contains($expectedGitattributesFileContent, $this->generatedHeader)) {
+                                $expectedGitattributesFileContent = \str_replace(
+                                    $this->generatedHeader . PHP_EOL . PHP_EOL,
+                                    '',
+                                    $expectedGitattributesFileContent
+                                );
+                            }
+                            $expectedGitattributesFileContent = $this->modifiedHeader . PHP_EOL . PHP_EOL . $expectedGitattributesFileContent;
                         }
 
                         $outputContent .= $this->overwriteGitattributesFile(

tests/Commands/ValidateCommandTest.php

@@ -1523,6 +1523,67 @@ public function staleExportIgnoresAreConsideredAsInvalid(): void
         $this->assertTrue($commandTester->getStatusCode() > Command::SUCCESS);
     }
 
+    #[Test]
+    #[Ticket('https://github.com/raphaelstolt/lean-package-validator/issues/54')]
+    public function createdHeaderIsReplacedByModifiedHeader(): void
+    {
+        $gitattributesContent = <<<CONTENT
+# This file was generated by the lean package validator (http://git.io/lean-package-validator).
+
+# These files are always considered text and should use LF.
+# See core.whitespace @ http://git-scm.com/docs/git-config for whitespace flags.
+
+*.php text eol=lf
+
+# Ignore all non production artifacts with an "export-ignore".
+.gitattributes export-ignore
+.github/ export-ignore
+.gitignore export-ignore
+phpunit.xml.dist export-ignore
+
+CONTENT;
+
+        $this->createTemporaryGitattributesFile($gitattributesContent);
+
+        $artifactFilenames = ['.gitignore', '.gitattributes', 'phpunit.xml.dist'];
+
+        $this->createTemporaryFiles(
+            $artifactFilenames,
+            ['.github', 'tests']
+        );
+
+        $command = $this->application->find('validate');
+        $commandTester = new CommandTester($command);
+        $commandTester->execute([
+            'command' => $command->getName(),
+            'directory' => WORKING_DIRECTORY,
+            '--overwrite' => true
+        ]);
+
+
+        $expectedGitattributesContent = <<<CONTENT
+# This file was partly modified by the lean package validator (http://git.io/lean-package-validator).
+
+# These files are always considered text and should use LF.
+# See core.whitespace @ http://git-scm.com/docs/git-config for whitespace flags.
+
+*.php text eol=lf
+
+# Ignore all non production artifacts with an "export-ignore".
+.gitattributes export-ignore
+.github/ export-ignore
+.gitignore export-ignore
+phpunit.xml.dist export-ignore
+tests/ export-ignore
+
+CONTENT;
+
+        $this->assertStringEqualsFile(
+            WORKING_DIRECTORY . DIRECTORY_SEPARATOR . '.gitattributes',
+            $expectedGitattributesContent
+        );
+    }
+
     #[Test]
     #[Ticket('https://github.com/raphaelstolt/lean-package-validator/issues/8')]
     #[DataProvider('optionProvider')]