[Feature] Add Comments (#51)

* Add comments

Author: ArtARTs36

.mr-linter.yml

@@ -102,3 +102,12 @@ ci:
   github_actions:
     credentials:
       token: 'env(MR_LINTER_GITHUB_HTTP_TOKEN)'
+
+comments:
+  strategy: 'single'
+  messages:
+    - template: |
+        I found {{ result.notes.count }} notes in your Pull Request:
+        {% for note in result.notes %}
+        - {{ note.description | raw }}
+        {% endfor %}

CHANGELOG.md

@@ -6,6 +6,15 @@ This file contains changelogs.
 
 -----------------------------------------------------------------
 
+## [v0.16.0 (2023-08-06)](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.15.3..0.16.0)
+
+## Added
+* Added comments with lint result for merge requests
+
+[💾 Assets](https://github.com/ArtARTs36/php-merge-request-linter/releases/tag/0.16.0)
+
+-----------------------------------------------------------------
+
 ## [v0.15.3 (2023-07-29)](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.15.2..0.15.3)
 
 ## Added

Makefile

@@ -38,10 +38,10 @@ try-gitlab:
 
 # usage as `make try-bitbucket MR_ID=2`
 try-bitbucket:
-	BITBUCKET_PROJECT_KEY=aukrainsky \
-	BITBUCKET_PR_ID=6 \
-	BITBUCKET_WORKSPACE=aukrainsky \
-	BITBUCKET_REPO_SLUG=a1 \
+	BITBUCKET_PROJECT_KEY=ArtARTs36 \
+	BITBUCKET_PR_ID=${MR_ID} \
+	BITBUCKET_WORKSPACE=ArtARTs36 \
+	BITBUCKET_REPO_SLUG=test-repo \
  	./bin/mr-linter lint --debug --metrics
 
 docker-build:
@@ -149,7 +149,7 @@ test-e2e-docker: docker-build
 
 test-docker: docker-testing-build
 	docker run \
-		--volume ./:/app \
+		--volume ./:/app/ \
 		--env-file .env \
 		--entrypoint "composer" \
 		artarts36/merge-request-linter "test"

README.md

@@ -23,6 +23,7 @@ Supported CI Systems: **GitHub Actions**, **Gitlab CI**, **Bitbucket Pipelines**
 * [Docker Image](https://hub.docker.com/repository/docker/artarts36/merge-request-linter)
 * [Config JSON Schema](mr-linter-config-schema.json)
 * [Notifications](docs/notifications.md)
+* [Comments](docs/comments.md)
 * [Run in Docker](docs/run-in-docker.md)
 * [Development](docs/development.md)
 * [Changelog](CHANGELOG.md)

docs/Builder/ConditionsPageBuilder.php

@@ -21,9 +21,9 @@ public function build(): string
         return TwigRenderer::create()
             ->render(
                 file_get_contents(__DIR__ . '/templates/conditions.md.twig'),
-                new ArrayMap([
+                [
                     'operators' => $operators,
-                ]),
+                ],
             );
     }
 }

docs/Builder/ConfigJsonSchema/Generator.php

@@ -2,8 +2,10 @@
 
 namespace ArtARTs36\MergeRequestLinter\DocBuilder\ConfigJsonSchema;
 
+use ArtARTs36\MergeRequestLinter\Application\Comments\Message\MessageConditions;
 use ArtARTs36\MergeRequestLinter\DocBuilder\ConfigJsonSchema\Schema\JsonSchema;
 use ArtARTs36\MergeRequestLinter\DocBuilder\EventFinder;
+use ArtARTs36\MergeRequestLinter\Domain\Configuration\CommentsPostStrategy;
 use ArtARTs36\MergeRequestLinter\Domain\Notifications\ChannelType;
 use ArtARTs36\MergeRequestLinter\Domain\Request\MergeRequest;
 use ArtARTs36\MergeRequestLinter\Shared\Reflection\Reflector\Reflector;
@@ -29,6 +31,28 @@ public function generate(): JsonSchema
             'additionalProperties' => false,
         ]);
 
+        $schema->addProperty('comments', [
+            'type' => 'object',
+            'properties' => [
+                'strategy' => [
+                    'type' => 'string',
+                    'enum' => array_map(fn (\BackedEnum $enum) => $enum->value, CommentsPostStrategy::cases()),
+                ],
+                'messages' => [
+                    'type' => 'array',
+                    'items' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'template' => [
+                                'type' => 'string',
+                            ],
+                            'when' => $this->operatorSchemaArrayGenerator->generate(MessageConditions::class),
+                        ],
+                    ],
+                ],
+            ],
+        ], false);
+
         $schema->addProperty('ci', [
             'type' => 'object',
             'properties' => [

docs/Builder/RulesPageBuilder.php

@@ -58,9 +58,9 @@ public function build(): string
 
         return TwigRenderer::create()->render(
             file_get_contents(__DIR__ . '/templates/rules.md.twig'),
-            new ArrayMap([
+            [
                 'rules' => $rules,
-            ])
+            ],
         );
     }
 }

docs/Builder/build_config_json_schema.php

@@ -18,9 +18,9 @@
 
 file_put_contents(__DIR__ . '/../config-schema.md', TwigRenderer::create()->render(
     file_get_contents(__DIR__ . '/templates/config-schema.md.twig'),
-    new \ArtARTs36\MergeRequestLinter\Shared\DataStructure\ArrayMap([
+    [
         'schema' => $json,
-    ]),
+    ],
 ));
 
 $updated = $prevHash !== md5($json);

docs/comments.md

@@ -0,0 +1,50 @@
+# Comments
+
+You can receive comments on merge request page.
+
+#### Post strategies
+
+| Strategy      | Description                                |
+|---------------|--------------------------------------------|
+| single        | Each linter run will overwrite one comment |
+| single_append | Each linter run append one comment         |
+| new           | Each linter run creates a new comment      |
+
+#### Templating
+
+The template engine [Twig](https://twig.symfony.com) is used to render the message.
+
+Simple template:
+```html
+Review on PR "{{ request.title }}"
+```
+
+#### Example configuration:
+
+```yaml
+comments:
+  strategy: 'single'
+  messages:
+    - template: |
+        I found {{ result.notes.count }} notes in your Pull Request:
+        {% for note in result.notes %}
+        - {{ note.description | raw }}
+        {% endfor %}
+```
+
+#### Example configuration (only "master"):
+
+```yaml
+comments:
+  strategy: 'single'
+  messages:
+    - template: |
+        I found {{ result.notes.count }} notes in your Pull Request:
+        {% for note in result.notes %}
+        - {{ note.description | raw }}
+        {% endfor %}
+      when: 
+        request.targetBranch: 
+          equals: "master"
+```
+