Merge pull request #84 from marcocesarato/copilot/add-commit-author-feature

Add option to include commit author

Author: marcocesarato

docs/config.md

@@ -29,6 +29,7 @@ dir or use the `--config` option to specify the location of your configuration f
 - **Skip Verify:** Skip the pre-commit and commit-msg hooks
 - **Disable Links:** Render text instead of link in changelog
 - **Hidden Hash:** Hide commit hash from changelog
+- **Hidden Author:** Hide commit author from changelog (default: true)
 - **Hidden Mentions:** Hide users mentions from changelog
 - **Hidden References:** Hide issue references from changelog
 - **Pretty Scope:** Prettify the scope commit part (section name) on changelog *(ex. UserManager => User Manager or
@@ -90,6 +91,7 @@ return [
   'skipVerify' => false,
   'disableLinks' => false,
   'hiddenHash' => false,
+  'hiddenAuthor' => true,
   'hiddenMentions' => false,
   'hiddenReferences' => false,
   'prettyScope' => true,
@@ -127,6 +129,23 @@ return [
 ];
 ```
 
+#### Example with Author Information
+
+To show author information in your changelog:
+
+```php
+<?php
+
+return [
+    // Show author information in changelog entries (default: true = hidden)
+    'hiddenAuthor' => false,
+    // Optionally also show other metadata
+    'hiddenHash' => false,      // Show commit hash
+    'hiddenMentions' => false,  // Show @mentions
+    'hiddenReferences' => false, // Show issue references
+];
+```
+
 #### Full Example
 
 ```php

src/Changelog.php

@@ -569,9 +569,11 @@ protected function getMarkdownChanges(array $changes): string
                     $sha = '';
                     $references = '';
                     $mentions = '';
+                    $author = '';
                     $shaGroup = [];
                     $refsGroup = [];
                     $mentionsGroup = [];
+                    $authorGroup = [];
                     foreach ($itemsList as $item) {
                         $description = ucfirst($item->getDescription());
                         // Hashes
@@ -600,6 +602,11 @@ protected function getMarkdownChanges(array $changes): string
                                 $mentionsGroup[] = $text;
                             }
                         }
+                        // Author
+                        if (!$this->config->isHiddenAuthor() && !empty($item->getAuthorName())) {
+                            $authorName = $item->getAuthorName();
+                            $authorGroup[] = $authorName;
+                        }
                     }
 
                     if (!$this->config->isHiddenHash() && !empty($shaGroup)) {
@@ -611,7 +618,10 @@ protected function getMarkdownChanges(array $changes): string
                     if (!$this->config->isHiddenMentions() && !empty($mentionsGroup)) {
                         $mentions = '*[*' . implode(', ', $mentionsGroup) . '*]*';
                     }
-                    $changelog .= Formatter::clean("* {$description} {$references} {$sha} {$mentions}");
+                    if (!$this->config->isHiddenAuthor() && !empty($authorGroup)) {
+                        $author = '*by ' . implode(', ', array_unique($authorGroup)) . '*';
+                    }
+                    $changelog .= Formatter::clean("* {$description} {$references} {$sha} {$author} {$mentions}");
                     $changelog .= PHP_EOL;
                 }
             }

src/Configuration.php

@@ -166,6 +166,13 @@ class Configuration
      */
     protected $hiddenHash = false;
 
+    /**
+     * Hidden author.
+     *
+     * @var bool
+     */
+    protected $hiddenAuthor = true;
+
     /**
      * Tag suffix.
      *
@@ -315,6 +322,7 @@ public function fromArray(array $array)
             'skipVerify' => $this->skipVerify(),
             'disableLinks' => $this->isDisableLinks(),
             'hiddenHash' => $this->isHiddenHash(),
+            'hiddenAuthor' => $this->isHiddenAuthor(),
             'hiddenMentions' => $this->isHiddenMentions(),
             'hiddenReferences' => $this->isHiddenReferences(),
             'prettyScope' => $this->isPrettyScope(),
@@ -382,6 +390,7 @@ public function fromArray(array $array)
             ->setDisableLinks($params['disableLinks'])
             // Hidden
             ->setHiddenHash($params['hiddenHash'])
+            ->setHiddenAuthor($params['hiddenAuthor'])
             ->setHiddenMentions($params['hiddenMentions'])
             ->setHiddenReferences($params['hiddenReferences'])
             ->setHiddenVersionSeparator($params['hiddenVersionSeparator'])
@@ -767,6 +776,18 @@ public function setHiddenHash(bool $hiddenHash): self
         return $this;
     }
 
+    public function isHiddenAuthor(): bool
+    {
+        return $this->hiddenAuthor;
+    }
+
+    public function setHiddenAuthor(bool $hiddenAuthor): self
+    {
+        $this->hiddenAuthor = $hiddenAuthor;
+
+        return $this;
+    }
+
     public function isPrettyScope(): bool
     {
         return $this->prettyScope;

tests/ChangelogTest.php

@@ -112,6 +112,20 @@ public function testExecMock()
     }
 
     /** @test */
+    public function testHiddenAuthorConfigurationDefault()
+    {
+        $config = new Configuration();
+        // By default, author should be hidden (true)
+        $this->assertTrue($config->isHiddenAuthor());
+    }
+
+    /** @test */
+    public function testHiddenAuthorConfiguration()
+    {
+        $config = new Configuration(['hiddenAuthor' => false]);
+        // Author should not be hidden when set to false
+        $this->assertFalse($config->isHiddenAuthor());
+      
     public function testAzureDevOpsHttpsUrlPatternMatching()
     {
         // Test Azure DevOps HTTPS URL pattern directly