Documentation

Using .inch.yml to include/exclude stuff

By default, Inch looks into {app,lib}/**/*.rb for Ruby source files.

You can configure which files and objects Inch considers by creating a file named .inch.yml in your project directory:

files:
  # define files included in the analysis (defaults to ["{app,lib}/**/*.rb"])
  included:
    - plugins/**/*.rb
  # define files excluded from the analysis (defaults to [])
  excluded:
    - plugins/vendor/sparkr/sparkr.rb

As you would expect, included sets an array of included files (or globs). This way you can point Inch to where your sources are, if they are not in app/ or lib/.

excluded sets an array of files (or globs) to exclude files from the evaluation.