From 765360e5dca5d07dc030edef09048845122769bb Mon Sep 17 00:00:00 2001 From: Laura Date: Fri, 28 Mar 2025 19:22:39 -0300 Subject: [PATCH 1/4] Update with deprecation notice.md --- README.md | 71 ++++++++++++++++--------------------------------------- 1 file changed, 21 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 762c6ff..163fdd3 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,31 @@ -# Code Climate Sonar-PHP Engine +# Try Qlty today, the newest edition of Code Climate Quality. +#### This repository is deprecated and archived. -[![CircleCI](https://circleci.com/gh/codeclimate/codeclimate-sonar-php.svg?style=svg&circle-token=72a9e9a49dc6a8653be6a69321012fe1d84abc3d)](https://circleci.com/gh/codeclimate/codeclimate-sonar-php) -[![Maintainability](https://api.codeclimate.com/v1/badges/2bdcb2e92bbc0efb855b/maintainability)](https://codeclimate.com/github/codeclimate/codeclimate-sonar-php/maintainability) -[![Test Coverage](https://api.codeclimate.com/v1/badges/2bdcb2e92bbc0efb855b/test_coverage)](https://codeclimate.com/github/codeclimate/codeclimate-sonar-php/test_coverage) +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. -`codeclimate-sonar-php` is a Code Climate engine that wraps [Sonarlint](http://www.sonarlint.org) in standalone mode. +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 -``` -make image -``` +As a result, this repository is no longer maintained and has been archived. -## Tests -``` -make test -``` +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: -## 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. Configure a `.codeclimate.yml` file in your repo. -```yml -engines: - sonar-php: - enabled: true - config: - tests_patterns: - - src/test/** -exclude_paths: - - build/ -``` -3. Run `codeclimate analyze`. +## Try out Qlty today free -## Custom configurations +[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. -### Severity -Ignore issues with severity below the minimum: -``` -engines: - sonar-php: - enabled: true - config: - minimum_severity: critical # default: major - # valid values are: info, minor, major, critical, blocker -``` + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` -## Sonar Documentation +[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) -http://www.sonarlint.org/commandline - -http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner - -Issue Tracker: http://jira.sonarsource.com/browse/SLCLI - -## Copyright - -This engine is developed by Code Climate using [SonarLint](http://www.sonarlint.org/commandline), it is not endorsed by SonarSoruce. - -See [LICENSE](LICENSE) +**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources. From aeae83a96afbb5331da4709aacb17c3ff6c54c5d Mon Sep 17 00:00:00 2001 From: Laura Date: Tue, 15 Apr 2025 17:12:27 -0300 Subject: [PATCH 2/4] 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) From f778b1b30888f8b989d506786af9f0cfb0f247e9 Mon Sep 17 00:00:00 2001 From: Laura Date: Tue, 15 Apr 2025 17:13:22 -0300 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a30c216..b5e1b67 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 ` powershell -c "iwr https://qlty.sh | iex" # Windows` +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) From 9cbdefc153319902feb5e94304546925912d6cc8 Mon Sep 17 00:00:00 2001 From: Laura Date: Tue, 15 Apr 2025 17:13:47 -0300 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b5e1b67..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 ` powershell -c "iwr https://qlty.sh | iex" # Windows ` +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)