From 723cdb6be52dd12be34b5896de18d366edeae7e4 Mon Sep 17 00:00:00 2001 From: Laura Date: Fri, 28 Mar 2025 19:11:02 -0300 Subject: [PATCH 1/2] Update with deprecation notice.md --- README.md | 54 +++++++++++++++++++++--------------------------------- 1 file changed, 21 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index f7907bd..163fdd3 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,31 @@ -# Code Climate FIXME Engine +# Try Qlty today, the newest edition of Code Climate Quality. +#### This repository is deprecated and archived. -`codeclimate-fixme` is a Code Climate engine that performs a case-sensitive search for the following strings in your project: +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. -* `TODO` -* `FIXME` -* `HACK` -* `BUG` -* `XXX` +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. -These strings are things you should fix now, not later. +As a result, this repository is no longer maintained and has been archived. -`codeclimate-fixme` is also very simple, and is intended to provide a `Hello World` like template for Code Climate Platform engine authors. It is implemented in JavaScript as an NPM package. +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: -### Installation & Usage +- 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 -1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). -2. Run `codeclimate engines:enable fixme`. 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`. +## Try out Qlty today free -### Configuration +[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. -You can specify what strings to match by adding a `strings` key in your -`.codeclimate.yml`: + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` -```yaml -engines: - fixme: - enabled: true - config: - strings: - - FIXME - - CUSTOM -``` +[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) -**NOTE**: values specified here *override* the defaults, they are not -*additional* strings to match. - -### Need help? - -For help with `codeclimate-fixme`, please open an issue on this repository. - -If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-fixme/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. From af1db15314c9a8d4aa8f4143c3fd6e5405a73491 Mon Sep 17 00:00:00 2001 From: Laura Date: Tue, 15 Apr 2025 17:30:23 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 163fdd3..a30c216 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ The new Qlty plugins system provides key advantages over the older, Docker-based ` curl https://qlty.sh | sh # Mac or Linux ` -or ` ` +or ` powershell -c "iwr https://qlty.sh | iex" # Windows` [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)