Language / Framework: Any language
Checks: ~5
Categories: Bug Risk

The FIXME engine performs a case-sensitive search for the following strings in your project: TODO, FIXME, HACK, XXX, and BUG, which are all things you should fix now, not later. You can also configure FIXME to search for any strings you want in you project.

Enable the Plugin

To enable FIXME analysis, add the following to your .codeclimate.yml configuration file:

plugins:
  fixme:
    enabled: true

More information about the CLI is available in the README here: https://github.com/codeclimate/codeclimate

Configure the Plugin

You may specify custom strings for the FIXME engine to target by adding a strings key under the engine's config in your .codeclimate.yml:

plugins:
  fixme:
    enabled: true
    config:
      strings:
      - FIXME
      - BUG
      - CUSTOM

Understand the Plugin

FIXME was created to show how simple it is to put a Code Climate engine together. Check out the FIXME repository for more information about how it works.

FIXME ships with a default severity level of info. This means that any new issues surfaced by FIXME will not result in a failed PR. To learn more about issue severity (and how to configure it), check out our doc here.

FIXME


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.