API Blueprint Sublime 插件使用教程

API Blueprint Sublime 插件使用教程

api-blueprint-sublime-pluginAPI Blueprint Sublime Text plugin项目地址:https://gitcode.com/gh_mirrors/ap/api-blueprint-sublime-plugin

1. 项目的目录结构及介绍

api-blueprint-sublime-plugin/
├── APIBlueprint.sublime-commands
├── APIBlueprint.tmLanguage
├── README.md
└── ...

• APIBlueprint.sublime-commands: 包含插件的命令定义。
• APIBlueprint.tmLanguage: 提供 API Blueprint 格式的语法高亮。
• README.md: 项目说明文档，包含安装和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 APIBlueprint.sublime-commands，该文件定义了插件的命令，可以通过 Sublime Text 的命令面板访问。

{
    "caption": "API Blueprint: Parse",
    "command": "api_blueprint_parse"
}

该命令用于解析当前文件并打开结果 AST（抽象语法树），包括任何可能的解析器消息。

3. 项目的配置文件介绍

项目的主要配置文件是 APIBlueprint.tmLanguage，该文件定义了 API Blueprint 格式的语法高亮规则。

<dict>
    <key>name</key>
    <string>API Blueprint</string>
    <key>scopeName</key>
    <string>source.apib</string>
    <key>fileTypes</key>
    <array>
        <string>apib</string>
    </array>
    <key>patterns</key>
    <array>
        <dict>
            <key>include</key>
            <string>#api-blueprint</string>
        </dict>
    </array>
    <key>repository</key>
    <dict>
        <key>api-blueprint</key>
        <dict>
            <key>patterns</key>
            <array>
                <dict>
                    <key>match</key>
                    <string>\b(FORMAT|HOST|BASE_URL)\b</string>
                    <key>name</key>
                    <string>keyword.control.apib</string>
                </dict>
                <!-- 其他匹配规则 -->
            </array>
        </dict>
    </dict>
</dict>

该文件通过定义不同的匹配规则来实现语法高亮，例如关键字、注释等。

---

以上是 API Blueprint Sublime 插件的基本使用教程，详细内容可以参考项目的 GitHub 页面。

api-blueprint-sublime-pluginAPI Blueprint Sublime Text plugin项目地址:https://gitcode.com/gh_mirrors/ap/api-blueprint-sublime-plugin