Giter VIP home page Giter VIP logo

codeclimate-fixme's Introduction

Code Climate FIXME Engine

codeclimate-fixme is a Code Climate engine that performs a case-sensitive search for the following strings in your project:

  • TODO
  • FIXME
  • HACK
  • BUG
  • XXX

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.

Installation & Usage

  1. If you haven't already, install the Code Climate CLI.
  2. Run codeclimate engines:enable fixme. This command both installs the engine and enables it in your .codeclimate.yml file.
  3. You're ready to analyze! Browse into your project's folder and run codeclimate analyze.

Configuration

You can specify what strings to match by adding a strings key in your .codeclimate.yml:

engines:
  fixme:
    enabled: true
    config:
      strings:
      - FIXME
      - CUSTOM

NOTE: values specified here override the defaults, they are not additional strings to match.

Need help?

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.

codeclimate-fixme's People

Contributors

brynary avatar connerman avatar gdiggs avatar jpignata avatar mrb avatar pbrisbin avatar ryankennedy avatar wfleming avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.