A scope() is a subset of files, and/or directories in your project, to which you can limit the application of specific operations, e.g. search, code inspection, etc. Besides, you can configure coloring for each scope to see at once what sort of file you are dealing with.
Scopes get more helpful as your project grows larger. There is a number of predefined scopes that cover basic cases. Additionally, it is possible to add custom scopes to your project. For example, you can create custom scopes for tests or for the files you are responsible for in your team.
Types of scopes
Scopes can be either shared or local:
- Local scopes are intended for personal use only and are stored in your workspace in the file
If necessary, you can share a local scope, make a shared scope local, or create a copy of the scope. For more information, see Configuring Scopes and File Colors.
CLion provides a special language that enables you to flexibly define the sets of entities included in a scope.
See Scope Language Syntax Reference for details.
To create and edit scopes, use the Scopes page of the Settings/Preferences dialog.
Scopes are defined in the following modes:
- Manually, by specifying file masks according to the scope language syntax in the Pattern text box.
- By selecting files and folders and clicking the buttons Include, Include Recursively, Exclude, and Exclude Recursively. Based on the inclusion/exclusion, CLion creates an expression and displays it in the Pattern.
Refer to the section Configuring Scopes and File Colors.
To view the available scopes, click the (next to the Project header of the Project Tool Window.
Files belonging to different scopes can be highlighted in different colors throughout the CLion's user interface: in navigation lists, in the editor tabs, in the Project Tool Window. This allows much faster and easier navigation in large projects.
If some file is included into several scopes, the order of the scopes becomes important: CLion uses the color of the uppermost scope (shown in the Scopes settings page) to highlight such file. Of course, you can change the order of the scopes, and thus the resulted highlighting.
For detailed instructions on how to configure the scope order and scope-color associations, see Configuring Scopes and File Colors.
CLion provides a number of predefined scopes, for example:
- Project Files. This scope includes all the files within the project content roots, Libraries and frameworks, generally, are not included in this scope.
- Project Source Files. This scope corresponds to the files that contain a project source code, including program and tests.
- Project Non-Source Files. This scope corresponds to the other project files, e.g resources, licenses, etc.
- Non-Project Files. This scope is available only as a view in the Project Tool Window. It is limited to libraries and SDKs.
- Changed Files. This scope corresponds to all changed files, that is, ones associated with all existing changelists.
- Default. This scope corresponds to the files associated with the
Predefined scopes cannot be edited.