codeclimate/spec

Name: spec

Owner: Code Climate

Description: Code Climate Engines Specification

Created: 2015-06-19 13:51:27.0

Updated: 2018-05-15 18:12:42.0

Pushed: 2017-11-10 16:46:31.0

Homepage: https://codeclimate.com/platform

Size: 76

Language: null

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Code Climate Engine

This repository contains the definition of the Code Climate Engine specification. This includes technical details about how to implement a static analysis engine compatible with the Code Climate ecosystem of tools, including the ability to run it locally as well as on CodeClimate.com. See SPEC.md for the actual specification.

What is a Code Climate Engine?

A Code Climate Engine is a static analysis module. Static analysis refers to the act of deriving data from code without actually executing it. Code Climate Engines have been created to produce data about code quality, security, style, performance and bug risk across a variety of programming languages.

What is the Code Climate Engine spec?

The Code Climate Engine spec describes a simple contract that must be followed to ensure compatability with the rest of the tools in the Code Climate static analysis ecosystem. It defines several aspects of Engine operation including input, outputs, packaging, as well as performance and security restrictions.

What is the promise of the Code Climate Engine spec?

Defining a simple specification that any static analysis tool can easily conform to makes it possible to integrate them all into a clear, unified workflow for developers. Engines can be run locally at any time on developers' laptops on the command line, but can also be set up to run on CodeClimate.com (which is free for open source) automatically after every commit and Pull Request.

What are some implementations of the spec?

The most mature implementations of the spec are:

• codeclimate-rubocop
• codeclimate-govet
• codeclimate-golint
• codeclimate-gofmt
• codeclimate-watson
• codeclimate-rubymotion
• codeclimate-coffeelint
• codeclimate-csslint

Working with the spec

To get started implementing an Engine, first install the Code Climate CLI. Once that is installed, build your Engine as a Docker image (see the Packaging section of the SPEC). When you are ready to test it locally, run:

$ codeclimate analyze --dev

The --dev flag will allow you to use the CLI with docker images that are in your local registry but not yet officially released.