opensourcemirror
/
swagger-php
mirror of https://github.com/zircote/swagger-php.git
1
0
Fork 0
Code Issues Releases Wiki Activity

CS: enable `no_superfluous_phpdoc_tags` rule and updated deprecated ones (#1558)

This commit is contained in:
Martin Rademacher 2024-03-15 15:35:23 +13:00 committed by GitHub
parent fe45a0e98a
commit d3265da27c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
21 changed files with 19 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
.php-cs-fixer.dist.php
View File

@ -1,23 +1,22 @@
<?php declare(strict_types=1);
use OpenApi\Tools\CSFixer\ScopedLicenseFixer;
use OpenApi\Tools\CSFixer\ScopedDeclareStrictTypesFixer;
use OpenApi\Tools\CSFixer\ScopedLicenseFixer;
$finder = PhpCsFixer\Finder::create()
->path('src')->name('*.php')
->path('tests')->name('*.php')
// ContextTest::testFullyQualifiedName relies on the 'use Exception' statement...
->filter(function (\SplFileInfo $file) {
return !strpos($file->getPathname(), 'tests/Fixtures/Customer.php');
})
// ContextTest::testFullyQualifiedName relies on the 'use Exception' statement...
->filter(function (\SplFileInfo $file) {
return !strpos($file->getPathname(), 'tests/Fixtures/Customer.php');
})
->path('Examples')->name('*.php')
->filter(function (\SplFileInfo $file) {
return !strpos($file->getPathname(), 'Examples/petstore-3.0/Petstore.php')
&& !strpos($file->getPathname(), 'Examples/misc/OpenApiSpec.php');
})
->filter(function (\SplFileInfo $file) {
return !strpos($file->getPathname(), 'Examples/petstore-3.0/Petstore.php')
&& !strpos($file->getPathname(), 'Examples/misc/OpenApiSpec.php');
})
->path('tools')->name('*.php')
->in(__DIR__)
;
->in(__DIR__);
return (new PhpCsFixer\Config())
->registerCustomFixers([
@ -35,11 +34,11 @@ return (new PhpCsFixer\Config())
'visibility_required' => true,
'cast_spaces' => ['space' => 'single'],
'concat_space' => ['spacing' => 'one'],
'function_typehint_space' => true,
'type_declaration_spaces' => true,
'lowercase_cast' => true,
'magic_constant_casing' => true,
'class_attributes_separation' => ['elements' => ['method' => 'one']],
'single_blank_line_before_namespace' => true,
'blank_lines_before_namespace' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_around_offset' => true,
'no_whitespace_before_comma_in_array' => true,
@ -49,16 +48,15 @@ return (new PhpCsFixer\Config())
'no_blank_lines_after_phpdoc' => true,
'no_extra_blank_lines' => true,
'return_type_declaration' => ['space_before' => 'none'],
'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => true,
'no_trailing_comma_in_singleline' => true,
'no_unneeded_control_parentheses' => true,
'no_unneeded_curly_braces' => true,
'no_unneeded_braces' => true,
'short_scalar_cast' => true,
'space_after_semicolon' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline' => true,
'trim_array_spaces' => true,
'single_space_after_construct' => true,
'single_space_around_construct' => true,
'single_line_comment_spacing' => true,
'fully_qualified_strict_types' => true,
'global_namespace_import' => ['import_classes' => false, 'import_constants' => null, 'import_functions' => null],
@ -66,7 +64,7 @@ return (new PhpCsFixer\Config())
'nullable_type_declaration_for_default_null_value' => true,
'no_empty_phpdoc' => true,
// 7.3 only 'no_superfluous_phpdoc_tags' => true,
'no_superfluous_phpdoc_tags' => true,
'phpdoc_align' => true,
'general_phpdoc_tag_rename' => true,
'phpdoc_inline_tag_normalizer' => true,
@ -85,5 +83,4 @@ return (new PhpCsFixer\Config())
'phpdoc_no_empty_return' => true,
'phpdoc_no_alias_tag' => true,
])
->setFinder($finder)
;
->setFinder($finder);

3
src/Analysers/DocBlockParser.php
View File

@ -53,8 +53,7 @@ class DocBlockParser
/**
* Use doctrine to parse the comment block and return the detected annotations.
*
* @param string $comment a T_DOC_COMMENT
* @param Context $context
* @param string $comment a T_DOC_COMMENT
*
* @return array<OA\AbstractAnnotation>
*/

9
src/Annotations/AbstractAnnotation.php
View File

@ -156,9 +156,6 @@ abstract class AbstractAnnotation implements \JsonSerializable
$this->_context->logger->warning('Property "' . $property . '" doesn\'t exist in a ' . $this->identity() . ', existing properties: "' . implode('", "', array_keys($properties)) . '" in ' . $this->_context);
}
/**
* @param mixed $value
*/
public function __set(string $property, $value): void
{
$fields = get_object_vars($this);
@ -287,9 +284,6 @@ abstract class AbstractAnnotation implements \JsonSerializable
return $properties;
}
/**
* @return mixed
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
@ -741,8 +735,6 @@ abstract class AbstractAnnotation implements \JsonSerializable
/**
* Validate array type.
*
* @param mixed $value
*/
private function validateArrayType($value): bool
{
@ -764,7 +756,6 @@ abstract class AbstractAnnotation implements \JsonSerializable
/**
* Wrap the context with a reference to the annotation it is nested in.
*
* @param AbstractAnnotation $annotation
*
* @return AbstractAnnotation
*/

2
src/Annotations/Link.php
View File

@ -75,8 +75,6 @@ class Link extends AbstractAnnotation
/**
* A literal value or {expression} to use as a request body when calling the target operation.
*
* @var mixed
*/
public $requestBody = Generator::UNDEFINED;

2
src/Annotations/MediaType.php
View File

@ -39,8 +39,6 @@ class MediaType extends AbstractAnnotation
*
* Furthermore, if referencing a schema which contains an example,
* the example value shall override the example provided by the schema.
*
* @var mixed
*/
public $example = Generator::UNDEFINED;

2
src/Annotations/Parameter.php
View File

@ -143,8 +143,6 @@ class Parameter extends AbstractAnnotation
* The example object is mutually exclusive of the examples object.
* Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.
* To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
*
* @var mixed
*/
public $example = Generator::UNDEFINED;

6
src/Annotations/Schema.php
View File

@ -133,8 +133,6 @@ class Schema extends AbstractAnnotation
* Sets a default value to the parameter. The type of the value depends on the defined type.
*
* @see [JSON schema validation](http://json-schema.org/latest/json-schema-validation.html#anchor101)
*
* @var mixed
*/
public $default = Generator::UNDEFINED;
@ -318,8 +316,6 @@ class Schema extends AbstractAnnotation
*
* To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to
* contain the example with escaping where necessary.
*
* @var mixed
*/
public $example = Generator::UNDEFINED;
@ -407,8 +403,6 @@ class Schema extends AbstractAnnotation
/**
* http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.
*
* @var mixed
*/
public $const = Generator::UNDEFINED;

1
src/Attributes/OperationTrait.php
View File

@ -11,7 +11,6 @@ use OpenApi\Generator;
trait OperationTrait
{
/**
* @param array $security
* @param Server[] $servers
* @param string[] $tags
* @param Parameter[] $parameters

1
src/Attributes/Schema.php
View File

@ -22,7 +22,6 @@ class Schema extends \OpenApi\Annotations\Schema
* @param array<Schema|\OpenApi\Annotations\Schema> $allOf
* @param array<Schema|\OpenApi\Annotations\Schema> $anyOf
* @param array<Schema|\OpenApi\Annotations\Schema> $oneOf
* @param mixed $const
* @param array<string,mixed>|null $x
* @param Attachable[]|null $attachables
*/

3
src/Generator.php
View File

@ -124,9 +124,6 @@ class Generator
};
}
/**
* @param mixed $value
*/
public static function isDefault($value): bool
{
return $value === Generator::UNDEFINED;

2
src/Processors/AugmentParameters.php
View File

@ -29,8 +29,6 @@ class AugmentParameters implements ProcessorInterface
/**
* If set to <code>true</code> try to find operation parameter descriptions in the operation docblock.
*
* @param bool $augmentOperationParameters
*/
public function setAugmentOperationParameters(bool $augmentOperationParameters): void
{

2
src/Processors/OperationId.php
View File

@ -29,8 +29,6 @@ class OperationId implements ProcessorInterface
/**
* If set to <code>true</code> generate ids (md5) instead of clear text operation ids.
*
* @param bool $hash
*/
public function setHash(bool $hash): OperationId
{

4
src/Serializer.php
View File

@ -128,10 +128,6 @@ class Serializer
/**
* Deserialize the annotation's property.
*
* @param mixed $value
*
* @return mixed
*/
protected function doDeserializeProperty(OA\AbstractAnnotation $annotation, string $property, $value, Context $context)
{

2
tests/Annotations/AttributesSyncTest.php
View File

@ -116,7 +116,7 @@ class AttributesSyncTest extends OpenApiTestCase
protected function propertyType(\ReflectionProperty $property): ?string
{
$var = null;
$var = 'mixed';
foreach ($this->prepDocComment($property->getDocComment()) as $line) {
if (substr($line, 0, 5) === '@var ') {
$var = trim(substr($line, 5));

2
tests/Fixtures/Annotations/CustomAttachable.php
View File

@ -16,8 +16,6 @@ class CustomAttachable extends OA\Attachable
{
/**
* The attribute value.
*
* @var mixed
*/
public $value = Generator::UNDEFINED;

2
tests/Fixtures/Attributes/CustomAttachable.php
View File

@ -14,8 +14,6 @@ class CustomAttachable extends OAT\Attachable
{
/**
* The attribute value.
*
* @var mixed
*/
public $value = Generator::UNDEFINED;

4
tests/Fixtures/Scratch/ComplexCustomAttributes.php
View File

@ -23,10 +23,6 @@ class Schema extends OAT\Schema
{
/**
* @param class-string $of
* @param string|null $description
* @param array $optional
* @param int|null $minLength
* @param int|null $maxLength
*
* @throws \ReflectionException
*/

2
tests/Fixtures/Scratch/MergeTraits.php
View File

@ -15,8 +15,6 @@ trait HasId
* format="int64",
* readOnly=true,
* )
*
* @var int
*/
public int $id;
}

2
tests/Fixtures/Scratch/PromotedProperty.php
View File

@ -14,8 +14,6 @@ class PromotedPropertyDescription
{
/**
* Property name.
*
* @var string
*/
#[OAT\Property(property: 'thename')]
public string $name = '';

2
tests/Fixtures/TypedProperties.php
View File

@ -72,8 +72,6 @@ class TypedProperties
public string $annotationTrumpsNative;
/**
* @var string
*
* @OA\Property(
* type="integer",
* )

5
tests/OpenApiTestCase.php
View File

@ -118,7 +118,6 @@ class OpenApiTestCase extends TestCase
*
* @param array|OA\OpenApi|\stdClass|string $actual The generated output
* @param array|OA\OpenApi|\stdClass|string $expected The specification
* @param string $message
* @param bool $normalized flag indicating whether the inputs are already normalized or
* not
*/
@ -255,8 +254,6 @@ class OpenApiTestCase extends TestCase
/**
* Collect list of all non-abstract annotation classes.
*
* @return array
*/
public function allAnnotationClasses(): array
{
@ -278,8 +275,6 @@ class OpenApiTestCase extends TestCase
/**
* Collect list of all non-abstract attribute classes.
*
* @return array
*/
public function allAttributeClasses(): array
{