codeclimate-fixme is a Code Climate engine that performs a case-sensitive search for the following strings in your project:
TODOFIXMEHACKBUGXXX
These strings are things you should fix now, not later.
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.
- If you haven't already, install the Code Climate CLI.
- Run
codeclimate engines:enable fixme. This command both installs the engine and enables it in your.codeclimate.ymlfile. - You're ready to analyze! Browse into your project's folder and run
codeclimate analyze.
You can specify what strings to match by adding a strings key in your
.codeclimate.yml:
engines:
fixme:
enabled: true
config:
strings:
- FIXME
- CUSTOMNOTE: values specified here override the defaults, they are not additional strings to match.
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, as your question may have already been covered. If not, go ahead and open a support ticket with us.