Ignore Files and Violations

Introduction

There are files you do not want to include in analysis done by Code Inspector, either because they are not useful to be analyzed or you just do not want to have them processed.

There are several ways Code Inspector ignores files, we are explaining each of them.

Default .gitignore file

Code Inspector processed your .gitignore files and automatically ignore all files specified in that directory. It does not process or parse regular expression, our engine ignores files and directory specified by their full name.

# The directory directory_to_ignore will be ignored
directory_to_ignore

# The directory directory_to_ignore will NOT be ignored
directory_*_ignore

Optional .ci-ignore file

You can also add a .ci-ignore file in your codebase. This file is exactly like a .gitignore and specific to Code Inspector. Put all the files and directory you want Code Inspector to ignore.

Note: File and directory names are relative to the project root directory.

Note: You should not put the starting '/' character in the list of files/directories to ignore

All files and directory specified in that files will also not count towards your slocs count. In other words, if your account has too many lines of code, a good way to reduce the number of lines of code is to add files/directory in that file.

You need to specify the full name of the file in the .ci-ignore files. Regular expressions are not supported.

# The directory directory_to_ignore will be ignored
directory_to_ignore

# The directory directory_to_ignore will NOT be ignored
directory_*_ignore

File configured in the User Interface

You can also ignore paths in the project configuration, as shown below, by entering paths separated by the character ;.

Note: You should not put the starting '/' character in the list of files/directories to ignore

When ignoring files and violations using project preferences, issues are filtered when being surfaced through the API. In other words, these files and directories are still analyzed but are rather filtered in the User Interface. Therefore, directories specified in the configuration still count as analyzed source lines of code.