deprecates integration with PHP Copy/Paste Detector (PHPCPD) library.

moodlehq · Feb 4, 2024 · 9cd446f · 9cd446f
1 parent 0aef673
commit 9cd446f
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 6 deletions.
diff --git a/docs/CLI.md b/docs/CLI.md
@@ -19,7 +19,7 @@ title: Moodle Plugin CI Commands
 * [`mustache`](#mustache)
 * [`parallel`](#parallel)
 * [`phpcbf`](#phpcbf)
-* [`phpcpd`](#phpcpd)
+* [`phpcpd` (DEPRECATED)](#phpcpd)
 * [`phpcs`](#phpcs)
 * [`phpdoc`](#phpdoc)
 * [`phplint`](#phplint)
@@ -1485,7 +1485,15 @@ Do not ask any interactive question
 `phpcpd`
 --------
 
-Run PHP Copy/Paste Detector on a plugin
+Run PHP Copy/Paste Detector on a plugin.
+
+### Deprecation Notice
+
+[PHP Copy/Paste Detector](https://github.com/sebastianbergmann/phpcpd) has been abandoned by its maintainers.
+
+The integration with it will be removed without replacement from future versions of this plugin.
+
+_Usage of the `phpcpd` command is discouraged._
 
 ### Usage
 

diff --git a/docs/GHAFileExplained.md b/docs/GHAFileExplained.md
@@ -142,7 +142,7 @@ jobs:
         if: ${{ !cancelled() }} # prevents CI run stopping if step failed.
         run: moodle-plugin-ci phplint
 
-      - name: PHP Copy/Paste Detector
+      - name: PHP Copy/Paste Detector # DEPRECATED
         continue-on-error: true # This step will show errors but will not fail
         if: ${{ !cancelled() }}
         run: moodle-plugin-ci phpcpd

diff --git a/docs/Help.md b/docs/Help.md
@@ -27,7 +27,7 @@ inclide in the CI scenario. For detailed information, see [CLI commands and opti
 
 This step lints your PHP files to check for syntax errors.
 
-**moodle-plugin-ci phpcpd**
+**moodle-plugin-ci phpcpd (DEPRECATED)**
 
 This step runs the PHP Copy/Paste Detector on your plugin. This helps to find
 code duplication.

diff --git a/docs/TravisFileExplained.md b/docs/TravisFileExplained.md
@@ -131,6 +131,7 @@ script:
   - moodle-plugin-ci phplint
 # This step runs the PHP Copy/Paste Detector on your plugin.
 # This helps to find code duplication.
+# (DEPRECATED)
   - moodle-plugin-ci phpcpd
 # This step runs the PHP Mess Detector on your plugin. This helps to find
 # potential problems with your code which can result in

diff --git a/docs/index.md b/docs/index.md
@@ -28,7 +28,7 @@ This project supports the following testing frameworks and code analysis tools:
 * [Mustache Linting](https://docs.moodle.org/dev/Templates)
 * [Grunt tasks](https://docs.moodle.org/dev/Grunt)
 * [PHP Linting](https://github.com/JakubOnderka/PHP-Parallel-Lint)
-* [PHP Copy/Paste Detector](https://github.com/sebastianbergmann/phpcpd)
+* [PHP Copy/Paste Detector (DEPRECATED)](https://github.com/sebastianbergmann/phpcpd)
 * [PHP Mess Detector](http://phpmd.org)
 
 ## Requirements

diff --git a/src/Command/CopyPasteDetectorCommand.php b/src/Command/CopyPasteDetectorCommand.php
@@ -23,6 +23,8 @@
 
 /**
  * Run PHP Copy/Paste Detector on a plugin.
+ *
+ * @deprecated
  */
 class CopyPasteDetectorCommand extends AbstractPluginCommand
 {
@@ -31,7 +33,7 @@ protected function configure(): void
         parent::configure();
 
         $this->setName('phpcpd')
-            ->setDescription('Run PHP Copy/Paste Detector on a plugin');
+            ->setDescription('Run PHP Copy/Paste Detector on a plugin (DEPRECATED)');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int