README.md

Code Climate luacheck Engine

CodeClimate Engine that runs luacheck on Lua files. Uses linguist to detect Lua files.

Engine

To enable the luacheck engine add the following to your .codeclimate.yml file:

engines:
  luacheck:
    enabled: true
ratings:
  paths:
    - "**.lua"

Configuration

Luacheck engine supports plenty of configuration options.

Checks

You can control which checks to enable/disable via patterns:

engines:
  luacheck:
    enabled: true
    checks:
      631: # disable check 631
        enabled: false
      4.2: # disable shadowing declarations of arguments or redefining them
        enabled: false

Config

You can control global configuration options of luacheck:

engines:
  luacheck:
    enabled: true
    config:
      allow_defined: # you can use both enabled: true/false and just true/false
        enabled: true
      allow_defined_top: false
      module: false
      compat: true
      std: # which standard library to use, all are concatenated with +
        - min
        - busted
      globals:
        - val
      read_globals:
        - read
      new_globals:
        - new
      new_read_globals:
        - new
      not_globals:
        - new
      ignore:
        - new
      enable:
        - new
      only: # only run global-related warnings
        - 1

Testing

make build test integration