From 2016f9c508b0e9986af0e69b6536dbcf181ba7a7 Mon Sep 17 00:00:00 2001 From: Laura Date: Fri, 28 Mar 2025 19:15:15 -0300 Subject: [PATCH] Update with deprecation notice.md --- README.md | 50 +++++++++++++++++++++----------------------------- 1 file changed, 21 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index e489446..163fdd3 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,31 @@ -# Code Climate PHP Mess Detector (PHPMD) Engine +# Try Qlty today, the newest edition of Code Climate Quality. +#### This repository is deprecated and archived. -[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-phpmd/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-phpmd) +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. -`codeclimate-phpmd` is a Code Climate Engine that wraps the [PHP Mess Detector (PHPMD)](http://phpmd.org/) static analysis tool. +Code Climate Quality is being replaced with the new [Qlty](qlty.sh) code quality platform. Qlty uses a new plugin system which does not require packaging plugins as Docker images. +As a result, this repository is no longer maintained and has been archived. -### Installation +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: -1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). -2. Run `codeclimate engines:enable phpmd`. This command both installs the engine and enables it in your `.codeclimate.yml` file. -3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. +- Linting runs much faster without the overhead of virtualization +- New versions of linters are available immediately without needing to wait for a re-packaged release +- Plugins can be run with any arbitrary extensions (like extra rules and configs) without requiring pre-packaging +- Eliminates security issues associated with exposing a Docker daemon -### Config Options +## Try out Qlty today free -Format the values for these config options per the [PHPMD documentation](http://phpmd.org/documentation/index.html). +[Qlty CLI](https://docs.qlty.sh/cli/quickstart) is the fastest linter and auto-formatter for polyglot teams. It is completely free and available for Mac, Windows, and Linux. -* file_extensions - This is where you can configure the file extensions for the files that you want PHPMD to analyze. -* rulesets - This is the list of rulesets that you want PHPMD to use while analyzing your files. + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` -### Sample Config +[Qlty Cloud](https://docs.qlty.sh/cloud/quickstart) is a full code health platform for integrating code quality into development team workflows. It is free for unlimited private contributors. + - [Try Qlty Cloud today](https://docs.qlty.sh/cloud/quickstart) - exclude_paths: - - "/examples/**/*" - engines: - phpmd: - enabled: true - config: - file_extensions: "php" - rulesets: "unusedcode,codesize,naming,optional_relative_path_to_custom_ruleset.xml" - ratings: - paths: - - "**.php" - -### Need help? - -For help with PHPMD, [check out their documentation](http://phpmd.org/documentation/index.html). - -If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/phpmd/phpmd/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help). +**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources.