sublack

|==============================================================================

此存储库将不会更新。存储库将以只读模式保持可用。

欢迎新的维护者fork它。

|================================================================================

BLACK集成于SublimeText

• 许可证：GNU通用公共许可证v3或更高版本（GPLv3+）
• 源：https://github.com/jgirardet/sublack

目录

安装 | 用法 | Blackd模式 | Pre-commit集成 | 设置 | 代码折叠 | Sublime Linter集成 | 问题 | 感谢 | 变更日志 | 贡献 | 作者

安装

1. 安装BLACK min (19.3b0)（如果您尚未安装）

   pip install black # Requires python 3.6
   or pip install black[d] # for blackd support
   

2. 在PackageControl中查找sublack，然后就这样！

或者

没有PackageControl，通过导航到Sublime的包文件夹并克隆此仓库手动安装

git clone https://github.com/jgirardet/sublack.git

用法

• 在当前文件上运行Black

  按下Ctrl-Alt-B将格式化整个文件。您也可以按下Ctrl-Shift-P（Mac: Cmd-Shift-P）并选择Sublack：格式化文件。

• 带有--diff运行Black

  按下Ctrl-Alt-Shift-B将在新标签中显示diff。您也可以按下Ctrl-Shift-P（Mac: Cmd-Shift-P）并选择Sublack：比较文件。

• 切换当前视图的保存时Black

  按下Ctrl-Shift-P（Mac: Cmd-Shift-P）并选择Sublack：切换当前视图的保存时Black。

• 运行Black格式化所有

  按下Ctrl-Shift-P（Mac: Cmd-Shift-P）并选择Sublack：格式化所有。按标准方式（不考虑sublack选项和配置）运行black针对每个根文件夹。与在文件夹中运行black .相同。

• 启动Blackd服务器

  按下Ctrl-Shift-P（Mac: Cmd-Shift-P）并选择Sublack：启动BlackdServer。

• 停止Blackd服务器

  按下 Ctrl-Shift-P（Mac: Cmd-Shift-P）并选择 Sublack: 停止 BlackdServer。

Blackd 模式

Sublack 支持 blackd。如果选项 black_use_blackd 设为 true，Sublack 将根据 'host' 和 'port' 配置使用 blackd（而非 black）。

您可以通过 开始 Blackd 服务器 命令手动从 SublimeText 运行 blackd，或通过将设置 black_blackd_autostart 设置为 true 在 SublimeText 启动时自动运行。

通过 SublimeText 启动 blackd 服务器可以通过 停止 Blackd 服务器 命令手动停止，或在 sublime 退出时自动停止。

与 "独立" blackd 不同，使用黑d 和 sublack 将会继续处理 pyproject 文件。

在 sublack 中使用标准模式或 blackd 模式应该总是有相同的结果……否则就是 bug :-)

Blackd 比 Black 快。

始终使用黑 执行 diff。

预提交集成

您可以通过将 black_use_precommit 设置为 true来选择通过 pre-commit 运行 Black。Sublack 设置将被忽略。

设置

Sublack 将按以下顺序查找设置

• 首先在 pyproject.toml 文件中
• 其次是项目文件：先带有 sublack 前缀，然后在子设置中（见项目设置）。
• 然后是用户全局设置
• 最后是在 Sublack 的默认设置中

全局设置

首选项 -> 包设置 -> sublack -> 设置

Black 特有选项

• black_line_length

  设置由 Black 使用的自定义行长度选项。默认 = null，允许 black 使用默认值。

• black_fast

  Black 快速模式。默认为 false。

• black_skip_string_normalization

  不要规范化字符串引号或前缀。默认 = false。

• black_py36[弃用]

  仅强制使用 Python 3.6 语法。默认为 Black 的默认设置。

• black_target_version

  黑 字符应支持的 Python 版本。您应将其作为列表输入：例如：["py37"]

Sublack 特有选项

• black_command

  设置自定义位置。默认 = "black"。

• black_on_save

  Black 在保存文件之前始终运行。默认 = false。

• black_log

  在控制台中显示非错误消息。默认 = info。

• black_default_encoding

  不应该更改。仅在有些 Mac 平台上需要。

• black_use_blackd

  使用黑d 而不是 black。默认 = false。

• black_blackd_server_host

  默认 = "localhost",

• black_blackd_port

  默认 = "45484"

• black_blackd_autostart

  Sublime 启动时在后台自动运行 blackd。默认是 false。

• black_use_precommit

  通过 pre-commit 钩子运行 black。

• black_confirm_formatall

  在格式化_all 命令之前弹出确认对话框。默认 = true。

项目设置

只需将 sublack 作为前缀（推荐）

{
    "settings": {
        "sublack.black_on_save": true
    }
}

可能的还是子lack 子设置

{
    "settings": {
        "sublack": {
            "black_on_save": true
        }
    }
}

pyproject.toml 设置

Sublack 支持在 pyproject.toml 中使用 black 配置。请注意，全局/项目设置将被 pyproject.toml 的设置覆盖。Sublack 将在您的 项目目录 中查找此文件，然后是您的根文件夹。请参阅 black 关于 pyproject.toml 的相关信息。

代码折叠

Sublack 尝试在重新格式化之前保持代码折叠。SublimeText 仅支持 python3.3 语法。对于较新的语法（例如 await/async），您必须设置 python_interpreter 设置。

{
    "settings": {
        "python_interpreter": "/path/to/my/python/virtualenv/bin/python"
    }
}

Sublime Linter 集成

您可以安装 SublimeLinter-addon-black-for-flake。该插件将自动配置 flake8 并静音所有 black 实际可以修复的警告。

问题

如果该插件存在问题，请在 GitHub 上 创建一个问题，我将尝试解决它。

感谢

此插件受到非常好的 PyYapf 插件的极大启发。感谢 Jason Kane。

更新日志

请参阅 install.txt

贡献

• 通过Package Control移除sublack。
• Fork sublack
• 将你的sublack Fork克隆到你的Packages文件夹（首选项 --> 浏览Packages...）。
• 首选项 --> Package Control: 满足依赖（安装请求）
• 在Package Control中安装UnitTesting
• 如果你可以的话，添加对新功能或错误修正的测试是非常好的。
• 在readme中的Authors部分添加你的名字。

作者

由Jimmy Girardet辛苦编写

贡献者包括

• nicokist
• mschneiderwind
• catch22
• Thom1729
• Jacobi Petrucciani
• Herr Kaste
• Martinj Peters
• Cyrus Yip
• Georgios Samaras

待办事项

• cors
• 重构popen