Sublime Text的CFML软件包

该软件包提供了在Sublime Text中使用CFML（ColdFusion标记语言）的支持。它包括语法高亮、函数和标签完成以及内联文档。它还包含许多其他功能，请参见下面的完整列表。

您可以通过Package Control安装此软件包。软件包名称为CFML。安装后应重启Sublime Text。也可以进行手动安装。有关这些选项的更多信息，请参阅下面的安装部分。

致谢

以下软件包被用于此软件包的开发

• https://github.com/SublimeText/ColdFusion
• https://github.com/sublimehq/Packages

CFScript语法基于Thomas Smith（@Thom1729）在官方JavaScript语法上所做的工作

• https://github.com/sublimehq/Packages/pull/1009

特别感谢来自@foundeo和cfdocs.org的功能和标签数据，等等。也感谢@mjhagen帮助我启动此软件包。

目录

• 安装
• 设置
• 完成
• 内联文档
• 默认快捷键绑定
• CFC索引和点路径
• 自定义标签
• 代码格式化
• CFML标签的自定义着色
• 控制器/视图切换
• 命令框
• 测试框
• Framework One

安装

通过Package Control

首先确保已安装Package Control。Sublime Text的较新版本包括安装Package Control的菜单选项和命令面板输入。您还可以按照https://packagecontrol.sublime.net.cn/installation上的说明来安装它。

打开命令面板（Windows上的CTRL+SHIFT+P，Mac上的CMD+SHIFT+P），选择Package Control: Install Package。

等待列表打开并找到CFML条目（副标题为该GitHub仓库 github.com/jcberquist/sublimetext-cfml），然后选择它进行安装。

重启Sublime Text。

Package Control将自动为您保持CFML包的更新。

手动安装

首先找到您的Sublime Text包目录。这可以通过在Sublime Text中打开命令面板（Windows上的CTRL+SHIFT+P，Mac上的CMD+SHIFT+P）并运行首选项:浏览包来完成。

在Windows上通常是这样的

C:\Users\Username\AppData\Roaming\Sublime Text\Packages\

在Mac上通常是这样的

/Users/Username/Library/Application Support/Sublime Text/Packages/

通过Git

打开终端或命令提示符，并通过cd进入您的包目录，然后运行

git clone https://github.com/jcberquist/sublimetext-cfml.git ./CFML

重启Sublime Text。

随该存储库的更改和包的更新，只需在您安装包的文件夹中运行以下命令即可使您的包副本保持最新

git pull origin master

通过ZIP下载

使用下载ZIP选项将存储库的zip文件下载到您的计算机。（master分支zip文件位于https://github.com/jcberquist/sublimetext-cfml/archive/master.zip）。解压此zip文件，并将结果存储库文件夹的内容复制到Sublime Text包目录中名为CFML的子目录中。

重启Sublime Text。

随着该存储库的更改和包的更新，您需要重复此过程（用旧内容替换CFML子目录中的内容）以使您的包副本保持最新。

设置

有若干设置文件，您应该了解它们，因为它们控制了包的大部分功能。访问每个文件有两种方式，一种是通过菜单，另一种是通过命令面板，您可以通过Windows上的CTRL+SHIFT+P（Mac上的CMD+SHIFT+P）打开它。

包设置

您可以通过菜单下的包设置 -> CFML -> 设置或通过命令面板：CFML: 设置访问包设置。要覆盖任何这些设置，请使用用户包设置文件。（默认设置和用户设置并排打开。）

项目设置

某些设置也可以（或仅）按项目设置。这些设置控制了包在给定项目上的行为。您可以从菜单下的项目 -> 编辑项目或通过命令面板：项目: 编辑项目访问和编辑项目文件。（这些只有在您保存了项目后才能访问：项目 -> 另存为项目或项目: 另存为。）

绑定

键盘和鼠标绑定文件可在菜单下的包设置 -> CFML -> 键绑定和包设置 -> CFML -> 鼠标绑定中找到。或者通过命令面板在CFML: 键绑定和CFML: 鼠标绑定下。默认设置和用户设置并排打开。

完成

包括对标签和标签属性、内置函数和成员函数的完成。还包括对Application.cfc设置和方法的范围完成。

对于内置函数，有三种完成样式。这由一个包设置控制，即cfml_bif_completions，它可以设置为以下三种选项之一：基本、必须或完整。将此设置为基本将仅完成函数名，不插入任何函数参数。默认设置的必须包含在完成中，但只有名称，没有类型。设置此为完整将导致包括所有参数及其类型。

当为内置函数输入函数调用参数时，会显示一个弹出窗口，显示该参数的来自 cfdocs.org 的文档。这可以通过在您的用户包设置中将 cfml_completion_docs 设置为 false 来禁用。

内联文档

F1 被映射到内联文档命令，该命令基于光标位置提供内联文档弹出窗口。该文档命令还可以在鼠标悬停时运行。默认情况下这是启用的，但您可以在您的用户包设置中将 cfml_hover_docs 设置为 false 来禁用。

