RubyMine 2018.3 Help

Creating and Registering File Types

If you're working with file types that are not recognized by RubyMine (for example, if it's a proprietary file type developed in-house), or if you need to code in an unsupported language, you can create a custom file type.

You can configure how the IDE will parse the files by defining highlighting schemes for keywords, comments, numbers, and so on. You can also associate each file type with an extension to help the IDE identify the files of the custom formats.

Create a new file type

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Editor | File Types.

  2. In the Recognized File Types section, click the Add icon, specify the name of the new type, and provide a description.

  3. In the Syntax Highlighting section, configure case sensitivity, brace matching settings, and specify ways of defining comments:

    Line comment

    Specify characters that indicate the beginning of a single-line comment.

    Only at line start

    Characters that indicate the beginning of a line comment are recognized as a comment if they are located in the beginning of a line.

    Block comment start

    Block comment end

    Specify characters that indicate the beginning and the end of a block comment.

    Hex prefix

    Specify characters that indicate that the subsequent value is a hexadecimal number (for example, 0x).

    Number postfixes

    Specify characters that indicate which numeric system or unit is used. A postfix is a trailing string of characters (for example, e-3, kg).

    Support paired braces

    Support paired brackets

    Support paired parens

    Support string escapes

    Enable these checkboxes to highlight paired braces, brackets, parentheses, and string escapes.

  4. In the Keywords section, you can specify up to four lists of keywords. Keywords of each list will be highlighted differently in the editor and will be auto-completed.

  5. The Ignore case checkbox indicates whether the language in files of the custom format is case-sensitive.

Register a new file type association

If you open a file with a registered extension, RubyMine opens such a file silently in the editor.

If a file type is registered under the Files opened in associated applications category, it's opened in a relevant application. For example, PDF files are opened in the default PDF viewer.

If RubyMine can't identify a file type, it prompts you to choose whether you want to register it, or open such a file in its associated application.

Registering a new file type

Change a file type association

You can associate a file type with another extension or remove an association.

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Editor | File Types.

  2. From the Recognized File Types list, select the file type that you want to associate with another extension.

  3. Use the the Registered Patterns section to make the necessary changes. You can add a new extension, remove an existing one, or modify an existing pattern.

Ignore files and folders

In RubyMine, there's a list of files and folders that are completely excluded from any kind of processing. Out of the box, this list includes temporary files, service files related to version control systems, and so on:

*.hprof;*.pyc;*.pyo;*.rbc;*.yarb;*~;.DS_Store;.git;.hg;.svn;CVS;__pycache__;_svn;vssver.scc;vssver2.scc;

Modify the list of ignored files and folders

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Editor | File Types.

  2. Make the necessary changes in the Ignore files and folders list. Make sure to use the semicolon (;) to separate the entries.

  3. Apply the changes and close the dialog.

Last modified: 10 January 2019

See Also