命令浏览器

这是一个Sublime Text软件包，允许用户查看Sublime Text和Sublime Merge的所有核心/插件命令，以及它们的文档/源代码。

安装

包控制

安装和此包的使用方法有几种，如下所示（从最优先的方式到最不优先的方式）

1. 使用 包控制：安装包 并搜索 命令浏览器 安装它。
2. 使用 包控制：添加仓库。将此仓库的GitHub url（不包含末尾的 .git）复制并输入到您选择 包控制：添加仓库 时底部出现的输入面板中。现在使用 包控制：安装包 并搜索 命令浏览器 安装它。
3. 在您的 Packages 目录中简单地使用 git clone 此仓库。
4. 每当推送新的标记版本时，请获取该版本附带的zip文件，将其重命名为去除 .zip 扩展名并添加 .sublime-package 扩展名，然后将其放入您的 已安装包 目录中（但是，您将失去当有新的标记版本时包控制自动更新包的好处）。

如果您有兴趣为此仓库做出贡献，则需要遵循（3）。有关更多信息，请参阅贡献指南。

文档

如何使用此包？

本包向命令面板提供了3个功能。1. CommandsBrowser: 浏览可用的Sublime Text核心命令。 这将显示Sublime Text中所有存在的核心命令。选择一个命令会弹出一个面板，显示该命令的文档。您也可以在选中命令时按住 Ctl 键复制其签名到剪贴板。2. CommandsBrowser: 浏览可用的Sublime Merge核心命令。 这将显示Sublime Merge中所有存在的核心命令。选择一个命令会弹出一个面板，显示该命令的文档。您也可以在选中命令时按住 Ctl 键复制其签名到剪贴板。3. CommandsBrowser: 浏览可用的插件/包命令。 这将显示Sublime Text中所有存在的插件/包命令。选择一个命令会打开相应的插件文件，并导航到实现该命令类的位置。

若要查看该包的文档，请使用 CommandsBrowser: 查看文档，这将在默认浏览器中打开项目的README。

类似地，您可以使用 CommandsBrowser: 打开Wiki 在默认浏览器中打开存储库的Wiki以查看某些命令的深入文档。

注意

1. 由于核心命令列表不像插件命令那样被ST暴露，追踪它的唯一方法就是手动维护一个命令列表并显示出来。因此，列表可能不完整。据我所知，它应该是一个相当完整的列表（可能是最全面的开源列表）。

2. Sublime Merge命令列表限于Sublime Merge特有的命令（95%与git相关）。然而，由于Sublime Text和Sublime Merge有相同的代码库，因此一个很大的可能性是许多ST命令在SM中也有效。它们没有在SM中列出，因为这些命令已经列在ST中。因此，ST + SM命令列表应该可以提供一个很好的概述，说明两个应用中共同存在的命令总数。

本包更新到命令的版本为 ST Build 4131 & SM Build 2069

设置

CommandsBrowser 添加了几个设置，用于自定义和过滤命令，下面将进行说明。

您可以通过两种方式更改设置（两种方式都将打开并排的设置视图）。

1. 从主菜单使用 首选项 -> 包设置 -> CommandsBrowser -> 设置。
2. 从命令面板使用 首选项: CommandsBrowser 设置。

本包为LSP + LSP-json的用户提供了必要的辅助文件，以便充分利用设置智能自动补全。

auto_open_doc_panel_on_navigate (布尔型)

当设置为 true 时，在导航核心命令时会自动打开核心命令文档面板。这有助于在快速查看多个命令的文档时，无需每次都关闭和重新打开面板。

此设置的默认值为 false。

filter_plugin_commands_on_host (字符串)

Sublime Text 4有两个插件主机。3.3 (Python 3.3.6) & 3.8 (Python 3.8.8)。此设置允许用户根据主机过滤插件命令。

有效值为 "all"，"3.3" 和 "3.8" "all" - 显示来自两个主机的插件命令。"3.3" - 仅显示来自3.3主机的插件命令。"3.8" - 仅显示来自3.8主机的插件命令。