您始终可以在您自己的用户键绑定文件中覆盖默认的键绑定。

如果在内置函数或标签内运行文档命令，则将加载该函数或标签的 cfdocs.org 文档。因此，将光标定位在 dateFormat(myDate, "yyyy-mm-dd") 中的任何位置并按 F1（默认）将触发显示 dateFormat 的文档。同样，在 <cfinclude template="myOtherTemplate.cfm"> 中的任何位置按下 F1 将触发显示 cfinclude 的文档。内联文档也适用于 Application.cfc 设置和方法。

如果您在文件系统上有一个 cfdocs.org GitHub 仓库的副本，有一个包设置 "cfdocs_path" 可以设置为该仓库的数据目录（例如 "cfdocs_path": "C:/github/cfdocs/data/en/"）。如果设置了此选项，cfdocs.org 文档将来自文件系统而不是通过 HTTP 请求获取。（有关更多信息，请参阅下面的包设置。）

默认快捷键绑定

在标签属性、脚本字符串以及在 cfoutput 标签之间，当文本被选中时，按 # 将当前选中的文本包裹为 #selected#。

CTRL+ALT+D 将在 CFML 脚本中输出一个 <cfdump> 标签或 writeDump()/dump() 函数，并包裹任何当前选中的文本。

CTRL+SHIFT+O 将在 CFML 脚本中输出一个 <cfoutput> 标签或 writeOutput() 函数，并包裹任何当前选中的文本。

CTRL+ALT+A 将在 CFML 脚本中输出一个 <cfabort> 标签或 abort;。

如果 Sublime Text 的 auto_close_tags 设置为 true，则在按下关闭标签的 / 时，将完成关闭标签。有两个包设置控制哪些 CFML 和 HTML 标签不应关闭：cfml_non_closing_tags 和 html_non_closing_tags。

如果包设置 cfml_auto_insert_closing_tag 设置为 true（默认为 false），当在标签中按 > 时，将在光标位置后自动插入相应的关闭标签。包设置 cfml_non_closing_tags 控制哪些 CFML 标签不会自动插入关闭标签。

包设置 cfml_between_tag_pair 控制当光标位于 CFML 标签对之间（例如 <cfoutput>|</cfoutput>）时按 ENTER 的行为。默认情况下仅插入单行新行。这可以更改为在标签对之间自动插入额外的空行（可选缩进），并将光标放在那里。有关更多信息，请参阅默认包设置文件。

CFC索引和点路径

在项目文件中根据项目分别设置了两个设置，cfc_folders 和 mappings。以下是一个示例（真实的项目文件将包含其他设置）

{
    "mappings": [
        {"mapping": "/framework", "path": "C:/myprojects/projectname/framework"},
        {"mapping": "/model", "path": "C:/myprojects/projectname/app/model"}
    ],
    "cfc_folders": [
        {
            "path": "C:/myprojects/projectname/app/model",
            "variable_names": ["{cfc}", "{cfc}{cfc_folder_singularized}"],
            "accessors": false
        }
    ]
}

注意：上面指定的路径可以是绝对路径，也可以是相对路径。如果是相对路径，则相对于 .sublime-project 文件的位置进行解析。

指定的映射用于在侧边栏中右键单击CFC文件并选择复制CFC点分路径时，将文件路径转换为点分路径。如果有多个映射匹配，则会提供选择，如果没有匹配项，则默认使用项目的基准文件夹作为点分路径的根。映射还用于解析组件中的extends属性、createObject函数以及使用new运算符实例化组件时的点分路径（例如：new dot.path.to.component()）。当光标位于这些位置并使用F1命令时，您将获得一个弹出窗口，其中包含组件的文件路径（如果是索引过的组件，还将显示更多关于组件的信息）。您可以点击文件路径跳转到组件文件。您还可以在这些地方按CTRL+ALT+左键单击（在Mac上为CMD+ALT+左键单击）直接跳转到组件文件而不通过弹出窗口。此外，如果这些命令在用作函数调用参数的任何引号字符串中包含可解析的点分路径，则它们同样适用。

您可以在鼠标绑定 - 默认文件中看到这个鼠标绑定的结构。使用鼠标绑定 - 用户文件创建您自己的。

重要：鼠标绑定在整个Sublime Text中都是全局的，因此在使用时请小心，确保不要覆盖默认的Sublime Text鼠标绑定（例如CTRL+左键单击，该键会在点击的位置添加新的光标）。

数组包含具有一个必需键的对象：。在此指定的文件夹将递归搜索CFC文件，并将这些文件进行索引。设置是一个字符串数组，其中每个字符串指定一个变量名以关联每个索引过的CFC。名称的确定如下所示

{
    "custom_tag_folders":
    [
        {
            "path": "C:/myprojects/projectname/customtags/page",
            "prefix": "page"
        }
    ]
}