SublimeLinter-contrib-scalastyle

此代码检查插件为SublimeLinter提供与scalastyle的接口。它将与“scala”语法的文件一起使用。

安装

必须安装 SublimeLinter 3 才能使用此插件。如果没有安装 SublimeLinter 3，请按照此处的说明操作。

代码检查器安装

在使用此插件之前，必须确保系统上已安装 scalastyle。 scalastyle 作为可执行 jar 文件可用，可以从此处下载。

代码检查器配置

为了使 scalastyle 能够通过 SublimeLinter 执行，您必须确保 SublimeLinter 可用 java 的路径。在继续之前，请阅读并遵循文档中的步骤“Finding a linter executable”，特别是“Validating your PATH”部分。

您已安装和配置 scalastyle 后，如果尚未安装，可以继续安装 SublimeLinter-contrib-scalastyle 插件。

插件安装

请使用 Package Control 安装代码检查器插件。这将确保插件在新版本可用时更新。如果您想从源代码安装并修改源代码，那么您可能已经知道自己在做什么，所以我们不会在这里讨论。

通过 Package Control 安装操作如下

1. 在 Sublime Text 中，打开命令面板，并输入 install。在您应看到的命令中，应该会有 Package Control: Install Package。如果该命令没有高亮显示，请使用键盘或鼠标选择它。Package Control 将断续几秒钟以获取可用插件的列表。

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

设置

有关SublimeLinter如何使用设置的通用信息，请参阅设置。有关通用检查器设置的详细信息，请参阅检查器设置。

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

默认情况下，检查器插件会在当前目录及其父目录中查找名为scalastyle-config.xml的文件。要覆盖配置文件路径，请在检查器设置中添加以下内容

"scalastyle": {
    "args": ["--config", "path/to/config.xml"]
}

贡献

如果您想贡献改进或修复，请按照以下方法操作

1. 分叉插件存储库。
2. 在从最新的develop创建的独立分支上编码。
3. 提交并推动主题分支。
4. 发起拉取请求。
5. 请耐心等待。;-)

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

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

重要!

此外，请注意，此存储库使用overcommit作为验证工具。在做出任何更改之前，请在您的本地存储库中安装overcommit。

感谢您的帮助！