• Elixir plugin
  • IDEs
  • Features
    • Project
      • From Existing Sources
        • Import project from external model
        • Create project from existing sources
      • New
    • Project Structure
    • Project Settings
    • Module Settings
      • Sources
      • Paths
      • Dependencies
    • New Elixir File
      • Empty module
      • Elixir Application
      • Elixir Supervisor
      • Elixir GenServer
      • Elixir GenEvent
    • Syntax Highlighting and Semantic Annotation
    • Grammar parsing
    • Inspections
      • Ambiguous nested calls
      • Ambiguous parentheses
        • Empty Parentheses
        • Keywords in Parentheses
        • Positional arguments in Parentheses
      • Keyword pair colon (:) used in type spec instead of type operator (::)
      • Keywords appear before the end of list.
      • Match operator (=) used in type spec instead of type operator (::)
    • Quick Fixes
      • Convert : to :: in type specs
      • Convert = to :: in type specs
      • Remove space in front of ambiguous parentheses
    • Code Folding
      • Controls
        • Collapsing
        • Expanding
      • Regions
    • Commenter
    • Credo
      • Annotator
        • Enable
        • Disable
      • Inspection
        • Batch Mode
      • Configuration
    • Debugger
      • Steps
      • Basics
        • Keyboard Shortcuts
        • Excluding Modules
          • Disabling Existing Module Patterns
          • Editing Existing Module Patterns
          • Removing Existing Module Patterns
          • Adding New Module Patterns
        • Environment Variables
      • Breakpoints
        • Accessing Breakpoint Properties
          • Viewing all breakpoints
          • Viewing a single breakpoint
        • Configuring Breakpoints
        • Creating Line Breakpoints
        • Describing Line Breakpoints
        • Searching for Line Breakpoints
        • Jump to Breakpoint Source
        • Disabling Line Breakpoints
        • Deleting Line Breakpoints
      • Starting the Debugger Session
      • Examining Suspended Program
        • Processes
        • Frames
          • Jump to Current Execution Point
        • Variables
      • Evaluate
      • Stepping
    • Delimiters
      • Auto-inserting
      • Matching
    • Dialyzer
      • Inspection
    • Embedded Elixir (EEx) Templates
      • Advanced configuration
    • Live Embedded Elixir (LEEx) Templates
      • Advanced configuration
    • Building/Compiling
      • Settings
      • Build Messages
        • Jump To Source
        • Warnings as Errors
      • Individual File
      • Project
    • Live Templates
    • Documentation
      • Rendered View
      • Quick Documentation
    • Run/Debug Configurations
      • Distillery Release CLI
        • Running
        • Debugging
      • Elixir
        • Running
        • Debugging
      • IEx (Interactive Elixir)
        • Running
        • Debugging
      • Mix Tasks
        • Running
        • Debugging
      • IEx Mix
        • Running
        • Debugging
      • mix espec
        • Using graphical formatter
        • Creating mix espce Run Configurations Manually
        • Running
        • Debugging
        • Creating mix espec Run Configurations from context
          • Creating/Running mix espec Run Configurations from directory
          • Creating/Running mix espec Run Configurations from file
          • Creating/Running mix espec Run Configurations from line
      • mix test
        • Creating mix test Run Configurations Manually
        • Running
        • Debugging
        • Creating mix test Run Configurations from context
          • Creating/Running mix test Run Configurations from directory
          • Creating/Running mix test Run Configurations from file
          • Creating/Running mix test Run Configurations from line
    • .beam Files
      • Decompression
      • BEAM Chunks
        • Atom / AtU8
          • Format
          • Tab
        • Attr
          • Format
          • Tab
        • CInf
          • Format
          • Tab
        • Code
          • Format
          • Tab
        • Dbgi
          • Format
          • Tab
        • ExDc
          • Format
          • Tab
        • ExpT
          • Format
          • Tab
        • ImpT
          • Format
          • Tab
        • LitT
          • Format
          • Tab
        • Line
          • Format
          • Tab
        • LocT
          • Format
          • Tab
        • StrT
          • Format
          • Tab
      • Decompilation (Text)
        • Call definition macros
          • defp with / in name
        • Special handling of call definition names
    • Completion
      • Aliases and Modules
        • Aliases inside { }
      • Function and Macro Calls
        • Qualified
        • Unqualified
      • Module Attributes
      • Parameters and Variables
    • Go To Declaration
      • Alias
      • Function or Macro
        • Imported Functions or Macros
        • Local Functions or Macros
        • Remote Functions or Macros
      • Module
      • Module Attribute
      • Parameters and Variables
    • Formatting
      • Directory
      • File
        • Other File
        • Current File
      • Selection
    • Go To Related
      • Decompiled Module
      • Decompiled Call Definition
    • Go To Symbol
    • Go To Test
    • Go To Test Subject
    • Find Usages and Show Usages
      • Function
      • Module
      • Module Attribute
      • Parameters and Variables
    • Refactor
      • Rename
        • Module Attribute
        • Parameters and Variables
    • SDK
      • Package Manager Install Locations
      • Rich IDEs
        • Default SDK
      • Small IDEs
        • Elixir Facet SDK
        • Elixir SDKs
        • Internal Erlang SDK
    • Show Parameters
    • Structure
      • Viewing Structure
      • Buttons
        • Sorters
        • Providers
        • Expanders
        • Autoscrollers
      • Elements
        • Icons
          • Time
          • Visibility
        • Call to Element
  • Installation
    • Stable releases
      • Inside IDE using JetBrains repository
      • Inside IDE using Github releases
        • In browser
        • In IDE
    • Canary releases
      • Inside IDE using JetBrains repository
      • Inside IDE using Github releases
        • In browser
        • In IDE
  • Screenshots
  • Error reporting
  • Contributors
  • Donations
    • Work Time
    • Donors
    • Patrons
    • Backers
    • Sponsors

This is a plugin that adds support for Elixir to JetBrains IDEs.

The plugin works both in the rich IDEs that allow alternative language SDK selection and small IDEs that are language specific. The rich IDEs work best for IntelliJ Elixir because only in the rich IDEs can have an Elixir SDK set as the Project SDK. In all small IDEs, the native language SDK is always there, which makes anything that uses the SDK, such as running elixir, erl, or mix more complicated both internally and externally in the configuration you have to setup.

The plugin is free to use in all JetBrains IDEs. The Cost column in the below table is what JetBrains charges for the IDE itself. IntelliJ Elixir is maintained by @KronicDeth who does not get any of the subscription money. If you want to support the plugin itself, make a donation.

Once you have your IDE of choice installed, you can install this plugin

If you've already created a mix project, you can load it as an Elixir project into the plugin.

1. File > New > Project From Existing Sources...

2. Select the root directory of your project.

3. Select "Import project from external model"

4. Select Mix

   

5. Click Next

6. Select a Project SDK directory by clicking Configure.

7. The plugin will automatically find the newest version of Elixir installed. (NOTE: SDK detection only works for Linux, homebrew installs on OSX, and Windows. Open an issue with information about Elixir install locations on your operating system and package manager to have SDK detection added for it.)

8. If the automatic detection doesn't find your Elixir SDK or you want to use an older version, manually select select the directory above the bin directory containing elixir, elixirc, iex, and mix. (On Windows it is the directory containing elixir.bat, elixirc.bat, iex.bat, and mix.bat.)

9. Click Finish after you select SDK name from the Project SDK list.

10. The "Mix project root" will be filled in with the selected directory.

11. (Optional) Uncheck "Fetch dependencies with mix" if you don't want to run mix deps.get when importing the project

• If "Fetch dependencies with mix" is checked both mix local.hex --force and mix deps.get will be run.

12. Click Next
13. All directories with mix.exs files will be selected as "Mix projects to import". To import just the main project and not its dependencies, click Unselect All.
14. Check the box next to the project root to use only its mix.exs. (It will likely be the first checkbox at the top.)
15. Click Finish

If you've already created a (non-mix) project, you can load it as an Elixir project into the plugin.

1. File > New > Project From Existing Sources...
2. Select the root directory of your project.
3. Leave the default selection, "Create project from existing sources"
4. Click Next
5. Project name will be filled with the basename of the root directory. Customize it if you like.
6. Project location will be the root directory.
7. Click Next.
8. If you previously opened the directory in IntelliJ or another JetBrains IDE, you'll be prompted to overwrite the .idea directory. Click Yes.
9. You'll be prompted with a list of detected Elixir project roots to add to the project. Each root contains a mix.exs. Uncheck any project roots that you don't want added.
10. Click Next.
11. Select a Project SDK directory by clicking Configure.
12. The plugin will automatically find the newest version of Elixir installed. (NOTE: SDK detection only works for Linux, homebrew installs on OSX, and Windows. Open an issue with information about Elixir install locations on your operating system and package manager to have SDK detection added for it.)
13. If the automatic detection doesn't find your Elixir SDK or you want to use an older version, manually select select the directory above the bin directory containing elixir, elixirc, iex, and mix.
14. Click Next after you select SDK name from the Project SDK list.
15. Click Finish on the framework page. (No framework detection is implemented yet for Elixir.)
16. Choose whether to open in a New Window or in This Window.

If you want to create a basic (non-mix) Elixir project with a lib directory, perform the following steps.

1. File > New > Project

   

2. Select Elixir from the project type menu on the left

3. Click Next

   

4. Select a Project SDK directory by clicking Configure.

   

5. Select a Project SDK directory by clicking Configure.

6. The plugin will automatically find the newest version of Elixir installed.

   • macOS / OSX
     • Homebrew (/usr/local/Cellar/elixir)
     • Nix (/nix/store)
   • Linux
     • /usr/local/lib/elixir
     • Nix and NixOS (/nix/store)
   • Windows
     • 32-bit (C:\Program Files\Elixir)
     • 64-bit (C:\Program Files (x86)\Elixir)
     • (NOTE: SDK detection only works for Open an issue with information about Elixir install locations on your operating system and package manager to have SDK detection added for it.)

7. If the automatic detection doesn't find your Elixir SDK or you want to use an older version, manually select select the directory above the bin directory containing elixir, elixirc, iex, and mix. If the bin, lib, or src directory is incorrectly selected, it will be corrected to the parent directory.