此设置的默认值为 "all"。

filter_plugin_commands_on_type (列表[str])

此设置允许用户根据命令的类型过滤插件命令。

示例：

此设置的默认值为 ["window", "application", "text"]。

filter_core_commands_on_type (str列表)

此设置允许用户根据命令类型过滤核心命令。

示例：

此设置的默认值为 ["text", "window", "application", "find"]。

copy_command_signature_modifier_key (字符串)

此设置允许用户配置在选择命令时同时按住的修正键，用于将命令签名复制到剪贴板。

有关有效修正键值的列表，请参见 https://text.sublime.net.cn/docs/api_reference.html#type-event_dict

此设置的默认值为 "ctrl"。

filter_plugin_commands_on_package (字符串 | str列表)

此设置允许用户根据包名过滤插件命令。

示例：

此设置的默认值为 "all"（这是此设置可以接受的唯一字符串值）。

快捷键绑定。

此包附带一个快捷键，用于更容易地打开核心命令文档面板（如果存在）。该快捷键为 ctrl + shift + c, ctrl + shift + d

您可以通过以下两种方式更改快捷键（两种方式都将打开键绑定并排视图）。

1. 从主菜单中选择 首选项 -> 包设置 -> CommandsBrowser -> 键绑定
2. 从命令面板中选择 首选项: CommandsBrowser 键绑定

论坛讨论

论坛讨论 已启用，以便可以就如何有效地使用命令（特别是核心）来提高您的 ST/SM 工作流程进行建设性讨论。有关核心命令的任何问题可以在相应的渠道进行，即 Sublime Text 和 Sublime Merge。

由于基于插件的命令特定于插件/包，所以最好在特定插件/包的存储库中提出相关问题。当然，您也可以提出相关问题以帮助他们。

关于命令的详解文档。

一些命令可能有点复杂（可能是因为它们可能有不同的执行方式，或者可能有不同的选项需要解释）因此，此类深入文档被省略在文档面板中。有关这些命令的示例，请查阅wiki。请注意，这仍是一项正在进行的工作。

问题和功能请求

请使用问题/功能请求模板，在提出问题/功能请求时保持尽可能有序。

贡献

查看 贡献指南 以了解如何为此项目做出贡献。

致谢

在此我想提出两点致谢。

1. 感谢OdatNurd慷慨地授予我使用其插件的权限，使我能够提供所有插件的命令。大多数代码保持未修改，但我在几个地方进行了调整以适应此软件包。他有一个令人惊叹的YouTube频道，如果你对更高效地使用Sublime Text感兴趣，绝对值得一试。

2. 我从PackageDev获得了核心命令元数据列表，开始进行开发。PackageDev有一个用于存储数据的YAML文件，但由于以下两个原因，这并不符合我的口味：

(a) Python没有内置处理YAML文件的模块，这就是为什么PackageDev将其作为依赖项使用pyyaml。在编写此文档时，Package Control不允许在3.8插件宿主中添加依赖项，因此你被卡在了3.3（而这并非是我想要的）。

(b)我不想向这样一个可能简单的软件包添加不必要的依赖。

许可协议

MIT许可证（MIT）

版权所有 © 2021-22 Ashwin Shenoy

在此，免费许可任何人获取此软件及其关联文档副本（“软件”），在没有任何限制的情况下处理该软件，包括但不仅限于使用、复制、修改、合并、发布、分发、转授权和/或销售软件副本的权利，并允许向提供本软件的人员授予此类权利，前提是遵守以下条件

所有副本或软件的实质性部分必须包含上述版权声明和本许可声明。

本软件提供“现状”，不提供任何形式的保证，无论是明示的、默示的、针对特定目的的适用性还是不侵权保证。在任何情况下，作者或版权所有者都不会对任何索赔、损害或其他责任负责，包括但不限于合同诉讼、侵权诉讼或其他诉讼，无论是来自、由于或与该软件的使用或其他交易相关。