[Feature] Add Rule "changelog_has_new_release" (#63)

* parsing release

* no generate docs for no described parameters

* optimize search type

* fix lint

* change rule

* virtual default value

* default value

* wrap def val

* lint when 2 lines modified

* up test

* check old tags

* add test for set

* add test for release parser

* add test

* improve set

* remove empty comments from src/

* fix stat analyse

* up version

* test

* print filename

Author: ArtARTs36

.mr-linter.yml

@@ -17,7 +17,7 @@ rules:
 
   "@mr-linter/description_not_empty": {}
 
-  "@mr-linter/update_changelog":
+  "@mr-linter/changelog_has_new_release":
     when:
       targetBranch:
         equals: "master"

CHANGELOG.md

@@ -6,6 +6,18 @@ This file contains changelogs.
 
 -----------------------------------------------------------------
 
+## [v0.19.0 (2023-09-11)](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.18.1..0.19.0)
+
+### Added
+* Added Rule `@mr-linter/changelog_has_new_release` on contains new release
+
+### Removed
+* Removed Rule `@mr-linter/update_changelog`
+
+[💾 Assets](https://github.com/ArtARTs36/php-merge-request-linter/releases/tag/0.19.0)
+
+-----------------------------------------------------------------
+
 ## [v0.18.1 (2023-09-04)](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.18.0..0.18.1)
 
 ### Added
@@ -15,8 +27,6 @@ This file contains changelogs.
 
 -----------------------------------------------------------------
 
------------------------------------------------------------------
-
 ## [v0.18.0 (2023-09-03)](https://github.com/ArtARTs36/php-merge-request-linter/compare/0.17.1..0.18.0)
 
 ### Added

Makefile

@@ -92,6 +92,7 @@ docs:
 
 docs-docker: docker-build
 	docker run \
+		--rm \
 		--volume ./:/app \
 		--env-file .env \
 		--entrypoint "make" \
@@ -132,6 +133,7 @@ lint-docker: docker-build
 
 lint-fix-docker: docker-build
 	docker run \
+		--rm \
 		--volume ./:/app/ \
 		--env-file .env \
 		--entrypoint "composer" \

composer.json

@@ -10,7 +10,7 @@
     ],
     "require": {
         "php": "^8.2",
-        "artarts36/str": "^2.4.1",
+        "artarts36/str": "^2.5.0",
         "symfony/console": "^4.0 | ^5.0 | ^6.0",
         "guzzlehttp/psr7": "^2",
         "artarts36/local-file-system": "^0.1.2",

composer.lock

@@ -12,6 +12,7 @@
      * @param array<string|int> $enum
      * @param array<RuleParamMetadata> $nestedObjectParams
      * @param array<RuleParamMetadata> $genericObjectParams
+     * @param array<mixed> $virtualDefaultValues
      */
     public function __construct(
         public string             $name,
@@ -25,6 +26,7 @@ public function __construct(
         public array $genericObjectParams,
         public mixed $defaultValue,
         public bool $hasDefaultValue,
+        public array $virtualDefaultValues,
     ) {
     }
 }

docs/Builder/ConfigJsonSchema/RuleParamMetadata.php

@@ -49,6 +49,10 @@ private function buildParams(string $class): array
         $metadataParams = [];
 
         foreach ($params as $param) {
+            if ($param->description === '')  {
+                continue;
+            }
+
             $enumValues = [];
 
             if ($param->type->class !== null && enum_exists($param->type->class)) {
@@ -82,6 +86,7 @@ private function buildParams(string $class): array
                 $genericObject,
                 $param->hasDefaultValue ? $param->getDefaultValue() : null,
                 $param->hasDefaultValue,
+                $param->getVirtualDefaultValues(),
             );
         }
 

docs/Builder/ConfigJsonSchema/RulesMetadataLoader.php

@@ -9,6 +9,7 @@
 use ArtARTs36\MergeRequestLinter\Infrastructure\Text\Renderer\TwigRenderer;
 use ArtARTs36\MergeRequestLinter\Shared\DataStructure\Arrayee;
 use ArtARTs36\MergeRequestLinter\Shared\DataStructure\Collection;
+use ArtARTs36\MergeRequestLinter\Shared\Reflection\Reflector\Reflector;
 
 class RulesPageBuilder
 {
@@ -79,15 +80,23 @@ private function buildParams(array $metadataParams, bool &$ruleHasParamsExamples
                 $name = $prefix . '.' . $param->name;
             }
 
+            $defaultValues = $this->resolveDefaultValues($param);
+
+            $isRequired = $param->required && count($defaultValues) === 0;
+
+            if ($isRequired && $param->type->isClass()) {
+                $isRequired = ! Reflector::canConstructWithoutParameters($param->type->class);
+            }
+
             $params[] = [
                 'name' => $name,
                 'type' => $param->jsonType,
-                'required' => $param->required,
+                'required' => $isRequired,
                 'generic' => $param->type->isGeneric() ? JsonType::to($param->type->generic) : null,
                 'description' => $param->description,
                 'examples' => $examples,
                 'isGenericObject' => $param->type->generic && class_exists($param->type->generic),
-                'defaultValue' => $this->resolveDefaultValue($param),
+                'defaultValues' => $defaultValues,
             ];
 
             if ($param->type->isGeneric()) {
@@ -107,8 +116,8 @@ private function buildParams(array $metadataParams, bool &$ruleHasParamsExamples
                         'generic' => $param->type->isGeneric() ? JsonType::to($param->type->generic) : null,
                         'description' => $param->description,
                         'examples' => $examples,
-                        'isGenericObject' => $param->type->generic && class_exists($param->type->generic),
-                        'defaultValue' => $this->resolveDefaultValue($param),
+                        'isGenericObject' => true,
+                        'defaultValues' => new Arrayee($this->resolveDefaultValues($param)),
                     ];
 
                     $params = array_merge($params, $this->buildParams(
@@ -129,24 +138,28 @@ private function buildParams(array $metadataParams, bool &$ruleHasParamsExamples
         return $params;
     }
 
-    private function resolveDefaultValue(RuleParamMetadata $param): mixed
+    private function resolveDefaultValues(RuleParamMetadata $param): array
     {
+        if (count($param->virtualDefaultValues) > 0) {
+            return $param->virtualDefaultValues;
+        }
+
         if (! $param->hasDefaultValue) {
-            return 'none';
+            return [];
         }
 
         if ($param->type->class !== null) {
             if (is_a($param->type->class, Collection::class, true)) {
-                return 'none';
+                return [];
             }
 
             if (enum_exists($param->type->class)) {
-                return $param->defaultValue->value;
+                return [$param->defaultValue->value];
             }
 
-            return $param->defaultValue;
+            return [$param->defaultValue];
         }
 
-        return $param->defaultValue;
+        return [$param->defaultValue];
     }
 }

docs/Builder/RulesPageBuilder.php

@@ -28,13 +28,13 @@ The following rules are available:
 | Name | Description | Type | Required | Default value | Examples |
 |------|-------------|------|----------|---------------|----------|
 {% for param in rule.params %}
-| {{ param.name }} | {{ param.description }} | {{ param.type }} {% if param.generic %} of {{ param.generic }}s {% endif %} | {{ param.required ? 'true' : 'false' }} | {{ param.defaultValue }} | {% for example in param.examples %} {{ example }}{% if loop.last == false %},{% endif%} {% endfor %} |
+| {{ param.name }} | {{ param.description }} | {{ param.type }} {% if param.generic %} of {{ param.generic }}s {% endif %} | {{ param.required ? 'true' : 'false' }} | {% if param.defaultValues.isEmpty %} none {% else %}{% for defValue in param.defaultValues %}{% if defValue is iterable %}`[{{ defValue | join(', ') }}]`{% else %}{% if defValue is null %}NULL{% else %}`{{ defValue }}`{% endif %}{% endif%} {% endfor %}{% endif %} | {% for example in param.examples %} {{ example }}{% if loop.last == false %},{% endif%} {% endfor %} |
 {% endfor %}
 {% else %}
 | Name | Description | Type | Required | Default value |
 |------|-------------|------|----------|---------------|
 {% for param in rule.params %}
-| {{ param.name }} | {{ param.description }} | {{ param.type }} {% if param.generic %} of {{ param.generic }}s {% endif %} | {{ param.required ? 'true' : 'false' }} | {{ param.defaultValue }} |
+| {{ param.name }} | {{ param.description }} | {{ param.type }} {% if param.generic %} of {{ param.generic }}s {% endif %} | {{ param.required ? 'true' : 'false' }} | {% if param.defaultValues.isEmpty %} none {% else %}{% for defValue in param.defaultValues %}{% if defValue is iterable %}`[{{ defValue | join(', ') }}]`{% else %}{% if defValue is null %}NULL{% else %}`{{ defValue }}`{% endif %}{% endif%} {% endfor %}{% endif %} |
 {% endfor %}
 {% endif %}
 {% endif %}