8. Click Next after you select SDK name from the Project SDK list.

9. Change the Project name to the name your want for the project

10. (Optionally) change the Project location if the directory does not match what you want

11. (Optionally) expand More Settings to change the Module name, Content root, Module file location, and/or Project format. The defaults derived from the Project name and Project location should work for most projects.

12. Click Finish

13. Choose whether to open in a New Window or in This Window.

• Excluded
  • _build (Output from mix)
  • rel (Output from exrm)
• Sources
  • lib
• Test Sources
  • test

The Project Settings include

• Project Name
• Project SDK

The Module Settings include Marking directories as

• Excluded
• Sources
• Tests

Module paths list the output directories when compiling code in the module. There is a an "Output path" for dev MIX_ENV and "Test output path" for the test MIX_ENV.

Module dependencies are currently just the SDK and the sources for the module. Dependencies in deps are not automatically detected at this time.

1. Right-click a directory (such as lib or test in the standard mix new layout)

2. Select New > Elixir File.

   

3. Enter an Alias for the Module name, such as MyModule or MyNamespace.MyModule.

4. Select a Kind of Elixir File to use a different template.

   

An underscored file will be created in an underscored directory lib/my_namespace/my_module.ex) with the given module name with be created:

defmodule MyNamespace.MyModule do
  @moduledoc false

end

An underscored file will be created in an underscored directory lib/my_namespace/my_module.ex) with the given module name with be created. It will have a start/2 function that calls MyNamespace.MyModule.Supervisor.start_link/0.

defmodule MyNamespace.MyModule do
  @moduledoc false

  use Application

  def start(_type, _args) do
    MyNamespace.MyModule.Supervisor.start_link()
  end
end

An underscored file will be created in an underscored directory lib/my_namespace/my_module.ex) with the given module name with be created. It will have a start_link/1 function that calls Supervisor.start_link/0 and init/1 that sets up the child specs. It assumes a MyWorker child that should be supervised :one_for_one.

defmodule MyNamespace.MyModule.Supervisor do
  @moduledoc false

  use Supervisor

  def start_link(arg) do
    Supervisor.start_link(__MODULE__, arg)
  end

  def init(arg) do
    children = [
      worker(MyWorker, [arg], restart: :temporary)
    ]

    supervise(children, strategy: :one_for_one)
  end
end

An underscored file will be created in an underscored directory lib/my_namespace/my_module.ex) with the given module name with be created. It will have a start_link/2 function that calls GenServer.start_link/3 and the minimal callback implementations for init/1, handle_call/3, and handle_cast/2.

The Elixir use GenServer supplies these callbacks, so this template is for when you want to change the callbacks, but would like the stubs to get started without having to look them up in the documentation.

defmodule MyNamespace.MyModule do
  @moduledoc false

  use GenServer

  def start_link(state, opts) do
    GenServer.start_link(__MODULE__, state, opts)
  end

  def init(_opts) do
    {:ok, %{}}
  end

  def handle_call(_msg, _from, state) do
    {:reply, :ok, state}
  end

  def handle_cast(_msg, state) do
    {:noreply, state}
  end
end

An underscored file will be created in an underscored directory lib/my_namespace/my_module.ex) with the given module name with be created. The minimal callback implementations for init/1, handle_event/2, and handle_call/2, handle_info/2.

The Elixir use GenEvent supplies these callbacks, so this template is for when you want to change the callbacks, but would like the stubs to get started without having to look them up in the documentation.

defmodule MyNamespace.MyModule do
  @moduledoc false

  use GenEvent

  # Callbacks

  def init(_opts) do
    {:ok, %{}}
  end

  def handle_event(_msg, state) do
    {:ok, state}
  end

  def handle_call(_msg, state) do
    {:ok, :ok, state}
  end

  def handle_info(_msg, state) do
    {:ok, state}
  end
end

Syntax highlighting of lexer tokens and semantic annotating of parser elements can be customized in in the Color Settings page for Elixir (Preferences > Editor > Color & Fonts > Elixir).

Text Attribute Key Display Name			Tokens/Elements	Scheme
				Default	Darcula
Alias			String
Atom			:one <<>>:
Braces and Operators	Bit		<< >>
Braces and Operators	Braces		{ }
Braces and Operators	Brackets		[ ]
Braces and Operators	Character Token		?
Braces and Operators	Comma		,
Braces and Operators	Dot		.
Braces and Operators	Interpolation		#{ }
Braces and Operators	Maps and Structs	Maps	%{ }
Braces and Operators	Maps and Structs	Maps	% { }
Braces and Operators	Operation Sign		= + * == ! && || |> ^
Braces and Operators	Parentheses		( )
Braces and Operators	Semicolon		;
Calls	Function		inspect	*Only the Italic attribute	*Only the Italic attribute
Calls	Macro		inspect	*Only the Bold and Italic attributes	*Only the Bold and Italic attributes
Calls	Predefined		Kernel functions macros Kernel.SpecialForms macros	*Only the Foreground attribute	*Only the Foreground attribute
Comment			# Numbers
Keywords			end
Module Attributes			@custom_attr
Module Attributes	Documentation		@doc
Module Attributes	Documentation	Text	Simple module docstring
Module Attributes	Types	Callback	func
Module Attributes	Types	Specification	func
Module Attributes	Types	Type	parameterized
Module Attributes	Types	Type Parameter	type_parameter
Numbers	Base Prefix	Non-Decimal	0b 0x 0o
Numbers	Base Prefix	Obsolete Non-Decimal	0B 0X
Numbers	Decimal Exponent, Mark, and Separator		e . _
Numbers	Digits	Invalid	2 o r 888
Numbers	Digits	Valid	1234 1A beef 123
Textual	Character List		'This is a list'
Textual	Escape Sequence		\x{12}
Textual	Sigil		~r// ~R'' ~w() ~W()
Textual	String		"Hello world"
Variables	Ignored		_
Variables	Parameter		a b </td> <td> <img src="screenshots/preferences/editor/colors_and_fonts/default/Variables/Parameter.png?raw=true"/> </td> <td> <img src="screenshots/preferences/editor/colors_and_fonts/darcula/Variables/Parameter.png?raw=true"/> </td> </tr> <tr> <td>Variables</td> <td>Variable</td> <td></td> <td> <code>pid</code> </td> <td> <img src="screenshots/preferences/editor/colors_and_fonts/default/Variables/Variable.png?raw=true"/> </td> <td> <img src="screenshots/preferences/editor/colors_and_fonts/darcula/Variables/Variable.png?raw=true"/> </td> </tr>

Built on top of highlighted tokens above, the parser understands the following parts of Elixir grammar as valid or allows the grammar because they contain correctable errors:

• Empty Parentheses (())
• Keyword Lists
  • Keyword Keys - Aliases, identifiers, quotes, or operators when followed immediately by a colon and horizontal or vertical space.
  • Keyword Values - Empty parentheses (()) and matched expressions.
