|
1 | | -# Code Climate FIXME Engine |
| 1 | +# Try Qlty today, the newest edition of Code Climate Quality. |
| 2 | +#### This repository is deprecated and archived. |
2 | 3 |
|
3 | | -`codeclimate-fixme` is a Code Climate engine that performs a case-sensitive search for the following strings in your project: |
| 4 | +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. |
4 | 5 |
|
5 | | -* `TODO` |
6 | | -* `FIXME` |
7 | | -* `HACK` |
8 | | -* `BUG` |
9 | | -* `XXX` |
| 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. |
10 | 7 |
|
11 | | -These strings are things you should fix now, not later. |
| 8 | +As a result, this repository is no longer maintained and has been archived. |
12 | 9 |
|
13 | | -`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. |
| 10 | +## Advantages of Qlty plugins |
| 11 | +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: |
14 | 12 |
|
15 | | -### Installation & Usage |
| 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 |
16 | 17 |
|
17 | | -1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). |
18 | | -2. Run `codeclimate engines:enable fixme`. This command both installs the engine and enables it in your `.codeclimate.yml` file. |
19 | | -3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. |
| 18 | +## Try out Qlty today free |
20 | 19 |
|
21 | | -### Configuration |
| 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. |
22 | 21 |
|
23 | | -You can specify what strings to match by adding a `strings` key in your |
24 | | -`.codeclimate.yml`: |
| 22 | + - Install Qlty CLI: |
| 23 | +` |
| 24 | +curl https://qlty.sh | sh # Mac or Linux |
| 25 | +` |
| 26 | +or ` <windows install line> ` |
25 | 27 |
|
26 | | -```yaml |
27 | | -engines: |
28 | | - fixme: |
29 | | - enabled: true |
30 | | - config: |
31 | | - strings: |
32 | | - - FIXME |
33 | | - - CUSTOM |
34 | | -``` |
| 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) |
35 | 30 |
|
36 | | -**NOTE**: values specified here *override* the defaults, they are not |
37 | | -*additional* strings to match. |
38 | | -
|
39 | | -### Need help? |
40 | | -
|
41 | | -For help with `codeclimate-fixme`, please open an issue on this repository. |
42 | | - |
43 | | -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). |
| 31 | +**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources. |
0 commit comments