注意：此存储库不再维护，因为我已切换到使用 JakeBecker 的 elixir-ls 和 tom564 的 LSP 的更高级的代码检查方式。请务必自行查看。

SublimeLinter-contrib-elixirc

此 SublimeLinter 的 linter 插件提供了使用 elixirc 检查 Elixir 语法的接口。它将用于具有 “elixir” 语法的文件。

安装

为了使用此插件，必须安装 SublimeLinter 3。如果未安装 SublimeLinter 3，请按照此处的说明进行操作。

Linter 安装

在安装此插件之前，您必须确保系统上安装了 elixir (>= 1.0)。有关安装 Elixir 的说明，请参阅elixir-lang 文档。

Linter 配置

为了使 SublimeLinter 能够执行 elixir，您必须确保其路径对于 SublimeLinter 是可用的。在继续之前，请参阅并按照文档中的“找到 linter 可执行文件”部分中的步骤进行操作。

一旦安装和配置了 elixir，如果尚未安装，您就可以安装 SublimeLinter-contrib-elixirc 插件了。

插件安装

请使用 Package Control 安装代码检查插件。这将确保插件在有新版本时能够更新。如果您想要从源码安装以便修改源代码，那么您可能已经知道自己在做什么，所以这里不会介绍这一部分。

要通过Package Control安装，请按照以下步骤操作

1. 在Sublime Text中，打开命令面板并输入install。在这些命令中应该能看到Package Control: Install Package。如果该命令没有高亮显示，请使用键盘或鼠标选择它。在Package Control获取可用插件列表的过程中会有短暂的延迟。

2. 当插件列表出现时，输入elixirc。在其中应该看到SublimeLinter-contrib-elixirc。如果该条目没有高亮显示，请使用键盘或鼠标选择它。

设置

有关SublimeLinter如何与设置协同工作的一般信息，请参阅设置。有关通用代码检查设置的信息，请参阅代码检查设置。

除了标准的SublimeLinter设置外，SublimeLinter-contrib-elixirc还提供了自己的设置。

在mix项目内

• 将chdir设置为mix项目的根目录。
• 将mix_project设置为true

示例

在您的.sublime-project文件中

"SublimeLinter": {
      "linters": {
         "elixirc": {
            "mix_project": true,
            "chdir": "PROJECT_ROOT"
         }
      }
   }

其中：* PROJECT_ROOT 是您项目的根目录路径（如果您的Sublime项目保存在那里，请使用${project}）

注意：目前，位于mix项目内的代码文件（例如ExUnit测试）仅会进行语法错误检查。这是一个已知问题，将在未来的版本中解决。

如果您还使用Elixir版本管理器，可以将prepend设置为下面的示例

在mix项目外

• 如果文件使用了宏，必须在检查前通过pa添加beam输出路径到代码路径。
• 要添加到代码检查前需要包含的文件（或目录）必须通过require添加。它们将按照给定顺序要求。如果给定目录，则会递归并按字母顺序遍历。

示例

在您的.sublime-project文件中

"SublimeLinter": {
      "linters": {
         "elixirc": {
            "pa": ["PROJECT_ROOT/_build/dev/lib/PROJECT_WITH_MACROS/ebin"],
            "require": ["PROJECT_ROOT/deps/DEP1"]
         }
      }
   }

其中：* PROJECT_ROOT 是您项目根目录的路径（如果您的Sublime项目保存在那里，请使用${project}） * PROJECT_WITH_MACROS 是包含宏的项目名称。列出所有包含在pa中的项目 * DEP1 是要包含的文件目录。如果需要，首先列出特定文件。

命令定制

prepend和append选项允许您修改执行的命令。

使用场景的一个例子是，如果您使用Elixir版本管理器（例如kiex），它们在切换到Elixir的不同版本时会改变某些环境变量。

由于Sublime对用户可配置的环境变量非常有限，问题可以通过任何典型UNIX-based OS上的env命令解决。

示例

"SublimeLinter": {
      "linters": {
        "elixirc": {
          "chdir": "/Users/foo/projects/myapp",
          "mix_project": true,
          "prepend": ["/usr/bin/env", "MIX_ARCHIVES=/Users/foo/.kiex/mix/archives/elixir-1.3.3"]
        }
      }
    }

贡献

如果您想对增强或修复做出贡献，请按照以下步骤操作

1. 从插件仓库上派生。
2. 从最新master创建一个单独的主题分支进行开发。
3. 提交并推送主题分支。
4. 创建一个pull request。
5. 请耐心等待。;-)

请注意，所作的修改应遵循以下编码指南

• 缩进是4个空格。
• 代码应通过flake8和pep257进行代码检查。
• 垂直空白有助于可读性，不要害怕使用它。
• 请使用描述性的变量命名，除非非常熟知，否则不要使用缩写。

感谢您的协助！