Codacy configuration file¶

Codacy supports configuring certain advanced features through a configuration file.

You can exclude files using glob patterns and add custom extensions to languages.

You can ignore files globally, for certain categories (duplication or metrics) or for a specific tool (e.g.: Rubocop). The category metrics refers to the information you find under File details such as Size, Structure and Complexity.

To add custom extensions to a language you can also add an entry in this file, but keep in mind that some tools might not work out of the box with those extensions and might need changes.

If you want to disable a tool, you must do it directly on the Code Patterns page.

The configuration file name must be ".codacy.yaml" or ".codacy.yml" and should be placed in the root of your repository.

Important

The configuration file must start with a line containing ---.

---
engines:
  rubocop:
    exclude_paths:
      - config/engines.yml
  duplication:
    exclude_paths:
      - config/engines.yml
  metric:
    exclude_paths:
      - config/engines.yml
languages:
  css:
    extensions:
      - '-css.resource'
exclude_paths:
  - '.bundle/**'
  - 'spec/**/*'
  - 'benchmarks/**/*'
  - '**.min.js'
  - '**/tests/**'

You must use the following Java glob syntax to configure your 'exclude_paths' to ignore files:

'**.extension' ignores all files with the same extension across all your repository
'test/*' ignores all files in the root of test
'test/**' ignores everything inside test
'test/**/*' ignores all files inside sub-folder of test
'**/*.resource' ignores all .resource in all folders and sub-folders

Please note that if the configuration file exists in your repository, any 'exclude paths' defined on Codacy's UI will not apply.

Validating your configuration file¶

You can use the codacy-analysis-cli to validate the contents of your configuration file. Run the following command in the folder where the configuration file is located:

codacy-analysis-cli validate-configuration --directory `pwd`

Which tools can be configured and which name should I use?¶

All tools that Codacy supports are configurable using our configuration file. The names that should be used for each of them are:

ameba
bandit
brakeman
bundleraudit
checkstyle
codacy-scalameta-pro
codenarc
coffeelint
cppcheck
credo
csslint
detekt
eslint
findbugs
findbugssec
flawfinder
golint
govet
hadolint
jacksonlinter
jshint
nsp
phpcs
phpmd
pmd-legacy
pmd
prospector
psscriptanalyzer
pylint
pylintpython3
remark-int
rubocop
scalastyle
scsslint
shellcheck
sonarscharp
spotbugs
SQLint
stylelint
swiftlint
tailor
tslint
tsqllint

If you have questions about the Codacy configuration file please contact us at support@codacy.com.

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

255 characters left

We're sorry to hear that. Please let us know what we can improve:

255 characters left

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

If you have a question or need help please contact support@codacy.com.

Last modified October 23, 2020