code-analysis

Code Analysis

Example Codeclimate configuration files

Rails projects:

The rails.codeclimate.yml configuration file is our example codeclimate config file for rails projects. This configuration enables codeclimate CLI to fetch our rules for "Rubocop" and "Reek" checks, among others, using the codeclimate prepare command.

Be sure to copy this file as .codeclimate.yml inside the root of your rails application:

# Go to the root of your rails project:
cd my-rails-app

# Fetch the example rails codeclimate config:
wget -O .codeclimate.yml "https://raw.githubusercontent.com/IcaliaLabs/guides/master/best_practices/code-analysis/rails.codeclimate.yml"

# Fetch the plugin configuration files:
codeclimate prepare

# Analyze your code:
codeclimate analyze

Python projects:

Adding to the 10-point check performed by CodeClimate, we're including also checks from the following engines:

• PEP8 - See the rules we're applying on the downloadable tox.ini file

• SonarPython - See SonarPython's Rule Explorer

The python.codeclimate.yml configuration file is our example codeclimate config file for typical python projects. This configuration enables codeclimate CLI to fetch our rules for "PEP8" and "Sonar Python" plugins, among others, using the codeclimate prepare command.

Be sure to copy this file as .codeclimate.yml inside the root of your rails application:

# Go to the root of your python project:
cd my-python-app

# Fetch the example python codeclimate config:
wget -O .codeclimate.yml "https://raw.githubusercontent.com/IcaliaLabs/guides/master/best_practices/code-analysis/python.codeclimate.yml"

# Fetch the plugin configuration files:
codeclimate prepare

# Analyze your code:
codeclimate analyze

Javascript + Node projects:

The javascript.codeclimate.yml configuration file is our example codeclimate config file for javascript projects, either frontend or backend, which typically uses node.js for compilation and/or runtime. This configuration enables codeclimate CLI to fetch our rules for "ESLint", "Node Security Project (nsp)" and "SCSS Lint" plugins, using the codeclimate prepare command.

Be sure to copy this file as .codeclimate.yml inside the root of your node application:

# Go to the root of your node project:
cd my-node-app

# Fetch the example javascript/node codeclimate config:
wget -O .codeclimate.yml "https://raw.githubusercontent.com/IcaliaLabs/guides/master/best_practices/code-analysis/javascript.codeclimate.yml"

# Fetch the plugin configuration files:
codeclimate prepare

# Analyze your code:
codeclimate analyze