DataGrip 2018.3 Help

Scopes

Scope is a filtered subset of files and directories in your project. When you enable the Scopes view, you limit operations like search and code inspection to the selected scope. This section describes how to configure scopes and coloring of the files belonging to these scopes:

Create a new scope

Project scopes are configured on the Scopes page of the Settings/Preferences dialog box.

  1. Open Settings (Ctrl+Alt+S) and navigate to Appearance & Behavior | Scopes, click the Add scope (Insert) icon(The Add scope (Insert) icon).

  2. Select Local or Shared from the drop-down list.

    • Local scopes are intended for a personal use only and are stored in your workspace. Default location: %HOMEPATH%\.<product><version>\config\projects\<project_name>\.idea\workspace.xml.

    • Shared scopes are defined for the current project and accessible for the team members via VCS. Default location: %HOMEPATH%\.<product><version>\config\projects\<project_name>\.idea\scopes\.

  3. Specify a name of the scope.

Configuring a list of items in a scope

Configure a list of items in a scope

  1. Navigate to File | Settings | Appearance & Behavior | Scopes, select the scope that you want to configure.

  2. To define a pattern for the scope, perform one of the following actions:
    • To include files and directories in the scope, select files and directories and press Include or Include Recursively (with subdirectories) buttons. To exclude a file or a directory, use Exclude or Exclude Recursively. DataGrip creates an expression and displays it in the Pattern field.

    • Specify a pattern in the Pattern field manually, using the scope language syntax.

  3. Click Apply.

Filter files in the attached directory by the file extension

  1. Navigate to Files | Settings | Appearance & Behavior | Scopes, click the Show Options Menu icon (artwork studio icons logcat toolbar settings) and select Edit Scopes.

  2. Select a scope or create a new one.

  3. In the Pattern field, type the following code: file:*.<file_extension>, where <file_extension> is a file extension that you want to use for a filter.

  4. In the Files tool window, click the Files drop-down list and select the scope name that you created.

db add scope for file extension

Associating file color with a scope

Files belonging to different scopes can be highlighted in different colors throughout the DataGrip's user interface: in navigation lists, in the editor tabs, in the Files tool window. This allows much faster and easier navigation in large projects.

Associate file color with a scope

  1. Navigate to File | Settings | Appearance & Behavior | File Colors.

  2. Click Add (icons general add svg).

  3. In the Add Color Label dialog, select a scope and pick a color for it.

  4. Click OK.

  5. Define the area where you want to use scope colors. To define the area, select Use in Editor Tabs or Use in Project View checkboxes.

  6. Select the accessibility level of the scope color association. To share the color association, click the Share icon(icons actions share). The default location for file color associations is %HOMEPATH%\.<product><version>\config\projects\<project_name>\.idea\fileColors.xml.

  7. Apply changes.

Arranging the order of scopes

If some file is included into several scopes, the order of the scopes becomes important: DataGrip 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.

Arrange the order of scopes

  1. Navigate to Files | Settings | Appearance & Behavior | Scopes.

  2. Select a scope that you want to move.

  3. To change the order, click Move Up (icons actions previousOccurence svg) or Move Down icons (icons actions nextOccurence svg).

  4. Click Apply.

Reference for the scope language syntax

Description

Pattern

Example

Include a single file by its name

file:<directory>/<file>file:databases/create_schema.sql

Include a set of all files in a directory, without subdirectories

file:<directory>/*file:databases/mysql-db/*

Include a set of all files in a directory with subdirectories

file:<directory>//*file:databases/mysql-db//*

Include a file by its name from the certain project

file[project_name]:<directory>/<file>file[default]:databases/create_schema.sql

Possible logical operators &&·(AND), ||·(OR), !·(NOT).

file[project_name]:<directory>&&!file:<directory>file[default]:databases/*&&!file:databases/create_schema.sql
Last modified: 28 November 2018

See Also