AppCode 2021.2 Help

Scopes and file colors

A scope the Scope icon is a group of files and folders in a project. You can use scopes to visually distinguish project items in different IDE views and to limit the range of specific operations.

Scopes are designed to logically organize files in your project: test sources can go to the test-related scope, and production code can be associated with the scope of production files. These logical chunks make your project easier to manage. For example, running test-related inspections only in test classes takes less than if you run them in all files in your application.

AppCode comes with a set of predefined scopes, but you can also create custom scopes. There, you can include any files and folders. For example, a custom scope can include only those files in the project for which you are responsible.

In AppCode, scopes are used in code inspections, some refactorings, search, in copyright settings, in various features for code analysis, and so on.

There are 2 types of scopes: local and shared.

  • Local scopes are stored in the IDE configuration directory, that is why they are not shared through VCS and are not available to other members of your team.

  • Shared scopes are added to a VCS so that people who work on a project can use the same scopes. These scopes are stored together with the project in the scopes folder under .idea. Each scope is saved as a file with the .xml extension (for example: MyProject/.idea/scopes/shared-scope.xml).

Using shared scopes makes sense if your project is under version control. If you don't use a VCS, local scopes will be sufficient to cover your needs.

Define a new scope

In AppCode, there's a set of predefined scopes, but you can also define your own scopes.

  1. Press ⌃ ⌥ S to open the IDE settings and select Appearance & Behavior | Scopes.

  2. Click the Add Scope button and select what kind of scope you want to define: local or shared.

    You can change the state of the selected scope (local or shared) later using the Share through VCS checkbox.

    Creating a new scope: selecting between a shared and a local scope

  3. In the dialog that opens, name the new scope and click OK.

  4. Add files to the new scope. Select the necessary items in the project tree and click one of the options located on the right from the tree:

    • Include: include the selected items. If you are including a folder, this action adds only the files located inside this folder. All nested subfolders and their contents will not be included.

    • Include Recursively: include the selected folder together with the nested subfolders and their contents.

    • Exclude: exclude the selected items from the scope. If you are excluding a folder, this action removes only the files located inside this folder. All nested subfolders and their contents will remain in the scope.

    • Exclude Recursively: exclude the selected folder together with the nested subfolders and their contents.

    A new scope with added files and folders

    As you add files to the scope, AppCode creates an expression and displays it in the Pattern field. Instead of using the buttons, you can also type a pattern in the Pattern field manually using the scope language syntax reference.

  5. Apply the changes and close the dialog.

When you add items to the scope, their names change the color accordingly:

  • the green color sample Green: folders and files included in the scope.

  • the dark blue color sample Blue: folders that contain both excluded and included files and folders.

  • the black color sample Black: files and folders whose names are written in black are excluded from the scope.

After you create a custom scope, you can find it in the Project tool window and in all dialogs that allow you to limit the number of files to which you want to apply an action.

The new scope shown in the Project tool window

Predefined scopes

AppCode provides a set of predefined scopes. The IDE adds files to these scopes automatically based on in the information about them. Note that these scopes cannot be modified.

List of predefined scopes

  • Files :this scope includes all files within a project content root. Libraries and frameworks generally are not included in this scope.

  • Project Source Files: this scope corresponds to the files that contain project source code, including programs and tests.

  • Project Non-Source Files: this scope corresponds to other project files, for example, resources, licenses, and so on.

  • Scratches and Consoles: includes all files from the Scratches and Consoles directory located in the Project tool window.

  • All Changed Files: includes the last 50 files that you have opened or modified in the editor. You can change the number of recent files in the Limits area on the Editor | General page of the Preferences dialog ⌃ ⌥ S.

  • Open Files: includes the files that are currently open in the editor.

Associate scopes with colors

Files that belong to different scopes can be highlighted in different colors in search results, in editor tabs, and in the Project tool window.

Scope highlighting in the editor tabs and search results

To each scope, you can assign its own color. For example, you can assign a color to the Open Files scope and configure the IDE to show this color in the Project tool window. In this case, the files that you are currently working with in the editor will be colored in the project tree. This makes project navigation faster and simpler. Note that file colors work only in association with scopes.

Similarly to scopes, color associations can be local and shared.

  • Local colors are only visible to you and are not shared through VCS.

  • Shared colors are placed under version control so that people who work on a project can use the same color associations. They are stored in the project folder under .idea in the fileColors.xml file (for example: MyProject/.idea/fileColors.xml).

Create a new color association

  1. Press ⌃ ⌥ S to open the IDE settings and select Appearance & Behavior | File Colors.

  2. Make sure that the Enable File Colors checkbox is selected, and then choose where you want to use the colors: select Use in Editor Tabs or Use in Project View.

    If you select the Use in Project View checkbox, you will see colors in the Project tool window and in search results (for example, in the Find in Files dialog ⌃ ⇧ F).

  3. Click the Add button and select the scope for which you want to configure a color.

    You can select one of the pre-defined scopes or use a custom scope.

  4. Click the arrow the right arrow icon next to the necessary scope and select a color from the list that opens.

    To configure your own color, click Custom.

    Selecting a color for a custom scope

  5. To edit a color, click the cell that corresponds to the necessary scope in the Color column and select a new color from the list.

  6. To share a color through a VCS, select the checkbox on the corresponding line in the Shared column. If the checkbox is cleared, the color will be used locally.

    Picking another color for a custom scope

  7. Apply changes and close the dialog.

If a file is included in several scopes, the order of the scopes becomes important: AppCode processes the scopes from the top to the bottom starting from local scopes. It means that the IDE will apply the color of the last scope in the list to such a file.

You can change the order of the scopes if you want AppCode to process color associations in a different order.

Change the order of scopes

  1. Press ⌃ ⌥ S to open the IDE settings and select Appearance & Behavior | Scopes.

  2. Select the scope that you want to move and click the Move Up button (⌥ ↑) or the Move Down button (⌥ ↓).

  3. Apply the changes and close the dialog.

Last modified: 26 August 2021
Controlling source, library and exclude directories Scope language syntax reference