AppCode 2022.1 Help

Configuring code style

If certain coding guidelines exist in a company, one has to follow these guidelines when creating source code. AppCode helps you maintain the required code style.

The IDE comes with two pre-defined schemes: the Project scheme and the Default scheme.

  • In the Project scheme, the settings that you configure apply only to your current project.

    These settings are stored in the codeStyles folder under .idea and are shared through VCS together with the project.

    The IDE creates the folder after you modify code style settings for your project.

  • In the Default scheme (IDE-level scheme), the settings that you configure apply to all existing projects that have the Default code style scheme selected.

    These settings are stored in the codestyles folder under the AppCode configuration directory and are not shared through VCS.

If you want to use the project code style scheme as your default scheme, you can copy it to the IDE level. The other way around is also possible: you can overwrite your current project settings with the settings from an IDE-level scheme and share them with other members of your team.

Configure schemes

In AppCode, code style settings are language-specific, so you need to configure them for every language that you use in your project separately. You can also copy the settings from one language and apply them to another language.

Configure code style for a language

  1. Press ⌃ ⌥ S to open the IDE settings and select Editor | Code Style.

    To configure a scheme for new projects, go to File | New Projects Setup | Preferences for New Projects | Editor | Code Style.

  2. Select the language for which you want to configure the code style.

  3. Select the code style Scheme that you want to configure: the Project scheme or one of the IDE-level schemes.

  4. Browse through the tabs and configure code style preferences.

    Use the right-hand section of the dialog to preview the changes. When you change a setting, one or several blinking areas appear in the preview area emphasizing the changes.

Use code style settings from predefined guidelines

For C/C++, you can copy settings from the predefined code styles.

  1. Press ⌃ ⌥ S to open the IDE settings and select Editor | Code Style | C/C++/Objective-C.

  2. Select the link Set from in the upper-right corner and select one of the predefined styles from the upper part of the list:

    Using code style settings from predefined guidelines

Apply code style from another language

For most of the supported languages, you can copy code style settings from other languages or frameworks.

  1. Press ⌃ ⌥ S to open the IDE settings and select Editor | Code Style.

    To configure a scheme for new projects, go to File | New Projects Setup | Preferences for New Projects | Editor | Code Style.

  2. Select the language for which you want to configure the code style.

  3. Select the code style Scheme that you want to modify: the Project scheme or one of the IDE-level schemes.

  4. From the list that appears, select the language to copy the code style from.

    Set code style

Copy code style settings

  1. Press ⌃ ⌥ S to open the IDE settings and select Editor | Code Style.

    To configure a scheme for new projects, go to File | New Projects Setup | Preferences for New Projects | Editor | Code Style.

  2. Select the code style Scheme that you want to copy: the Project scheme or one of the IDE-level schemes.

  3. Click the Show Scheme Actions icon and select one of the following options:

    • Copy to IDE (for the Project scheme): copy the selected scheme to the IDE level.

      AppCode saves the new code style with the specified name to the AppCode home directory.

    • Copy to Project (for IDE-level schemes): overwrite your current project settings with the settings from the selected IDE-level profile.

    • Duplicate (for IDE-level schemes): create a copy of the selected IDE scheme on the same level.

    Copying code style scheme settings
  4. In the Scheme field, type the name of the new scheme and press to save the changes.

Import and export schemes

Import a scheme

Out of the box, AppCode allows you to import settings in the IntelliJ IDEA code style XML format.

  1. Press ⌃ ⌥ S to open the IDE settings and select Editor | Code Style.

  2. Click the Show Scheme Actions button and select Import Scheme.

  3. In the dialog that opens, select the file with the settings and click Open.

  4. Rename the scheme if necessary and select Current scheme to apply the settings from the scheme to your code.

Export a scheme

You can export both project-level and IDE-level schemes in the AppCode Code Style XML or EditorConfig format (if the EditorConfig plugin is enabled).

  1. Press ⌃ ⌥ S to open the IDE settings and select Editor | Code Style.

  2. Select the code style Scheme that you want to export: the Project scheme or one of the IDE-level schemes.

  3. Click the Show Scheme Actions button, select Export, select the necessary format, and select the directory to which you want to export your code style settings.

Last modified: 17 March 2022