Green.Rules.Exceptions.UseErrorSuffix (green v0.2.0)

This rule warns if exceptions are defined with a suffix of Error.

Configuration

This rule is enabled by default, but can be disabled globally in the configuration file.

The rule can also be configured to ignore specific files, or specific lines in specific files. This is useful for cases where applying the rule would be problematic.

In .formatter.exs:

  green: [
    use_error_suffix: [
      enabled: *true | false,
      except: [
        "path/to/file.exs",
        {"path/to/other_file.exs", 42},
        {"path/to/yet_another_file.exs", [10, 20, 30]}
      ]
    ]
  ]

Examples

defmodule MyBad do
  defexception message: "some error message"
end

In the example above, the exception should be named MyBadError.