• Matched Expressions, in other words, unary and binary operations on variable, function, and macro names and values (numbers, strings, char lists, sigils, heredocs, true, false, and nil).
• No Parentheses expressions, which are function calls with neither parentheses nor do blocks that have either (1) a positional argument and keyword arguments OR (2) two or more positional arguments with optional keyword arguments.
• Anonymous function calls .() with either no arguments; a no parentheses arguments expression as an argument; keywords as an argument; positional argument(s); or positional arguments followed by keywords as arguments.
• Remote function calls (Alias.function, :atom.function, etc) and local function calls (function) with...
  • No Parentheses with...
    • No Arguments (Alias.function)
    • Keywords (Alias.function key: value)
    • Nested No Parentheses Call (Alias.function Inner.function positional, key: value)
    • Positional and Keyword arguments (Alias.function positional, key: value)
    • Matched Expression (Alias.function 1 + 2)
  • Parentheses with...
    • No arguments (Alias.function())
    • No Parentheses Call (Alias.function(Inner.function positional, key: value)
    • Keywords (Alias.function(key: value))
    • Positional and Keyword arguments (Alias.function(positional, key: value))
    • Trailing parentheses for quoting (def unquote(variable)(positional))
• Bracket expression (variable[key])
• Block expressions (function do end)
• Unmatched expressions, in other words combinations of block expressions and matched expressions.

Inspections mark sections of code with warnings and errors. They can be customized from the Preferences > Inspections > Elixir.

Detects when compiler will throw unexpected comma. Parentheses are required to solve ambiguity in nested calls. Function calls with multiple arguments without parentheses cannot take as arguments functions with multiple arguments without parentheses because which functional gets which arguments is unclear as in the following example:

outer_function first_outer_argument,
               # second argument is another function call without parentheses, but with multiple arguments
               inner_function first_inner_argument,
               ambiguous_keyword_key: ambiguous_keyword_value

To fix the ambiguity if first_inner_keyword_key: first_inner_keyword_value should be associated, add parentheses around the inner function's arguments:

# keywords are for inner function
outer_function first_outer_argument
               inner_function(
                 first_inner_argument
                 ambiguous_keyword_key: ambiguous_keyword_value
               )

# keywords are for outer function
outer_function first_outer_argument
               inner_function(
                 first_inner_argument
               ),
               ambiguous_keyword_key: ambiguous_keyword_value

Detects when compiler will throw unexpected parenthesis. If you are making a function call, do not insert spaces in between the function name and the opening parentheses. Function calls with space between the function name and the parentheses cannot distinguish between function calls with parentheses, but with an accidental space before the ( and function calls without parentheses where the first positional argument is in parentheses.

function ()

To fix the ambiguity remove the space or add outer parentheses without the space if the first argument should be ():

# extra space, no arguments to function
function()

# first argument is `()`
function(())

function (key: value)

Keywords inside parentheses is not valid, so the only way to fix this is to remove the space

function(key: value)

function (first_positional, second_positional)

A list of positional arguments in parenthenses is not valid, so the only way to fix this is to remove the space

function(first_positional, second_positional)

Type specifications separate the name from the definition using ::.

@type name: definition

Replace the : with ::

@type name :: definition

one.(
  one,
  two positional, key: value,
  three
)

Keywords can only appear at the end of an argument list, so either surround the no parentheses expression argument with parentheses, or move the the keywords to the end of the list if it wasn't meant to be a no parentheses expression.

one.(
  one
  two(positional, key: value),
  three
)

OR

one.(
  one,
  two,
  three,
  key: value
)

Type specifications separate the name from the definition using ::.

@type name = definition

Replace the = with ::

@type name :: definition

Quick Fixes are actions IntelliJ can take to change your code to correct errors (accessed with Alt+Enter by default).

If a type specification uses a single : instead of ::, then hit Alt+Enter on the : to change it to :: and fix the type spec.

If a type specification uses = instead of ::, then hit Alt+Enter on the = to change it to :: and fix the type spec.

If a set of parentheses is marked as ambiguous then the space before it can be removed to disambiguate the parentheses with Alt+Enter. (Will vary based on keymap.)

You can collapse (fold) pre-defined regions of your Elixir code to make it easier to quickly scroll through files or hide details you don't care about right now.

1. Position cursor between lines with with downward facing - arrow and upward facing - arrow.
2. Cmd+-

1. Position cursor on the collapsed line with the square +
2. Cmd++

You can comment or uncomment the current line or selected block of source. By selecting a block of source first you can quickly comment out and entire function if you're trying to track down a compiling or testing error that's not giving a helpful line number.

Using the menus

1. Highlight one or more lines
2. Comment (or Uncomment) with one of the following: a. Code > Comment with Line Comment b. On OSX the key binding is normally Cmd+/.

If you'd like to run mix credo use can run it as a global Inspection.

1. Analyze > Run Inspection By Name... (⌥⇧⌘I)
2. Type "Credo"
3. Select "Credo" from the shortened list
4. Hit Enter.

You'll be presented with a "Run 'Credo'" dialog

1. Change the "Inspection scope" from "Whole project", which would include the deps to "Custom scope"
2. Select "Project Production Files" from the "Custom scope" dropdown
3. Click "OK"

The Inspections Result Tool Pane will open and show results as each file is processed.

1. Click the ▶ to expand the Credo section to show all warnings

   

2. Click an entry for the details of an individual warning with a code highlighting.

   

   The view will show the parts of the file that aren't annotated as collapsed with the discontinuous line number indicating the jumps.

   If you click on + collapse markers, you can expand the collapsed sections to see the full context

   

   Or you can hover over the collapsed section to see a tooltip preview of the expansion

   

If you want to limit the performance impact of the credo annotator because mix credo spikes your CPU, you can limit the number of mix credo runs to 1 per open file by disabling the Explanation tooltip

1. Preferences > Editor > Inspections > Credo
2. Uncheck "Include Explanation"

If you don't want the annotator to run at all on open editors, then you can disable the paired inspection

1. Preferences > Editor > Inspections
2. Uncheck Elixir > Credo

Once the annotator is disabled, you can still run the inspection in batch mode

IntelliJ Elixir allows for graphical debugging of *.ex files using line breakpoints.

1. Define a run/debug configuration
2. Create breakpoints in the *.ex files
3. Launch a debugging session
4. During the debugger session, step through the breakpoints, examine suspended program, explore frames, and evaluate code when suspended.

After you have configured a run configuration for your project, you can launch it in debug mode by pressing Ctrl+D.

By default, the debugger will scan all the load paths and build path for .beam files and the corresponding modules will be interpreted which causes the Module's Erlang abstract code chunk to be interpreted in Erlang instead of the bytecode chunk being executed in the C parts of the BEAM. This interpretation is much slower than execution, so by default all of the Elixir standard library and the common modules installed in Phoenix projects are excluded from being interpreted when the debugger starts. The modules can be still be stepped into or have breakpoints explicitly set.

1. Preferences > Build, Execution, Deployment > Debugger > Stepping
2. Scroll to Elixir

You can customize these module patterns as an application setting.

1. Preferences > Build, Execution, Deployment > Debugger > Stepping
2. Scroll to Elixir
3. Click the Checkbox next to the pattern you want to disable
4. Click Apply to save or OK to save and close Preferences

1. Preferences > Build, Execution, Deployment > Debugger > Stepping
2. Scroll to Elixir
3. Click the pattern text box
4. Click Apply to save or OK to save and close Preferences

1. Preferences > Build, Execution, Deployment > Debugger > Stepping
2. Scroll to Elixir
3. Click the row of the pattern you want to remove
4. Click the "-" Remove button.
5. Click Apply to save or OK to save and close Preferences

1. Preferences > Build, Execution, Deployment > Debugger > Stepping
2. Scroll to Elixir
3. Click the "+" Add button
4. Click the default "*" pattern to edit it
5. Click Apply to save or OK to save and close Preferences

If you want to customize the modules to ignore on a per-Run-Configuration basis, you can set an environment variable in the Run Configuration.

Notice: If you want non Elixir. module in blacklist, write it with: :. This rule applies only to module atoms.

When a breakpoint is set, the editor displays a breakpoint icon in the gutter area to the left of the affected source code. A breakpoint icon denotes status of a breakpoint, and provides useful information about its type, location, and action.

The icons serve as convenient shortcuts for managing breakpoints. Clicking an icon removes the breakpoint. Successive use of Alt - click on an icon toggles its state between enabled and disabled. The settings of a breakpoint are shown in a tooltip when a mouse pointer hovers over a breakpoint icon in the gutter area of the editor.

Status	Icon	Description
Enabled		Indicates the debugger will stop at this line when the breakpoint is hit.
Disabled		Indicates that nothing happens when the breakpoint is hit.
Conditionally Disabled		This state is assigned to breakpoints when they depend on another breakpoint to be activated.

When the button is pressed in the toolbar of the Debug tool window, all the breakpoints in a project are muted, and their icons become grey: .

To view the list of all breakpoints and their properties, do one of the following:

• Run > View Breakpoints
• Shift+Cmd+F8
• Click the
• Breakpoints are visible in the Favorites tool window.

To view properties of a single breakpoint

• Right-Click a breakpoint icon in the left gutter of the editor.

To configure actions, suspend policy and dependencies of a breakpoint

1. Open the Breakpoint Properties
   • Right-click a breakpoint in the left gutter, then click the More link or press Shift+Cmd+F8
   • Open the Breakpoints dialog box and select the breakpoint from the list
   • In the Favorites tool window, select the desired breakpoint, and click the pencil icon.
2. Define the actions to be performed by IntelliJ IDEA on hitting breakpoint:
   • To notify about the reaching of a breakpoint with a text message in the debugging console, check the "Log message to console" check box. A message of the format *DBG* 'Elixir.IntellijElixir.DebugServer' got cast {breakpoint_reached, PID} will appear in the console.
   • To set a breakpoint the current one depends on, select it from the "Disabled until selected breakpoint hit" drop-down list. Once dependency has been set, the current breakpoint is disabled until selected one is hit.
     • Choose the "Disable again" radio button to disable the current breakpoint after selected breakpoint was hit.
     • Choose the "Leave enabled" radio button to keep the current breakpoint enabled after selected breakpoint was hit.
   • Enable suspending an application upon reaching a breakpoint by checking the "Suspend" check box.

A line breakpoint is a breakpoint assigned to a specific line in the source code.

Line breakpoints can be set on executable lines. Comments, declarations and empty lines are not valid locations for the line breakpoints. Line break points can be set in .ex and .eex files.

.eex line breaks will only work on Elixir code that is used in Phoenix view modules.

.eex breakpoints only work if a .beam file using the template's relative can be found. This means that the Phoenix view module .beam file must exist in _build prior to setting a breakpoint. Run the Run Configuration once, before debugging to complete the build if setting a breakpoint does not work.

1. Place the caret on the desired line of the source code.
2. Do one of the following:
   • Click the left gutter area at a line where you want to toggle a breakpoint
   • Run > Toggle Line Breakpoint
   • Cmd+F8

1. Open the Breakpoints dialog
2. Right-click the breakpoint you want to describe
3. Select "Edit description" from the context menu
4. In the "Edit Description" dialog box, type the desired description.

1. Open the Breakpoints dialog
2. Start typing the description of the desired breakpoint

• To view the selected breakpoint without closing the dialog box, use the preview pane.
• To open the file with the selected breakpoint for editing, double-click the desired breakpoint.
• To close Breakpoints dialog, press Cmd+Down. The caret will be placed at the line marked with the breakpoint in question.

When you temporarily disable or enable a breakpoint, its icon changes from to and vice versa.

1. Place the caret at the desired line with a breakpoint.
2. Do one of the following:
   • Run > Toggle Breakpoint Enable
   • Right-click the desired breakpoint icon, select or deselect the enabled check box, and then click Done.
   • Alt-click the breakpoint icon

Do one of the following:

• In the Breakpoints dialog box, select the desired line breakpoint, and click the red minus sign.
• In the editor, locate the line with the line breakpoint to be deleted, and click its icon in the left gutter.
• Place caret on the desired line and press Cmd+F8.

1. Select the run/debug configuration to execute
2. Do one of the following
   • Click on the toolbar
   • Run > Debug
   • Ctrl+D

OR

Debug quick menu

1. Ctrl+Alt+D
2. Select the configuration from the pop-up menu
3. Hit Enter

It takes awhile, once the debugged process is started to configure the debugger in BEAM. To ensure that breakpoints are setup before allow the debugged code to run, the debugger blocks until setup is complete.

1. The debugged process will wait for the debugger to attach

   

2. Breakpoints will be set

3. The debugger will mark modules to be interpreted

   1. The code paths will be scanned for .beam files
      • Code paths from the Elixir SDK will be skipped
      • .beam files will be interpreted unless they match the Module Filter Pattern

4. The debugger attaches (so it can receive breakpoint events) and allows the debugged process to continue.

• Press Up or Down to change frames
• Click the stack_frame from the list

When changing frames or jumping to definitions, you can lose track of where the debugger is paused. To get back to the current execution point, do one of the following:

1. Run > Show Execution Point.
2. Alt+F10
3. Click on the stepping toolbar of the Debug tool window.

Binaries show each byte at the byte's offset.

Bitstrings show each byte with any partial byte annotated with its bitwidth.

Boolean variables are rendered as their value.

Charlists show the integer values because they're treated as lists

Functions don't have literal representation, so the inspect form starting with #Fun<...> is shown

Lists render differently based on whether the list is improper or not. Improper lists show the head and tail while proper lists show their element by offset.

Maps render differently based on the key type. If the map uses all atom keys, the key will equal the value in the nested children while non-atom keys are shown as entries at a specific offset with the key and value. This is done, so that complex keys that have subterms can be expanded or collapsed, which is not possible for the simpler atom rendering.

Floats and integers are rendered as literals.

Pids are broken up into their hidden node, id, and serial`.

Strings show their literal value and unicode is fully supported.

Tuples show their elements at their offsets.

While Elixir allows rebinding variable names, Erlang does not, so when viewed in the Variables pane, rebound variables will have an @VERSION after their name indicating which rebinding of a the variable is.

When stopped at a breakpoint, you can use the Evaluate button (it looks like a simple pocket calculator) to open an editor to type code to be executed in the current stack frame.

The evaluator supports the full syntax.

The result of evaluating the code with be shown as the value of result below the entered "Expression".

Errors in the code will report back as a result tuple with an :EXIT tag. This reflects that the error has crashed the process that was evaluating the code. Thankfully, due to how how the interpreter is written, this does not lose the current stack frame and stepping or other evaluation can continue.

Action	Icon	Shortcut	Description
Show Execution Point		Alt+F10	Click this button to highlight the current execution point in the editor and show the corresponding stack frame in the Frames pane.
Step Over		F8	Click this button to execute the program until the next line in the current function or file, skipping the function referenced at the current execution point (if any). If the current line is the last one in the function, execution steps to the line executed right after this function.
Step Into		F7	Click this button to have the debugger step into the function called at the current execution point.
Step Out		Shift+F8	Click this button to have the debugger step out of the current function, to the line executed right after it.

The right-delimiter will be automatically inserted when the left delimiter is typed. In some cases, to prevent false positives, the the delimiter is only completed if when used for sigils.

All delimiters that are auto-inserted are also matched for highlighting

1. Analyze > Run Inspection by Name... (⌥⇧⌘I)
2. Type "Dialyzer"
3. Select "Dialyzer based inspections (Elixir)" from the shortened list
4. Hit Enter.

You'll be presented with a "Run 'Dialyzer based inspections (Elixir)'" dialog

1. Change the scope if you want.
2. Click "OK"

The Inspections Result Tool Pane will open and show results as each file is processed.

1. Click the ▶ to expand the Credo section to show all warnings

   

2. Click an entry for the details of an individual warning with a code highlighting.

   

Any file with .eex as the final extension will be treated as Embedded Elixir (EEx) templates. To determine the Template Data Language, the .eex extension will be stripped and any remaining extension will be looked up to get the File Type and its associated Language. For example, *.txt.eex will be EEx with Plain Text (.txt) as the Data Template Language. Likewise, *.html.eex will be EEx with HTML as the Data Template Language. There's no need to register *.txt.eex or *.html.eex or any other *.DATA_TEMPLATE_LANGUAGE_EXTENSION.eex pattern explicitly: the nested extension will be looked up using the normal extension setup.

If you need more file-by-file configuration of the Template Data Language than can be achieved with a file extension/pattern, IntelliJ IDEA (Community or Ultimate Edition) has support for setting the Template Data Language on a specific path.

1. Preferences > Languages and Frameworks > Template Data Languages

See JetBrains Documentation for more details.

Any file with .leex as the final extension will be treated as Live Embedded Elixir (LEEx) templates. To determine the Template Data Language, the .leex extension will be stripped and any remaining extension will be looked up to get the File Type and its associated Language. For example, *.txt.leex will be EEx with Plain Text (.txt) as the Data Template Language. Likewise, *.html.leex will be EEx with HTML as the Data Template Language. There's no need to register *.txt.leex or *.html.leex or any other *.DATA_TEMPLATE_LANGUAGE_EXTENSION.leex pattern explicitly: the nested extension will be looked up using the normal extension setup.

If you need more file-by-file configuration of the Template Data Language than can be achieved with a file extension/pattern, IntelliJ IDEA (Community or Ultimate Edition) has support for setting the Template Data Language on a specific path.

1. Preferences > Languages and Frameworks > Template Data Languages

See JetBrains Documentation for more details.

• Compile project with mix (use mix compile instead of elixirc directly)
• Attach docs (don't use --no-docs elixirc flag)
• Attach debug info (don't use --no-debug-info elixirc flag)
• Warnings as errors (use --warnings-as-errors elixirc flag)
• Ignore module conflict (use --ignore-module-conflict elixirc flag)

If a file has errors and warnings, they are group together in Build Messages under that file.

You can jump to errors and warnings in the Build Messages

1. Highlight the error or warning you want to jump to source

2. Do one of the following

   1. Right-Click the error or warning

   2. Select Jump to Source from the context menu

      

   OR

   1. Click the error or warning
   2. Press Cmd+Down

You can also turn on Autoscroll to Source, which will Jump To Source whenever you Click or select an error or warning.

If you enable Warnings as Errors in the settings, then the Warnings will be treated as Errors by elixirc and mix and the Build Messages will show the Warnings as Errors.

If only warnings remain in the source.

With Warnings as Errors On, all the Warnings will appear as Errors and still fail the build

With Warnings as Errors Off, the Warnings will appear as Warnings and the build will succeed

1. Have a file selected in Project view with the Project view in focus OR have an Editor tab in focus
2. Build > Compile 'FILE_NAME'
3. Build results will be shown
   • If compilation is successful, you'll see "Compilation completed successfully" in the Event Log
   • If compilation had errors, you'll see "Compilation completed with N errors and M warnings" in the Event Log and the Messages Compile tab will open showing a list of Errors

1. Build > Build Project
2. Build results will be shown
   • If compilation is successful, you'll see "Compilation completed successfully" in the Event Log
   • If compilation had errors, you'll see "Compilation completed with N errors and M warnings" in the Event Log and the Messages Compile tab will open showing a list of Errors

Live Templates are snippets of code that can be inserted quickly and have placeholder locations that the cursor will automatically jump to when using the template. Whenever you start typing, Live Templates will start matching against the shortcuts. A template can be selected with Tab.

Live Templates can be customized in Preferences > Editor > Live Templates > Elixir.

@doc """
ONE
"""
END

case ONE do
  TWO -> END
end

cond do
  END
end

def NAME do
  END
end

def NAME, do: END

defimpl PROTOCOL, for: TYPE do
  END
end

defmodule ALIAS do
  END
end

defmacro MACRO_NAME do
  END
end

defmacrop MACRO_NAME do
  END
end

defoverridable [NAME: END]

defp NAME do
  END
end

defprotocol PROTOCOL do
  END
end

defstruct [END]

do
  END
end

@doc """
ONE
"""
END

fn ARGS -> END end

for A <- B do
  END
end

if TRUE do
  END
end

if TRUE do
  OK
else
  END
end

IO.inspect(END)

@moduledoc """
ONE
"""
END

receive do
  ONE -> END
end

test "TESTDESC" do
  END
end

try do
  ONE
rescue
  TWO -> END

Documentation in @moduledoc, @typedoc or @doc module attribute values are marked as Markdown language, so that the JetBrains supplied Markdown support works in documentation.

Code in code blocks (indented 4 spaces) are marked as Elixir language, so all the normal language support works in code examples and doctests.

This includes highlighting reads and writes of variables


and Go To Definition for calls


1. Start with the Editor
2. Click the "Toggle Rendered View" button in the gutter next to the editor.
3. Rendered View will be shown 

Markdown documentation in @moduledoc, @typedoc or @doc can be toggled back and forth from the editable Markdown view and the rendered HTML view.

In the rendered view, aliases are clickable and navigatable.

Clicking the links will show the documentation for module.


Using Go To Definition (Cmd+Click) on the link will take you to the module definition.


1. Start with the Rendered View 
2. Click the "Toggle Rendered View" button in the gutter next to the editor. 
3. Editor will be shown

You can get documentation for functions and macros that have a @doc, aliases of modules that have a @moduledoc or types that have a @typedoc in a pop-up using Quick Documentation.

1. Place the cursor over the name of callback being referneced.

2. Display the documentation with either:

   • A keyboard shortcut: F1 to show rendered @doc
   • From the menu: View > Quick Documentation

   

1. Place the cursor over the name of function being called.
2. Display the documentation with either:
   • A keyboard shortcut: F1 to show rendered @doc
   • From the menu: View > Quick Documentation

1. Place the cursor on a fully-qualified module name
2. Display the documentation with either:
   • A keyboard shortcut: F1 to show rendered @moduledoc
   • From the menu: View > Quick Documentation

1. Place the cursor over the name of a type being used.

2. Display the documentation with either:

   • A keyboard shortcut: F1 to show rendered @typedoc
   • From the menu: View > Quick Documentation

   

Distillery's mix release produces a CLI for running the release.

1. Build the release: mix release

   ==> Release successfully built!
       You can run it in one of the following ways:
         Interactive: _build/ENV/rel/NAME/bin/NAME console
         Foreground: _build/ENV/rel/NAME/bin/NAME foreground
         Daemon: _build/ENV/rel/NAME/bin/NAME start

2. Run > Edit Configurations...

   

3. Click +

4. Select "Distillery Release CLI"

   

5. Fill in the "Release CLI Path" with the full path to the _build/ENV/rel/NAME/bin/NAME path produed by mix release above.

6. Fill in the "Release CLI arguments".

   • console runs a shell with the release loaded similar to iex -S mix.
   • foreground to runs the release without a shell, like mix or mix run. The available commands are controlled by your release config rel/config.exs that Distillery uses.

7. (Optionally) fill in "erl arguments" with arguments to erl before it runs elixir. This is the same as the ERL_OPTS environment variable supported by Distillery.

8. (Optionally) fill in "elixir -extra arguments" with arguments to pass to elixir before it run the release. This is the same as the EXTRA_OPTS environment variable supported by Distillery.

9. (Optionally) change the Code Loading Mode This is the same as the CODE_LOADING_MODE environment variable supported by Distillery.

   • Use Default - use whatever is configured in rel/config.exs. Don't set CODE_LOADING_MODE environment variable.
   • embedded - load all code immediately on boot. Set CODE_LOADING_MODE=embedded.
   • interactive - load code on-demand as it is needed/referenced. Set CODE_LOADING_MODE=interactive.

10. (Optionally) set the "Log Directory" This is the same as the RUNNER_LOG_DIR environment variable supported by Distillery.

11. (Optionally) change "Replace OS Vars" This is the same as the REPLACE_OS_VARS environment variable supported by Distillery.

    • Use Default - use whatever is configured in rel/config.exs. Don't set REPLACE_OS_VARS environment variable.
    • false - don't replace "${A_VAR_NAME}" in the generated configuration with A_VAR environment variable at runtime. Set REPLACE_OS_VARS=false.
    • true - replace "${A_VAR_NAME}" in the generated configuration with A_VAR environment variable at runtime. Set REPLACE_OS_VARS=true.

12. (Optionally) set "sys.config File" This is the same the SYS_CONFIG_PATH environment variable supported by Distillery.

13. (Optionally) set "Release Config Directory". This is the same as the RELEASE_CONFIG_DIR environment variable supported by Distillery.

14. (Optionally) set "Pipe directory". This is the same as the PIPE_DIR environment variable supported by Distillery.

15. (Optionally) set "Use Pseudo-terminal (PTY). If checked use PTY for interactive shells. Automatically on when "Release CLI Arguments" starts with one of the known interactive commands (attach, console, console_boot, console_clean, or remote_console).

16. Fill in the "Working directory.

    • Type the absolute path to the directory.
    • Select the path using directory picker by clicking the ... button

17. (Optionally) click the ... button on the "Environment variables" line to add environment variables.

18. Click "OK" to save the Run Configuration and close the dialog

1. Click the Run Arrow in the Toolbar to run the _build/ENV/rel/NAME/bin/NAME
2. The Run pane will open
   • If the either "Use Pseduo-terminal (PTY)" is checked of the "Release CLI Arguments" are known to need a PTY, an interactive shell will appear in the Run pane where you can enter iex commands.
   • Otherwise, the output of running the command will be shown.

1. (Optionally) before debugging, customize the modules that will be interpreted.
   1. Run > Edit Configurations...
   2. Click the "Interpreted Modules" tab next to default "Configuration" tab.
   3. Enable/Disable "Inherit Application Module Filters". Will change the Module Filters show in the below "Do not interpreter modules matching patterns" list.
   4. Uncheck any inherited module filters that you would rather be interpreted and therefore debuggable
   5. Click + to add module filters that are specific to this configuration. This can be useful if you know interpreting a specific module in your project's dependencies or project leads to too much slowdown when debugging or causes the debugger to hang/crash.
   6. Click - to remove configuration-specific module filters added with +. Inherited module filters cannot be removed with -, they can only be disabled by unchecking.
2. Add the :debugger application to your release
   1. Open rel/config.exs
   2. In the release NAME block, in the set :applications block add :debugger:

      --- a/rel/config.exs
      +++ b/rel/config.exs
      @@ -41,6 +41,8 @@ end
       release :intellij_elixir do
         set version: current_version(:intellij_elixir)
         set applications: [
      +    # needed for IntelliJ Elixir debugger
      +    :debugger,
           :runtime_tools
         ]
       end

3. For how to use the debugger, including how to set breakpoints see the Debugger section.
4. Click the Debug bug in the Toolbar to debug the mix tests

Although it is exceedingly rare, as most Elixir projects use mix, it is supported to run/debug elixir directly, such as when doing elixir script.exs.

1. Run > Edit Configuations...

   

2. Click +

3. Select "Elixir"

   

4. Fill in the "elixir arguments".

5. (Optionally) fill in "erl arguments" with arguments to erl before it runs elixir.

6. Fill in the "Working directory"

• Type the absolute path to the directory.
• Select the path using directory picker by clicking the ... button

7. (Optionally) click the ... button on the "Environment variables" line to add environment variables.
8. Click "OK" to save the Run Configuration and close the dialog

With the Run Configuration defined, you can either Run or Debug elixir

1. Click the Run arrow in the Toolbar to run elixir.

   

2. The Run pane will open, showing the results of elixir.

1. (Optionally) before debugging, customize the modules that will be interpreted.
   1. Run > Edit Configurations...
   2. Click the "Interpreted Modules" tab next to default "Configuration" tab.
   3. Enable/Disable "Inherit Application Module Filters". Will change the Module Filters show in the below "Do not interpreter modules matching patterns" list.
   4. Uncheck any inherited module filters that you would rather be interpreted and therefore debuggable
   5. Click + to add module filters that are specific to this configuration. This can be useful if you know interpreting a specific module in your project's dependencies or project leads to too much slowdown when debugging or causes the debugger to hang/crash.
   6. Click - to remove configuration-specific module filters added with +. Inherited module filters cannot be removed with -, they can only be disabled by unchecking.
2. For how to use the debugger, including how to set breakpoints see the Debugger section.
3. Click the Debug bug in the Toolbar to debug elixir

iex run configurations allow you to run iex with IntelliJ Elixir attached. It is most useful when debugging, but it also allows you save customizations in the configuration when it is more complicated than just iex.

1. Run > Edit Configurations...

   

2. Click +

3. Select "IEx"

   

4. (Optionally) fill in "iex arguments" with arguments to iex.

5. (Optionally) full in "erl arguments" with arguments to erl before it runs iex.

6. Fill in the "Working directory"

• Type the absolute path to the directory.
• Select the path using directory picker by clicking the ... button

7. (Optionally) click the ... button on the "Environment variables" line to add environment variables.
8. Click "OK" to save the Run Configuration and close the dialog

With the Run Configuration defined, you can either Run or Debug the iex configuration.

1. Click the Run arrow in the Toolbar to run iex

   

1. (Optionally) before debugging, customize the modules that will be interpreted.
   1. Run > Edit Configurations...
   2. Click the "Interpreted Modules" tab next to default "Configuration" tab.
   3. Enable/Disable "Inherit Application Module Filters". Will change the Module Filters show in the below "Do not interpreter modules matching patterns" list.
   4. Uncheck any inherited module filters that you would rather be interpreted and therefore debuggable
   5. Click + to add module filters that are specific to this configuration. This can be useful if you know interpreting a specific module in your project's dependencies or project leads to too much slowdown when debugging or causes the debugger to hang/crash.
   6. Click - to remove configuration-specific module filters added with +. Inherited module filters cannot be removed with -, they can only be disabled by unchecking.
2. For how to use the debugger, including how to set breakpoints see the Debugger section.
3. Click the Debug bug in the Toolbar to debug iex.

Much like rake tasks in Rubymine, this plugin can run mix tasks.

1. Run > Edit Configurations...

   

2. Click +

3. Select "Elixir Mix"

   

4. Fill in the "mix arguments" starting with the name of the mix task followed by any arguments to that task.

5. (Optionally) fill in "elixir arguments" with arguments to elixir before it runs mix.

6. (Optionally) fill in "erl arguments" with arguments to erl before it runs elixir.

7. Fill in the "Working directory"

• Type the absolute path to the directory.
• Select the path using directory picker by clicking the ... button

8. (Optionally) click the ... button on the "Environment variables" line to add environment variables.
9. Click "OK" to save the Run Configuration and close the dialog

With the Run Configuration defined, you can either Run or Debug the Mix Task

1. Click the Run arrow in the Toolbar to run the mix task

   

2. The Run pane will open, showing the results of the mix task.

   • If there is an error with a FILE:LINE stack stack_frame, it will be a clickable link that will take you to that location

     

1. (Optionally) before debugging, customize the modules that will be interpreted.
   1. Run > Edit Configurations...
   2. Click the "Interpreted Modules" tab next to default "Configuration" tab.
   3. Enable/Disable "Inherit Application Module Filters". Will change the Module Filters show in the below "Do not interpreter modules matching patterns" list.
   4. Uncheck any inherited module filters that you would rather be interpreted and therefore debuggable
   5. Click + to add module filters that are specific to this configuration. This can be useful if you know interpreting a specific module in your project's dependencies or project leads to too much slowdown when debugging or causes the debugger to hang/crash.
   6. Click - to remove configuration-specific module filters added with +. Inherited module filters cannot be removed with -, they can only be disabled by unchecking.
2. For how to use the debugger, including how to set breakpoints see the Debugger section.
3. Click the Debug bug in the Toolbar to debug the mix task

If you want to run iex in the context of the project, you need to run iex -S mix, but if you don't want to have to worry about forgetting whether it's -s or -S or if it is mix -S iex or iex -S mix, you can use an IEx Mix configuration.

1. Run > Edit Configurations...

   

2. Click +

3. Select "IEx Mix"

   

4. (Optionally) fill in "mix arguments", such as phx.server if you want to launch Phoenix inside of iex.

5. (Optionally) fill in "iex arguments" with arguments to iex before -S mix.

6. (Optionally) full in "erl arguments" with arguments to erl before it runs iex.

7. Fill in the "Working directory"

• Type the absolute path to the directory.
• Select the path using directory picker by clicking the ... button

8. (Optionally) click the ... button on the "Environment variables" line to add environment variables.
9. Click "OK" to save the Run Configuration and close the dialog

Wih the Run Configuration defined, you can either Run or Debug iex -S mix

1. Click the Run Arrow in the Toolbar to run iex -S mix

1. (Optionally) before debugging, customize the modules that will be interpreted.
   1. Run > Edit Configurations...
   2. Click the "Interpreted Modules" tab next to default "Configuration" tab.
   3. Enable/Disable "Inherit Application Module Filters". Will change the Module Filters show in the below "Do not interpreter modules matching patterns" list.
   4. Uncheck any inherited module filters that you would rather be interpreted and therefore debuggable
   5. Click + to add module filters that are specific to this configuration. This can be useful if you know interpreting a specific module in your project's dependencies or project leads to too much slowdown when debugging or causes the debugger to hang/crash.
   6. Click - to remove configuration-specific module filters added with +. Inherited module filters cannot be removed with -, they can only be disabled by unchecking.
2. For how to use the debugger, including how to set breakpoints see the Debugger section.
3. Click the Debug bug in the Toolbar to debug iex -S mix.

The mix espec task gets a special type of Run Configuration, Elixir Mix Espec. Using this Run Configuration type instead, of the basic Elixir Mix Run Configuration will cause the IDE to attach a special formatter to mix espec, so that you get the standard graphical tree of Test Results.

The Run pane will show Test Results. If there is a compilation error before or during mix espec, it will be shown as a test failure. If the compilation failure is in a _spec.exs file can it can be inferred from the stacktrace, the compilation error will show up as a test failure in that specific module.

If you override the default formatters you will need to add the following code to your spec_helper.exs.

If you override formatters similar to below

ESpec.configure fn(config) ->
  config.formatters ...

ESpec.configure fn(config) ->
  config.formatters [
      {ESpec.Formatters.Json, %{out_path: "results.json"}},
      {ESpec.Formatters.Html, %{out_path: "results.html"}},
      {ESpec.Formatters.Doc, %{details: true, out_path: "results.txt"}},
      {ESpec.Formatters.Doc, %{details: true, diff_enabled?: false, out_path: "results-no-diff.txt"}},
      {ESpec.CustomFormatter, %{a: 1, b: 2}},
    ]
end

Replace them with code that checks for the graphical formatter TeamCityESpecFormatter and uses only it when available.

ESpec.configure fn(config) ->
  config.formatters(if Code.ensure_loaded?(TeamCityESpecFormatter) do
    [{TeamCityESpecFormatter, %{}}]
  else
    ...
  end)
end

ESpec.configure fn(config) ->
  config.formatters(if Code.ensure_loaded?(TeamCityESpecFormatter) do
    [{TeamCityESpecFormatter, %{}}]
  else
    [
      {ESpec.Formatters.Json, %{out_path: "results.json"}},
      {ESpec.Formatters.Html, %{out_path: "results.html"}},
      {ESpec.Formatters.Doc, %{details: true, out_path: "results.txt"}},
      {ESpec.Formatters.Doc, %{details: true, diff_enabled?: false, out_path: "results-no-diff.txt"}},
      {ESpec.CustomFormatter, %{a: 1, b: 2}},
    ]
  end)
end

1. Run > Edit Configurations...

   

2. Click +

3. Select "Elixir Mix ESpec"

   

4. Fill in the "mix espec arguments" with the argument(s) to pass to mix espec. Normally, this will be list of *_spec.exs files, relative to the "Working directory".

   NOTE: Unlike mix test, mix espec does not support directories as arguments.

5. (Optionally) fill in "elixir arguments" with the arguments to elixir before it runs mix test.

6. (Optionally) fill in "erl arguments"with the arguments toerlbefore it runselixir`.

7. Fill in the "Working directory"

   • Type the absolute path to the directory.
   • Select the path using directory picker by clicking the ... button

8. (Optionally) click the ... button on the "Environment variables" line to add environment variables.

9. Click "OK" to save the Run Configuration and close the dialog

With the Run Configuration defined you can either Run or Debug the mix especs

1. Click the Run arrow in the Toolbar to run the mix test task
2. The Run pane will open showing the Test Results

1. (Optionally) before debugging, customize the modules that will be interpreted.
   1. Run > Edit Configurations...
   2. Click the "Interpreted Modules" tab next to default "Configuration" tab.
   3. Enable/Disable "Inherit Application Module Filters". Will change the Module Filters show in the below "Do not interpreter modules matching patterns" list.
   4. Uncheck any inherited module filters that you would rather be interpreted and therefore debuggable
   5. Click + to add module filters that are specific to this configuration. This can be useful if you know interpreting a specific module in your project's dependencies or project leads to too much slowdown when debugging or causes the debugger to hang/crash.
   6. Click - to remove configuration-specific module filters added with +. Inherited module filters cannot be removed with -, they can only be disabled by unchecking.
2. For how to use the debugger, including how to set breakpoints see the Debugger section.
3. Click the Debug bug in the Toolbar to debug the mix tests

While you can create Elixir Mix ESpec run configurations manually using the Run > Edit Configurations... menu, it is probably more convenient to use the context menu.

The context menu must know that the the directory, file, or line you are right-clicking is a test. It does this by checking if the current directory or an ancestor is marked as a Test Sources Root and contains or is a *_spec.exs file(s)

1. In the Project pane, ensure your OTP application's espec directory is marked as a Test Sources Root
2. Check if the espec directory is green. If it is, it is likely a Test Sources Root. This color may differ in different themes, so to be sure you can check the context menu
3. Right-click the test directory.
4. Hover over "Mark Directory As >"

   • If "Unmark as Test Sources Root" is shown, then the directory is already configured correctly, and create from context will work.

     

   • If "Test Sources Root" is shown, then the directory need to be configured by clicking that entry

     

1. Right-click the directory in the Project pane

2. Click "Run Mix ExUnit", which will both create the Run Configuration and Run it.

   

   • If you want to only create the Run Configuration, select "Create Mix ESpec" instead

Alternatively, you can use keyboard shortcuts

1. Select the directory in the Project pane.
2. Ctrl+Shift+R will create the Run Configuration and Run it.

1. Right-click the file in the Project pane
2. Click "Run Mix ESpec", which will both create the Run Configuration and Run it.
   • If you want to only create the Run Configuration, select "Create Mix ESpec" instead

Alternatively, you can use keyboard shortcuts

1. Select the directory in the Project pane.
2. Ctrl+Shift+R will create the Run Configuration and Run it.

Finally, you can use the editor tabs

1. Right-click the editor tab for the test file you want to run

   

2. Click "Run Mix ESpec", which will both create the Run Configuration and Run it.

   • If you want to only create the Run Configuration, select "Create Mix ESpec" instead

If you want to be able to run a single test, you can create a Run Configuration for a line in that test

1. Right-click a line in the test file

   

2. Click "Run Mix ESpec", which will both create the Run Configuration and Run it.

   • If you want to only create the Run Configuration, select "Create Mix ESpec" instead

Alternatively, you can use keyboard shortcuts

1. Place the cursor on the line you want to test
2. Ctrl+Shift+R will create the Run Configuration and Run it.

The mix test task gets a special type of Run Configuration, Elixir Mix ExUnit. Using this Run Configuration type instead, of the basic Elixir Mix Run Configuration will cause the IDE to attach a special formatter to mix test, so that you get the standard graphical tree of Test Results

The Run pane will show Test Results. If there is a compilation error before or during mix test, it will be shown as a test failure. If the compilation failure is in a _test.exs file can it can be inferred from the stacktrace, the compilation error will show up as a test failure in that specific module.

doctest names are rearranged to emphasize the function being tested: "test doc at MODULE.FUNCTION/ARITY (COUNT)" becomes "MODULE.FUNCTION/ARITY doc (COUNT)". If MODULE is the same as the test case without the Test suffix, then MODULE is stripped too and the test name becomes only FUNCTION/ARITY doc (COUNT).

1. Run > Edit Configurations...

   

2. Click +

3. Select "Elixir Mix ExUnit"

   

4. Fill in the "mix test arguments" with the argument(s) to pass to mix test. Normally, this will be a directory like test, relative to the "Working directory"

5. (Optionally) fill in "elixir arguments" with the arguments to elixir before it runs mix test.

6. (Optionally) fill in "erl arguments"with the arguments toerlbefore it runselixir`.

7. Fill in the "Working directory"

   • Type the absolute path to the directory.
   • Select the path using directory picker by clicking the ... button

8. (Optionally) click the ... button on the "Environment variables" line to add environment variables.

9. Click "OK" to save the Run Configuration and close the dialog

With the Run Configuration defined you can either Run or Debug the mix tests

1. Click the Run arrow in the Toolbar to run the mix test task
2. The Run pane will open showing the Test Results

1. (Optionally) before debugging, customize the modules that will be interpreted.
   1. Run > Edit Configurations...
   2. Click the "Interpreted Modules" tab next to default "Configuration" tab.
   3. Enable/Disable "Inherit Application Module Filters". Will change the Module Filters show in the below "Do not interpreter modules matching patterns" list.
   4. Uncheck any inherited module filters that you would rather be interpreted and therefore debuggable
   5. Click + to add module filters that are specific to this configuration. This can be useful if you know interpreting a specific module in your project's dependencies or project leads to too much slowdown when debugging or causes the debugger to hang/crash.
   6. Click - to remove configuration-specific module filters added with +. Inherited module filters cannot be removed with -, they can only be disabled by unchecking.
2. For how to use the debugger, including how to set breakpoints see the Debugger section.
3. Click the Debug bug in the Toolbar to debug the mix tests

While you can create Elixir Mix ExUnit run configurations manually using the Run > Edit Configurations... menu, it is probably more convenient to use the context menu.

The context menu must know that the the directory, file, or line you are right-clicking is a test. It does this by checking if the current directory or an ancestor is marked as a Test Sources Root.

1. In the Project pane, ensure your OTP application's test directory is marked as a Test Sources Root
2. Check if the test directory is green. If it is, it is likely a Test Sources Root. This color may differ in different themes, so to be sure you can check the context menu
3. Right-click the test directory.
4. Hover over "Mark Directory As >"

   • If "Unmark as Test Sources Root" is shown, then the directory is already configured correctly, and create from context will work.

     

   • If "Test Sources Root" is shown, then the directory need to be configured by clicking that entry

     

1. Right-click the directory in the Project pane

2. Click "Run Mix ExUnit", which will both create the Run Configuration and Run it.

   

   • If you want to only create the Run Configuration, select "Create Mix ExUnit" instead

Alternatively, you can use keyboard shortcuts

1. Select the directory in the Project pane.
2. Ctrl+Shift+R will create the Run Configuration and Run it.

1. Right-click the file in the Project pane
2. Click "Run Mix ExUnit", which will both create the Run Configuration and Run it.
   • If you want to only create the Run Configuration, select "Create Mix ExUnit" instead

Alternatively, you can use keyboard shortcuts

1. Select the directory in the Project pane.
2. Ctrl+Shift+R will create the Run Configuration and Run it.

Finally, you can use the editor tabs

1. Right-click the editor tab for the test file you want to run

   

2. Click "Run Mix ExUnit", which will both create the Run Configuration and Run it.

   • If you want to only create the Run Configuration, select "Create Mix ExUnit" instead

If you want to be able to run a single test, you can create a Run Configuration for a line in that test

1. Right-click a line in the test file

   

2. Click "Run Mix ExUnit", which will both create the Run Configuration and Run it.

   • If you want to only create the Run Configuration, select "Create Mix ExUnit" instead

Alternatively, you can use keyboard shortcuts

1. Place the cursor on the line you want to test
2. Ctrl+Shift+R will create the Run Configuration and Run it.

.beam files are the compiled version of modules on the BEAM virtual machine used by Elixir and Erlang. They are the equivalent of .class files in Java.

.beam files are not detected purely by their file extension: the BEAM file format starts with a magic number, FOR1, that is checked for before decompiling.

.beam files have 2 editors registered: decompiled Text and BEAM Chunks

If the .beam module was compiled with the compressed compiler directive, which in Erlang looks like

-compile([compressed])

and in Elixir looks like

@compile [:compressed]

then the outer file format is GZip (which is detected by checking for the gzip magic number, 1f 8b, at the start of the file) and the .beam will be (stream) decompressed before the .beam header is checked and the chunks decoded.

.beam files are composed of binary chunks. Each chunk is formatted

This format is generically referred to as Type-Length-Value

The BEAM Chunks editor tab is subdivided into further tabs, one for each chunk in the .beam file.

The tabs are listed in the order that the chunks occur in the .beam file.

The Atom chunk holds LATIN-1 encoded atoms while AtU8 chunk holds UTF-8 atoms. There will only be one of these atom-related chunks in any given .beam file. AtU8 is used in newer versions of OTP that support UTF-8 atoms. AtU8 was introduced in OTP 20.

The Atom/AtU8 tab shows a table with the columns

The Attr chunk holds the module attributes, but only those that are persisted. Erlang module attributes are persisted by default, but in Elixir module attributes need to be marked as persisted with Module.register_attribute/3

The Attr chunk uses External Term Format (term_to_binary's output) to encode a proplist, which is similar to, but not quite the same an Elixir Keyword list

All modules will have a :vsn attribute that is either set explicitly or defaults to the MD5 of the module.

The Attr tab shows a table with the columns

The CInf chunk is the Compilation Information for the Erlang or Erlang Core compiler. Even Elixir modules have it because Elixir code passes through this part of the Erlang Core compiler

The CInf chunk uses External Term Format (term_to_binary's output) to encode a proplist, which is similar to, but not quite the same an Elixir Keyword list

The CInf tab shows a table with the columns

The Code chunk contains the byte code for the module.

It is encoded in BEAM Compact Term Encoding, which differs from the binary format produced by term_to_binary.

The Code tab shows a read-only editor with one byte code operation on each line. For ease of reading, operations are grouped by function and then label block with indentation indicating scope.

By default as many references to other chunks and references to other parts of Code chunk are inlined to ease understanding. If you want to see the raw byte code operations, you can turn off the various inliners.

####### Controls

If any of the inliners are incorrect or you have an argument name that makes more sense, please open an issue.

The Dbgi chunk contains Debug Info. It was introduced in OTP 20 as a replacement for the Abst chunk. While the Abst chunk was required to contain the Erlang AST, the Dbgi format can contain the debug info for other languages, such as Elixir quoted form AST.

Because the format is language neutral, the format is a set of nested, versioned formats. The outer most layer is

{:debug_info_v1, backend, metadata | :none}

For :debug_info_v1, Elixir's backend is :elixir_erl. The metadata for :elixir_erl is further versioned: {:elixir_v1, map, specs}.

map contains the bulk of the data.

The Dbgi tab appearance varies based on whether it was created with Erlang or Elixir, reflecting the fact that the Dbgi format is dependent on the backend that wrote it.

####### Elixir (:elixir_erl backend)

The Dbgi tab show the single value map entries: :file, :line, and :module.

For the multi-value keys: :attributes, :compile_opts, and :definitions, there are individual tabs.

######## Attributes

The Attributes tab has the same format as the Attrs chunk.

######## Compile Options

The Compile Options tab is usually empty, much like the CInf options key for Erlang.

######## Definitions

The Definitions tab is split between a tree of Module, Function/Arity and clauses.

Clicking on a clause will show only that clause, but clicking on a higher level in the tree will show all clauses in the function or the entire Module.

The AST stored in the definitions tab and the process of converting it back to code is not format preserves, so it will not look precisely like the source code as the AST has undergone some macro expansion before its put in the Dbgi chunk. As common idioms are understood, reversals will be add to the renderer.

######## Type Specifications

The Type Specifications tab is split between a tree of the Module, Module Attribute, and type specifications.

Clicking on a type specification will show only that type specification, but clicking on a higher in the tree will show all type specifications for the same module attribute or the entire Module.

####### Erlang (:erlang_abstract_code backend)

The Dbgi tab has Abstract Code and Compile Options tabs.

######## Abstract Code

The Abstract Code tab is split between a tree of Attributes, Functions, Function/Arity, and clauses.

Clicking on a clause will show only that clause, but clicking on a higher level in the tree will show all clauses in the function or the entire Module.

The abstract code stored in the :erlang_abstract_code backend format is the Erlang Abstract Format. Instead of converting the Erlang Abstract Format back to Erlang, which would require IntelliJ Erlang to highlight and annotate and for you to be used to reading Erlang, the Erlang Abstract Format is translated back to Elixir. Using the BEAM Chunk Dbgi viewer can be a way to convert compiled Erlang code to Elixir source automatically.

The ExDc chunk stores ExDoc. Not the rendered HTML from the ex_doc package, but the the @doc, @moduledoc, and @typedoc attribute values that work even without ex_doc installed. This chunk is what is consulted when the h helper is used in iex.

The ExDc chunk is the encoded with term_to_binary. The term format is a versioned as {version, versioned_format}. The current version tag is :elixir_docs_v1 and the versioned_format is a Keyword.t with keys matching the Code.get_docs/2 tags :callback_docs, :docs, :moduledoc, and :type_docs keys.

Like Dbgi, the ExDc tab is split between a tree to navigate and an editor to show the decompiled value.

Click on a node in the tree will show all docs at that level and any descendants.

The ExpT chunk is the Export Table. The name "Export" derives from the Erlang module attribute -export, which is used to "export" functions from a module. It is the equivalent of making a function or macro public with def and defmacro as opposed to making it private with defp and defmacrop in Elixir.

The BEAM format and the ExpT chunk, being made for Erlang, has no concept of macros. It only understands functions, so Elixir macros, like __using__/1 called by use are compiled to plain Erlang functions with MACRO- prefixed to their name and an extra argument (the __CALLER__ environment) as the first argument, which increases the arity, yielding a full MFA of MACRO-__using__/2 as seen above.

The ExpT tab shows a table with the columns

The ImpT chunk is the Import Table. It DOES NOT encode just the Erlang -import attributes or Elixir import macro calls: it tracks any external function or macro called from another module. call_ext_* operations in the Code chunk don't store the Module and Function (MF) of the function they will call directly in the bytecode, instead, one of the arguments is an index into the ImpT chunk. This way, all external calls are normalized into the ImpT chunk instead of being denormalized to the call site. The arity still appears at the call site to help with checking the argument count.

You may notice that erlang.byte_size/1 is included in the table. This is because even BIFs are referenced by MFA and not a pre-assigned number as would be the case for system calls in operating systems like Linux. BEAM is like an Operation System, but not in all ways.

The ImpT tab shows a table with the columns

The LitT chunk contains literals loaded as arguments in Code chunk.

Confusingly, in the Code chunk sometimes the literal(N) term is used to encode integer N, an index into another chunk, or an actual index into the LitT. How literal terms are handled is completely dependent on the specific operation, so without having outside knowledge about the bytecode operation arguments for BEAM, the best way to figure out if literal terms are an integer or an index is to toggle the various controls in the Code tab to see if literal with no inlining turns into a LitT literal, FunT function reference, ImpT function reference, or integer.

The LitT tab shows a table with the columns

The Line chunk encodes both the file name and line number for each line(literal(n)) operation in the Code chunk. The n in line(literal(n)) is an index in to the Line References table in the Line chunk. This is used in Phoenix view modules to show where code from templates comes from.

The Line chunk is composed of 2 subsections: (1) Line References and (2) File Names. First there is a header setting up the number of each entry to expect.

####### Line References

This uses the Compact Term Format used for the Code chunk. The format ends up producing {file_name_index, line} pairs using the following algorithm:

####### File Names

The Line tab has one subtab for each subsection in the tab. Each subsection has its own table.

The LocT chunk is the dual to the ExpT chunk: it contains all private functions and macros.

You'll notice entries like -__struct__/1-fun-0-, starts with - and have a / suffix with fun in it. This naming scheme is used for anonymous functions such as those defined with fn or the capture operator (&) in Elixir. Much like how macros don't really exist and use a MACRO- suffix, anonymous functions/lambdas don't exist, and instead use a distinct naming scheme -<PARENT_FUNCTION>/*fun*. Unlike MACRO-, which is an Elixir invention, anonymous functions/lambdas really being local named functions with derived names is also done in pure Erlang modules. Erlang's anonymous functions are defined with fun, which is where the fun part of the naming scheme comes from.

The LocT tab shows a table with the columns

The StrT chunk contains all Erlang strings (that is, Elixir charlists) used in the Code chunk.

The StrT chunk contains a single contiguous pool. These strings are used for byte code operations like bs_put_string. Not all strings appear in StrT. Some strings, including most Elixir strings (Erlang binaries) appear in the LitT chunk that holds literals. I'm not sure how the compiler determines whether to use StrT or LitT. I think it all depends on the byte code operation.

Instead of encoding the start and length of each string in the chunk itself, the start and length for any given string is passed as arguments to the byte code operations in the Code chunk. By doing this, shared substrings can be efficiently encoded in StrT.

.beam files, such as those in the Elixir SDK, the Elixir SDK's Internal Erlang SDK, and in your project's build directory will be decompiled to equivalent def and defmacro calls. The bodies will not be decompiled, only the call definition head and placeholder parameters. These decompiled call definition heads are enough to allow Go To Declaration, the Structure pane, and Completion to work with the decompiled .beam files.

It turns out that in the .beam binary format there are no macros. This makes sense since the BEAM format was made for Erlang, which does not have macros, and only has functions. Elixir marks its macros in the compiled .beam by prefixing them with MACRO-.

There are 2 chunks in the BEAM format for function references: ExpT, which is for exports (because in Erlang module they are from -export), which are the public functions and macros; and LocT, which is for locals (anything not exported in Erlang), which are private functions and macros.

Much like there are no macros in BEAM, there are no anonymous functions either. Any anonymous function (using fn in Elixir or fun in Erlang) ends up being a named function in the LocT chunk. Anonymous functions names start with -, then the parent function's name, a / and a unique number for that scope.

As an example, Kernel has

defp unquote(:"-MACRO-binding/2-fun-0-")(p0, p1, p2, p3) do
  # body not decompiled
end

which is generated from the for in

 defmacro binding(context \\ nil) do
    in_match? = Macro.Env.in_match?(__CALLER__)
    for {v, c} <- __CALLER__.vars, c == context do
      {v, wrap_binding(in_match?, {v, [generated: true], c})}
    end
  end

-- Kernel.binding/1

Functions and macros can have names that aren't valid identifier names, so the decompiler has special handlers to detect these invalid identifiers and escape them to make decompiled code that is parsable as valid Elixir.

When you start typing an Alias, completion will look in three locations:

1. alias aliased names in the current file
   1. Suffix for alias Prefix.Suffix
   2. MultipleAliasA or MultipleAliasB for alias Prefix.{MultipleAliasA, MultipleAliasB}
   3. As for alias Prefix.Suffix, as: As
2. Indexed module names (as available from Go To Symbol)
   1. Prefix.Suffix from defmodule Prefix.Suffix
   2. MyProtocol from defprotocol MyProtocol
   3. MyProtocol.MyStruct
      1. defimpl MyProtocol, for: MyStruct
      2. defimpl MyProtocol nested under defmodule MyStruct
3. Nested modules under aliased names
   1. Suffix.Nested for alias Prefix.Suffix where Prefix.Suffix.Nested is an indexed module, implementation or protocol name.
   2. MultipleAliasA.Nested for alias Prefix.{MultipleAliasA, MultipleAliasB} where Prefix.MultipleAliasA.Nested alias Prefix.{MultipleAliasA, MultipleAliasB} is an indexed module, implementation or protocol name.
   3. As.Nested for alias Prefix.Suffix, as: As where Prefix.Suffix.Nested is an indexed module, implementation, or protocol name.

When you start typing inside { } for alias Prefix.{} or import Prefix.{}, completion will look for nested modules under Prefix and then remove the Prefix., so completion will look like Suffix.

Completion uses the same presentation as Structure, so you can tell whether the name is function/macro (Time), whether it is public/private (Visibility) and the Module where it is defined. Between the icons and the Modules is the name itself, which is highlighted in bold, the parameters for the call definition follow, so that you can preview the patterns required for the different clauses.

Qualified functions and macro calls will complete using those functions and macros defined in the qualifying Module (defmodule), Implementation (defimpl) or Protocol (defprotocol). Completion starts as shown as . is typed after a qualifying Alias.

Function and macro calls that are unqualified are completed from the index of all function and macro definitions, both public and private. (The index contains only those Elixir functions and macro defined in parsable source, such as those in the project or its dependencies. Erlang functions and Elixir functions only in compiled .beam files, such as the standard library will not complete.) Private function and macros are shown, so you can choose them and then make the chosen function or macro public if it is a remote call.

Module attributes declared earlier in the file can be completed whenever you type @ and some letter. If you want to see all module attributes, you can type @a, wait for the completions to appear, then delete the @ to remove the filtering to a.

Parameter and variable usages can be completed whenever typing an identifier. The completions will include all variables know up from that part of the file. It can include variables from outside macros, like quote blocks.

Go To Declaration is a feature of JetBrains IDEs that allows you to jump from the usage of a symbol, such as a Module Alias, to its declaration, such as the defmodule call.

1. Place the cursor over an Alias with an aliased name setup by alias
   1. Suffix if alias Prefix.Suffix called
   2. MultipleAliasA if alias Prefix.{MultipleAliasA, MultipleAliasB} called
   3. As if alias Prefix.Suffix, as: As
2. Activate the Go To Declaration action with one of the following:
   1. Cmd+B
   2. Select Navigate > Declaration from the menu.
   3. Cmd+Click
3. A Go To Declaration lookup menu will appear, allowing you to jump either the alias that setup the aliased name or jumping directly to defmodule of the unaliased name. Select which declaration you want
   1. Use arrow keys to select and hit Enter
   2. Click

You'll know if function or macro usage is resolved and Go To Declaration will work if the call is annotated, which in the default themes will show up as italics.

1. Place the cursor over name of the function or macro call.
2. Activate the Go to Declaration action with one of the following:
   1. Cmd+B
   2. Select Navigate > Declaration from the menu.
   3. Cmd+Click
3. A Go To Declaration lookup menu will appear, allowing you to jump to either the import that imported the function or macro or jumping directly to the function or macro definition clause. Select which declaration you want.
   1. Use arrow keys to select and hit Enter
   2. Click

1. Place the cursor over name of the function or macro call.
2. Activate the Go to Declaration action with one of the following:
   1. Cmd+B
   2. Select Navigate > Declaration from the menu.
   3. Cmd+Click
3. Whether a lookup a Go To Declaration lookup menu appears depends on the number of clauses in the function or macro definition:
   1. If there is only one clause in the function or macro definition, you'll jump immediately to that clause
   2. If there is more than one clause in the function or macro definition, a Go To Declaration lookup menu will appear, allowing you to jump to either the import that imported the function or macro or jumping directly to the function or macro definition clause. Select which declaration you want.
      1. Use arrow keys to select and hit Enter
      2. Click

1. Place the cursor over name of the function or macro call that is qualified by an Alias.
2. Activate the Go to Declaration action with one of the following:
   1. Cmd+B
   2. Select Navigate > Declaration from the menu.
   3. Cmd+Click
3. 1. If there is only one clause in the function or macro definition, you'll jump immediately to that clause
   2. If there is more than one clause in the function or macro definition, a Go To Declaration lookup menu will appear, allowing you to jump to either the import that imported the function or macro or jumping directly to the function or macro definition clause. Select which declaration you want.
      1. Use arrow keys to select and hit Enter
      2. Click

1. Place the cursor over a fully-qualified Alias
   1. A.B in A.B.func()
   2. A.B in alias A.B
   3. B in alias A.{B, C}
2. Activate the Go To Declaration action with one of the following:
   1. Cmd+B
   2. Select Navigate > Declaration from the menu.
   3. Cmd+Click

If you hold Cmd and hover over the Alias before clicking, the target declaration will be shown.

1. Place the cursor over a @module_attribute
2. Activate the Go To Declaration action with one of the following:
   1. Cmd+B
   2. Select Navigate > Declaration from the menu.
   3. Cmd+Click

If you hold Cmd and hover over the @module_attribute before clicking, the target declaration will be shown.

1. Place the cursor over a parameter or variable usage
2. Active the Go To Declaration action with one of the following:
   1. Cmd+B
   2. Select Navigate > Declaration from the menu.
   3. Cmd+Click

If you hold Cmd and hover over the variable before clicking, it will say parameter or variable, which matches the annotation color.

IntelliJ Elixir both has an internal formatter used to format new linees and parts of files, but also can use mix format to format entire files.

IntelliJ Elixir's internal formatter can reformat code to follow a consistent style.

• do block lines are indented
• do blocks end as the last argument of a no parentheses call unindents to the start of the call
• If one clause of a multi-clause anonymous function wraps, all clauses wrap.
• Indent after else
• Indent map and struct keys
• All keys wrap if any key wraps
• No spaces around...
  • .
• Spaces around...
  • and
  • in
  • or
  • when
• Configure spaces around...
  • =
  • <- and \\
  • !=, ==, =~, !==, and ===
  • <, <=, >=, and >
  • + and -
  • * and /
  • Unary +, -, !, ^, and ~~~
  • ->
  • ::
  • |
  • || and |||
  • && and &&&
  • <~, |>, ~>, <<<, <<~, <|>, <~>, >>>, and ~>>
  • ..
  • ^^^
  • ++, --, .., <>
  • =>
• Configure spaces before...
  • ,
• No space after...
  • @
• Spaces after...
  • not
  • fn
  • after
  • catch
  • rescue
  • key:
• Configure space after...
  • &
  • ,
• Configure spaces within...
  • { }
  • << >>
  • [ ]
  • ( )
• No space around / in &NAME/ARITY and &QUALIFIER.NAME/ARITY
• when wraps when its right operand wraps, so that guards start with when on a newline when they are too long.
• Align |> at start of indented line for pipelines
• Align end with start of call instead of start of line for do blocks in pipelines
• Indent list elements when wrapped
• Indent tuple elements when wrapped
• Align type definition to right of ::
• Align guard to right of when when guards span multiple lines
• Align two operator (++, --, .., <>) operands, so that <> binaries are multiple lines align their starts instead of using continuation indent and being indented relative to first operand.
• Align pipe | operands, so that alternates in types and specs are aligned instead of continuation indented relative to the first operand.
• Comments in spec (that is above operands to | align with the operands
• Remove newlines from pipelines, so that all pipelines start with an initial value or call and each |> is the start of a successive line.
• Key exclusivity: if an association operation or keyword key is already on a line, the container value automatically has it's elements wrapped if there is nested associations or keyword pairs, so that two levels of keys are not on the same line.
• Indent bit string (<< >>) elements when wrapped

IntelliJ Elixir will run mix format - on the text of the file. As mix format works on entire files, only whole file, multiple file, or directory formatting is supported using this external formatter. Formatting subsections and new lines use the internal formatter until the next full file format uses mix format.

NOTE: The module or project SDK MUST be set in order to run mix format. If the SDK is not set, only the internal formatter will be run.

mix format can be disabled if you only want to use the Internal Formatter.

1. Preferences
2. Editor > Code Style > Elixir
3. Click the mix format tab
4. Expand the General group
5. Uncheck "Format files with mix format".

To tun on format on save:

1. Preferences
2. Tools > Actions on Save.
3. Check "Reformat code".
4. Make sure "All file types" is set or at least "Files: Elixir" is set.

JetBrains IDEs have autosave turned on by default when you click away from the editor window, but you can adjust the settings:

1. Preferences
2. Appearance & Behavior > System Settings.
3. Check or uncheck the settings in the Autosave section.