From eb696eda596b3eeaa2b1e3d2853c53a7ff9921b8 Mon Sep 17 00:00:00 2001 From: Dan Wallis Date: Mon, 11 Jul 2022 22:36:29 +0100 Subject: [PATCH] Allow auto-fixing inheritDoc tag when alone --- .../Annotation/AnnotationFormatValidator.php | 7 +- ...ethodAnnotationStructureUnitTest.inc.fixed | 372 ++++++++++++++++++ 2 files changed, 378 insertions(+), 1 deletion(-) create mode 100644 Magento2/Tests/Annotation/MethodAnnotationStructureUnitTest.inc.fixed diff --git a/Magento2/Sniffs/Annotation/AnnotationFormatValidator.php b/Magento2/Sniffs/Annotation/AnnotationFormatValidator.php index b69d2ad6..bc97eb66 100644 --- a/Magento2/Sniffs/Annotation/AnnotationFormatValidator.php +++ b/Magento2/Sniffs/Annotation/AnnotationFormatValidator.php @@ -125,10 +125,15 @@ private function validateShortDescriptionFormat( $error = 'No blank lines are allowed before short description'; $phpcsFile->addError($error, $shortPtr, 'MethodAnnotation'); } + if (strtolower($tokens[$shortPtr]['content']) === '{@inheritdoc}') { $error = 'If the @inheritdoc not inline it shouldn’t have braces'; - $phpcsFile->addError($error, $shortPtr, 'MethodAnnotation'); + $fix = $phpcsFile->addFixableError($error, $shortPtr, 'MethodAnnotation'); + if ($fix === true) { + $phpcsFile->fixer->replaceToken($shortPtr, '@inheritDoc'); + } } + $shortPtrContent = $tokens[$shortPtr]['content']; if (preg_match('/^\p{Ll}/u', $shortPtrContent) === 1) { $error = 'Short description must start with a capital letter'; diff --git a/Magento2/Tests/Annotation/MethodAnnotationStructureUnitTest.inc.fixed b/Magento2/Tests/Annotation/MethodAnnotationStructureUnitTest.inc.fixed new file mode 100644 index 00000000..3a07fb55 --- /dev/null +++ b/Magento2/Tests/Annotation/MethodAnnotationStructureUnitTest.inc.fixed @@ -0,0 +1,372 @@ +productVisibility = $productVisibility; + } + + /** + * block description + * + * {@inheritdoc} + * + * @param \Magento\Catalog\Model\ResourceModel\Product\Collection $collection + * @return void + */ + public function construct(AbstractDb $collection) + { + /** @var */ + $collection->setVisibility($this->productVisibility->getVisibleInCatalogIds()); + } + + /** + * Move category + * + * + * @param int $parentId new parent category id + * + * @return $this + * @throws \Magento\Framework\Exception\LocalizedException|\Exception + */ + public function move($parentId) + { + /** + * Validate new parent category id. (category model is used for backward + * compatibility in event params) + */ + try { + $this->categoryRepository->get($parentId, $this->getStoreId()); + } + catch (NoSuchEntityException $e) { + throw new \Magento\Framework\Exception\LocalizedException( + __('Sorry, but we can\'t find the new parent category you selected.'), + $e + ); + } + return true; + } + + /** + * Block for short description + * + * This a long description {@inheritdoc} consists more lines as part of the long description + * on multi line. + * + * @param int $store + * + * + */ + public function getProductListDefaultSortBy26032($store) + { + return $store; + } + + /** + * + * + * + */ + public function getProductListDefaultSortBy2632() + { + } + + /** + * Block for short description + * + * This a long description {@inheritdoc} consists more lines as part of the long description + * on multi line. + * + * @param int $store + * + * + * + */ + public function getProductListDefaultSortBy2002($store) + { + return $store; + } + + /** + * + * block for short description + * + * @param int $store + * @return int + */ + public function getProductListDefaultSortBy3002($store) + { + return $store; + } + + /** + * Block for short description + * + * @see consists more lines as part of the long description + * on multi line. + * + * @param string $store + * @param string $foo + */ + public function getProductListDefaultSortBy12($store, $foo) + { + return $store === $foo; + } + + /** + * Block for short description + * + * {@inheritdoc} + * + * @param string $store + * @param string $foo + */ + public function getProductListDefaultSort2($store, $foo) + { + return $store === $foo; + } + + /** + * Block for short description + * + * a long description {@inheritdoc} consists more lines as part of the long description + * on multi line. + * + * @param string $store + * @param string $foo + */ + public function getProductListDefault($store, $foo) + { + return $store === $foo; + } + + /** + * Retrieve custom options + * + * @param ProductOptionInterface $productOption + * + * @return array + */ + protected function getCustomOptions(ProductOptionInterface $productOption) + { + if ($productOption + && $productOption->getExtensionAttributes() + && $productOption->getExtensionAttributes()->getCustomOptions() + ) { + return $productOption->getExtensionAttributes()->getCustomOptions(); + } + return []; + } + + /** + * This is the summary for a DocBlock. + * + * This is the description for a DocBlock. This text may contain + * multiple lines and even some _markdown_. + * * Markdown style lists function too + * * Just try this out once + * The section after the description contains the tags; which provide + * structured meta-data concerning the given element. + * + * @param int $example This is an example function/method parameter description. + * @param string $example2 This is a second example. + * + */ + public function getProductListDefaultSortBy2($example, $example2) + { + return $example === $example2; + } + + /** + * Returns the content of the tokens from the specified start position in + * the token stack for the specified length. + * + * @param int $start + * @param int $length + * + * @return string The token contents. + */ + public function getProductListDefaultSortBy($start, $length) + { + return $start === $length; + } + + /** + * Some text about this step/method returns the content of the tokens the token stack for the specified length + * + * @param string $name + * @param string $folder + * + * @see this file + * @When I create a file called :name in :folder + */ + public function getProductListDefaultSortBy222($name, $folder) + { + return $name === $folder; + } + + public function setExtensionAs(\Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes) + { + return $this->_setExtensionAttributes($extensionAttributes); + } + + /** + * + * short description + * @param \Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes + * @return mixed + */ + public function setEn(\Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes) + { + return $this->_setExtensionAttributes($extensionAttributes); + } + + /** + * @param \Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes + * @return mixed + */ + public function setExtenw(\Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes) + { + return $this->_setExtensionAttributes($extensionAttributes); + } + + /** + * + * Short description + * @param \Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes + * @return mixed + */ + public function setExff(\Magento\Catalog\Api\Data\CategoryExtensionInterface $extensionAttributes) + { + return $this->_setExtensionAttributes($extensionAttributes); + } + + /** + * @inheritDoc + * + * @param int $start + * @param int $length + * + * @return string The token contents. + */ + public function getProductSortBy($start, $length) + { + return $start === $length; + } + + /** + * This is a well-formed deprecated function + * + * @deprecated can be used in this context + * @see is ok here + */ + public function deprecated(): bool + { + return true; + } + + /** + * This deprecated function is incorrect since it only contains the @deprecated tag + * + * @deprecated + */ + public function incorrectlyDeprecated() + { + return false; + } + + /** + * This deprecated function is incorrect since it only contains the @deprecated tag + * + * @deprecated Should not be used + */ + public function incorrectAsWell() + { + return false; + } + + /** + * This deprecated function is incorrect since the @see tag does not have extra info + * + * @deprecated + * @see + */ + public function anotherOne() + { + return false; + } + + /** + * This deprecated function is incorrect since the @see tag does not have extra info + * + * @deprecated Should not be used + * @see + */ + public function yetAnotherOne() + { + return false; + } + + /** + * This function is correct since the @see tag can be used without the @deprecated tag + * + * @see Magento\Framework\NewHandler + */ + public function correctUseOfSee() + { + return true; + } +}