ValidatorInterface::validateString() and implementations are docume…

…nted as `non-empty-string`

Merge pull request #63 from CycloneDX/dependabot/composer/tools/psalm/vimeo/psalm-4.19.0

HISTORY.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+* Fixed
+  * `CycloneDX\Core\Validation\ValidatorInterface::validateString()` and implementations
+    are documented as `non-empty-string`, were undocumented `string` before. (via [#63])
+
+[#63]: https://github.com/CycloneDX/cyclonedx-php-library/pull/63
+
 ## 1.4.0 - 2021-12-20
 
 * Added

src/Core/Validation/ValidatorInterface.php

@@ -34,5 +34,8 @@ public function __construct(SpecInterface $spec);
 
     public function getSpec(): SpecInterface;
 
+    /**
+     * @psalm-param non-empty-string $string
+     */
     public function validateString(string $string): ?ValidationError;
 }

src/Core/Validation/Validators/JsonValidator.php

@@ -54,6 +54,8 @@ protected static function listSchemaFiles(): array
     }
 
     /**
+     * @psalm-param non-empty-string $string
+     *
      * @throws FailedLoadingSchemaException if schema file unknown or not readable
      * @throws JsonException                if loading the JSON failed
      *

src/Core/Validation/Validators/XmlValidator.php

@@ -52,6 +52,8 @@ protected static function listSchemaFiles(): array
     }
 
     /**
+     * @psalm-param non-empty-string $string
+     *
      * @throws FailedLoadingSchemaException if schema file unknown or not readable
      * @throws DOMException                 if loading the DOM failed
      *
@@ -97,6 +99,8 @@ private function validateDomWithSchema(DOMDocument $doc): ?\LibXMLError
     }
 
     /**
+     * @psalm-param non-empty-string $xml
+     *
      * @throws DOMException if loading the DOM failed
      */
     private function loadDomFromXml(string $xml): DOMDocument

tools/psalm/composer.json

@@ -4,7 +4,7 @@
     "type": "metapackage",
     "require-dev": {
         "roave/security-advisories": "dev-latest",
-        "vimeo/psalm": "4.18.1"
+        "vimeo/psalm": "4.19.0"
     },
     "prefer-stable": true,
     "config": {