From 4bad6e19654195033f59dd3bc53d0dfacaf8df08 Mon Sep 17 00:00:00 2001 From: Laura Date: Fri, 28 Mar 2025 19:26:54 -0300 Subject: [PATCH 1/2] Update with deprecation notice.md --- README.md | 55 +++++++++++++++++++++---------------------------------- 1 file changed, 21 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 0d3e502..163fdd3 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,31 @@ -# Code Climate Golint Engine +# Try Qlty today, the newest edition of Code Climate Quality. +#### This repository is deprecated and archived. -`codeclimate-golint` is a Code Climate engine that wraps [Golint](https://github.com/golang/lint). You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform. +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. -Golint is a linter for Go code. Where as [Gofmt](https://www.github.com/codeclimate/codeclimate-gofmt) automatically reformats code, Golint suggests style issues that may need to be addressed. +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. -### Installation +As a result, this repository is no longer maintained and has been archived. -1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). -2. Add the following to yout Code Climate config: - ```yaml - plugins: - golint: - enabled: true - ``` -3. Run `codeclimate engines:install` -4. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: -### Configuration +- 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 -Like the `golint` binary, you can configure the minimum confidence threshold of -this engine: issues reported by `golint` must have a confidence value higher than -the threshold in order to be reported. The default value is `0.8`, the same as -`golint`: you can configure your own threshold in your `.codeclimate.yml`: +## Try out Qlty today free -```yaml -plugins: - golint: - enabled: true - config: - min_confidence: 0.1 -``` +[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. -### Building + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` -```console -make image -``` +[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) -### Need help? - -For help with Golint, [check out their documentation](https://github.com/golang/lint). - -If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-golint/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 fadeeadfae94b60868b71faae9ca37da78299a76 Mon Sep 17 00:00:00 2001 From: Laura Date: Tue, 15 Apr 2025 17:09:41 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 163fdd3..4abacb0 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ The new Qlty plugins system provides key advantages over the older, Docker-based [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. - - Install Qlty CLI: + - Install Qlty CLI: ` 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)