|
1 | | -#Code Climate PMD Engine |
| 1 | +#Try Qlty today, the newest edition of Code Climate Quality. |
| 2 | +####This repository is deprecated and archived. |
2 | 3 |
|
3 | | -`codeclimate-pmd` is aCode Climate engine that wraps the[PMD](https://pmd.github.io) static analysis tool. You can run it on your command line using theCode ClimateCLI, or on our hosted analysis platform. |
| 4 | +This is arepository for aCode ClimateQuality plugin which is packaged as a Docker image. |
4 | 5 |
|
5 | | -###Installation |
| 6 | +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. |
6 | 7 |
|
7 | | -1. If you haven't already,[install the Code Climate CLI](https://github.com/codeclimate/codeclimate). |
8 | | -2. Run`codeclimate engines:enable pmd`. This command both installs the engine and enables it in your`.codeclimate.yml` file. |
9 | | -3. You're ready to analyze! Browse into your project's folder and run`codeclimate analyze`. |
10 | | -4. To add you custom PMD rules, open`.codeclimate.yml` and add a`config` entry pointing to your`ruleset.xml` file: |
11 | | -```yml |
12 | | -engines: |
13 | | -pmd: |
14 | | -enabled:true |
15 | | -config:ruleset.xml |
16 | | -``` |
| 8 | +As a result, this repository is no longer maintained and has been archived. |
17 | 9 |
|
18 | | -### Need help? |
| 10 | +##Advantages of Qlty plugins |
| 11 | +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: |
19 | 12 |
|
20 | | -For help with PMD, [check out their documentation](https://pmd.github.io/). |
| 13 | +- Linting runs much faster without the overhead of virtualization |
| 14 | +- New versions of linters are available immediately without needing to wait for a re-packaged release |
| 15 | +- Plugins can be run with any arbitrary extensions (like extra rules and configs) without requiring pre-packaging |
| 16 | +- Eliminates security issues associated with exposing a Docker daemon |
21 | 17 |
|
22 | | -If you're running into a Code Climate issue, first check out [our PMD engine docs][cc-docs-pmd] and look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), |
23 | | -as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help). |
| 18 | +##Try out Qlty today free |
24 | 19 |
|
25 | | -[cc-docs-pmd]: https://docs.codeclimate.com/docs/pmd |
| 20 | +[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. |
| 21 | + |
| 22 | +- Install Qlty CLI: |
| 23 | +` |
| 24 | +curlhttps://qlty.sh | sh # Mac or Linux |
| 25 | +` |
| 26 | +or` <windows install line>` |
| 27 | + |
| 28 | +[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. |
| 29 | +-[Try Qlty Cloud today](https://docs.qlty.sh/cloud/quickstart) |
| 30 | + |
| 31 | +**Note**: For existing customers of Quality, please see our[Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources. |