WebStorm Help

Scopes

File | Settings | Appearance and Behavior | Scopes


A scope is a set of files to which various operations apply. Using this dialog, you can define scopes for the various WebStorm actions, for example, Find Usages, or Code Inspections.

In this section:

Main toolbar

ItemTooltipDescription
add Add scope
Insert
Click this button to add a new local or shared scope.
delete Delete
Delete
Click this button to delete the selected scope from the list.
copy Copy configuration
Ctrl+D
Click this button to create a copy of the selected scope.
mainToolbarSaveSave asClick this button to have the selected local scope saved as shared or a selected shared scope as local.
arrowUp arrowDown Move Up/Move DownUse these buttons to move the scopes up and down in the list.

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

.

Scope configuration controls

ItemDescription
NameIn this text box, specify the scope name.
PatternIn this text box, specify the pattern that defines the current scope. The following elements and structures can be used:
  1. The file: modifier. The element is mandatory.
  2. The * asterisk to denote any symbol in a file name or file extension.
  3. Logical operators AND (&&), OR (||), and NOT (!).

For more information, see Scope Language Syntax Reference.

Do one of the following:

  • Type or edit the pattern manually in the text field Pattern.
  • Click edit_scopes_icon, or press Shift+Enter to type of edit in the Pattern dialog box.
  • Choose the desired files in the Project Tree View and use the buttons described below to make WebStorm generate the corresponding pattern automatically.

Examples

  • file:*.js||file:*.coffee - include all JavaScript and CoffeeScript files.
  • file:*js&&!file:*.min.* - include all JavaScript files except those that were generated through minification, which is indicated by the min extension.
IncludeClick this button to have the selected element included in the scope. The corresponding expression is automatically generated and added to the expression in the Pattern text box.
Include RecursivelyClick this button to have the selected folder included in the scope, together with the nested subfolders. The corresponding expression is automatically generated and added to the expression in the Pattern text box.
ExcludeClick this button to have the selected element excluded from the scope. The corresponding expression is automatically added to the Pattern. If the current element is a folder, the nested subfolders are ignored.
Exclude RecursivelyClick this button to have the selected folder excluded from the scope, together with the nested subfolders. The corresponding expression is automatically added to the Pattern field.

Scope toolbar

ItemTooltipDescription
Project tree viewThe tree view contains all the files available in your project. In the view, select the desired files to be included in the current scope and have the scope definition pattern generated automatically. The message on the toolbar shows the total number of available files and the number of files included in the scope. See also the color legend below. Use the toolbar buttons described below to change the view presentation.
showFiles Show FilesIf this button is pressed, source files are displayed explicitly in the tree view. When the files are shown, they can be selected for exclusion/inclusion into a pattern.
scope_pattern

If this button is not pressed, the files are hidden.

commonfilter Show Included OnlyWhen the button is pressed, the tree shows only the elements that are included in the scope.

Legend of the project tree view

ItemDescription
Green Folders and files included in scope.
BlackFolders and files excluded from scope.
Blue Folders that contain both excluded and included files and subfolders.

See Also

Last modified: 22 May 2015