From 57be949efc5189bcb659d5cbf1e855f23edb697d Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Mon, 24 Mar 2025 15:11:04 -0500 Subject: [PATCH] Update README.md add deprecation update + Qlty instructions --- README.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 9f806a88..8a0dd82a 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,29 @@ -# Code Climate Rubocop Engine +# This repository is deprecated and archived +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. -[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-rubocop/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-rubocop) +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. -`codeclimate-rubocop` is a Code Climate engine that wraps the [RuboCop](https://github.com/rubocop-hq/rubocop) static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform. +As a result, this repository is no longer maintained and has been archived. -RuboCop helps you enforce many of the guidelines outlined in the community [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide). Most aspects of its behavior can be tweaked via various [configuration options](https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml), which are set in a **.rubocop.yml** file. +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: -You can find some basic setup instructions and links to the RuboCop OSS project below. For additional Code Climate-specific config details, check out our [RuboCop engine documentation][cc-docs-rubocop]. +- 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 -### Installation +## Try out Qlty today free -1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). -2. Enable the engine by adding the following under `plugins` in your `.codeclimate.yaml`: - ```yaml - plugins: - rubocop: - enabled: true - ``` -3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. +[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. -### Need help? + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` + +[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) -For help with RuboCop, [check out their documentation](https://github.com/rubocop-hq/rubocop). - -If you're running into a Code Climate issue, first check out [our RuboCop engine docs][cc-docs-rubocop] and look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help). - -[cc-docs-rubocop]: https://docs.codeclimate.com/docs/rubocop +**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy