现已发布!阅读关于 12 月份的新功能和修复。

Visual Studio Code 中的 Emmet

Visual Studio Code 内置支持 Emmet 代码片段和展开,无需扩展Emmet 2.0 支持大多数 Emmet 操作,包括展开 Emmet 缩写和代码片段

如何展开 Emmet 缩写和代码片段

Emmet 缩写和代码片段展开在 htmlhamlpugslimjsxxmlxslcssscsssasslessstylus 文件中默认启用,以及继承自上述任何语言的任何语言,如 handlebarsphp

Emmet in suggestion/auto-completion list

当您开始键入 Emmet 缩写时,您将在建议列表中看到该缩写。如果您打开了建议文档弹出窗口,您将在键入时看到展开的预览。如果您在样式表文件中,展开的缩写将与其他 CSS 建议一起显示在建议列表中,并进行排序。

使用 Tab 键进行 Emmet 展开

如果您想使用 Tab 键来展开 Emmet 缩写,请添加以下设置

"emmet.triggerExpansionOnTab": true

此设置允许在文本不是 Emmet 缩写时使用 Tab 键进行缩进。

当 quickSuggestions 被禁用时的 Emmet

如果您已禁用 editor.quickSuggestions 设置,您将不会在键入时看到建议。您仍然可以通过按 ⌃Space (Windows、Linux Ctrl+Space) 手动触发建议并查看预览。

在建议中禁用 Emmet

如果您根本不想在建议中看到 Emmet 缩写,请使用以下设置

"emmet.showExpandedAbbreviation": "never"

您仍然可以使用命令 Emmet: 展开缩写 来展开您的缩写。您也可以将任何键盘快捷键绑定到命令 ID editor.emmet.action.expandAbbreviation

Emmet 建议排序

为确保 Emmet 建议始终位于建议列表的顶部,请添加以下设置

"emmet.showSuggestionsAsSnippets": true,
"editor.snippetSuggestions": "top"

其他文件类型中的 Emmet

要在默认情况下未提供 Emmet 缩写展开的文件类型中启用 Emmet 缩写展开,请使用 emmet.includeLanguages 设置。请确保在映射的两侧都使用 语言标识符,右侧是 Emmet 支持的语言的语言标识符(请参阅上面的列表)。

例如

"emmet.includeLanguages": {
  "javascript": "javascriptreact",
  "razor": "html",
  "plaintext": "pug"
}

Emmet 对这些新语言一无所知,因此可能会在非 HTML/CSS 上下文中出现 Emmet 建议。为避免这种情况,您可以使用以下设置。

"emmet.showExpandedAbbreviation": "inMarkupAndStylesheetFilesOnly"

注意: 如果您之前使用 emmet.syntaxProfiles 来映射新文件类型,则从 VS Code 1.15 开始,应改用 emmet.includeLanguages 设置。 emmet.syntaxProfiles 仅用于 自定义最终输出

Emmet 与多光标

您也可以在多光标上使用大多数 Emmet 操作

Emmet with multi cursors

使用过滤器

过滤器是特殊的后处理器,可在展开的缩写输出到编辑器之前对其进行修改。有 2 种使用过滤器的方法;一种是通过 emmet.syntaxProfiles 设置进行全局应用,另一种是直接在当前缩写中使用。

下面是第一种方法的一个示例,使用 emmet.syntaxProfiles 设置将 bem 过滤器应用于 HTML 文件中的所有缩写

"emmet.syntaxProfiles": {
  "html": {
    "filters": "bem"
  }
}

要为当前缩写提供过滤器,请将过滤器附加到您的缩写。例如,div#page|c 将对 div#page 缩写应用 comment 过滤器。

BEM 过滤器 (bem)

如果您使用 Block Element Modifier (BEM) 编写 HTML,那么 bem 过滤器对您来说非常有用。要了解更多关于如何使用 bem 过滤器,请阅读 Emmet 中的 BEM 过滤器

您可以通过使用 Emmet 首选项 中记录的 bem.elementSeparatorbem.modifierSeparator 首选项来定制此过滤器。

注释过滤器 (c)

此过滤器会在重要标签周围添加注释。默认情况下,“重要标签”是指带有 id 和/或 class 属性的标签。

例如 div>div#page>p.title+p|c 将展开为

<div>
    <div id="page">
        <p class="title"></p>
        <!-- /.title -->
        <p></p>
    </div>
    <!-- /#page -->
</div>

您可以通过使用 Emmet 首选项 中记录的 filter.commentTriggerfilter.commentAfterfilter.commentBefore 首选项来定制此过滤器。

VS Code Emmet 2.0 中 filter.commentAfter 首选项的格式有所不同。

例如,而不是

"emmet.preferences": {
  "filter.commentAfter": "\n<!-- /<%= attr('id', '#') %><%= attr('class', '.') %> -->"
}

在 VS Code 中,您将使用更简单的

"emmet.preferences": {
  "filter.commentAfter": "\n<!-- /[#ID][.CLASS] -->"
}

Trim 过滤器 (t)

此过滤器仅在为 Emmet: 包裹缩写 命令提供缩写时适用。它会 移除被包裹行的行标记

使用自定义 Emmet 代码片段

自定义 Emmet 代码片段必须定义在一个名为 snippets.json 的 json 文件中。 emmet.extensionsPath 设置应指向包含此文件的目录路径。

下面是此 snippets.json 文件内容的示例。

{
  "html": {
    "snippets": {
      "ull": "ul>li[id=${1} class=${2}]*2{ Will work with html, pug, haml and slim }",
      "oll": "<ol><li id=${1} class=${2}> Will only work in html </ol>",
      "ran": "{ Wrap plain text in curly braces }"
    }
  },
  "css": {
    "snippets": {
      "cb": "color: black",
      "bsd": "border: 1px solid ${1:red}",
      "ls": "list-style: ${1}"
    }
  }
}

Emmet 2.0 中通过 snippets.json 文件进行的自定义代码片段编写与旧方法在几个方面有所不同

主题 旧 Emmet Emmet 2.0
代码片段与缩写 在名为 snippetsabbreviations 的两个单独属性中都支持 两者已合并为一个名为 snippets 的属性。请参阅默认的 HTML 代码片段CSS 代码片段
CSS 代码片段名称 可以包含 : 定义代码片段名称时不要使用 :。当 Emmet 尝试模糊匹配给定缩写与其中一个代码片段时,它会使用 : 来分隔属性名和值。
CSS 代码片段值 可以以 ; 结尾 不要在代码片段值末尾添加 ;。Emmet 会根据文件类型(css/less/scss vs sass/stylus)或为 css.propertyEndsass.propertyEndstylus.propertyEnd 设置的 Emmet 首选项自动添加末尾的 ;
光标位置 可以使用 ${cursor}| 仅使用 Textmate 语法,如 ${1} 来表示制表符停位点和光标位置

HTML Emmet 代码片段

HTML 自定义代码片段适用于所有其他标记语言,如 hamlpug。当代码片段值为缩写而不是实际 HTML 时,可以应用适当的转换,以根据语言类型获得正确的输出。

例如,对于一个带有列表项的无序列表,如果您的代码片段值为 ul>li,您可以在 htmlhamlpugslim 中使用相同的代码片段,但如果您的代码片段值为 <ul><li></li></ul>,则它仅在 html 文件中有效。

如果您想要纯文本的代码片段,请将文本用 {} 包围。

CSS Emmet 代码片段

CSS Emmet 代码片段的值应为完整的属性名和值对。

CSS 自定义代码片段适用于所有其他样式表语言,如 scsslesssass。因此,不要在代码片段值末尾包含尾随的 ;。Emmet 会根据语言是否需要它来按需添加。

不要在代码片段名称中使用 :: 用于在 Emmet 尝试模糊匹配缩写与其中一个代码片段时分隔属性名和值。

自定义代码片段中的制表符停位点和光标

自定义 Emmet 代码片段中制表符停位点的语法遵循 Textmate 代码片段语法

  • 使用 ${1}${2} 表示制表符停位点,使用 ${1:placeholder} 表示带有占位符的制表符停位点。
  • 以前,|${cursor} 用于表示自定义 Emmet 代码片段中的光标位置。这不再受支持。请使用 ${1} 代替。

Emmet 配置

以下是您可以在 VS Code 中使用的 Emmet 设置,用于自定义您的 Emmet 体验。

  • emmet.includeLanguages

    使用此设置在您选择的语言和 Emmet 支持的语言之间添加映射,以通过后者(Emmet 支持的语言)的语法在前者(您选择的语言)中启用 Emmet。请确保在映射的两侧都使用语言 ID。

    例如

    "emmet.includeLanguages": {
      "javascript": "javascriptreact",
      "plaintext": "pug"
    }
    
  • emmet.excludeLanguages

    如果您不想在某个语言中看到 Emmet 展开,请将其添加到此设置中,该设置接受一个语言 ID 字符串数组。

  • emmet.syntaxProfiles

    请参阅 Emmet 自定义输出配置文件,了解如何自定义 HTML 缩写的输出。

    例如

    "emmet.syntaxProfiles": {
      "html": {
        "attr_quotes": "single"
      },
      "jsx": {
        "self_closing_tag": true
      }
    }
    
  • emmet.variables

    自定义 Emmet 代码片段使用的变量。

    例如

    "emmet.variables": {
      "lang": "de",
      "charset": "UTF-16"
    }
    
  • emmet.showExpandedAbbreviation

    控制显示在建议/补全列表中的 Emmet 建议。

    设置值 描述
    never 永远不在任何语言的建议列表中显示 Emmet 缩写。
    inMarkupAndStylesheetFilesOnly 仅为纯粹的标记和样式表语言('html'、'pug'、'slim'、'haml'、'xml'、'xsl'、'css'、'scss'、'sass'、'less'、'stylus')显示 Emmet 建议。
    always 为所有 Emmet 支持的模式以及在 emmet.includeLanguages 设置中具有映射的语言显示 Emmet 建议。

    注意:always 模式下,新的 Emmet 实现不是上下文感知的。例如,如果您正在编辑 JavaScript React 文件,则不仅在编写标记时,在编写 JavaScript 时也会收到 Emmet 建议。

  • emmet.showAbbreviationSuggestions

    显示可能的 emmet 缩写作为建议。它默认为 true

    例如,当您键入 li 时,您将获得所有以 li 开头的 emmet 代码片段的建议,例如 linklink:csslink:favicon 等。这有助于学习 Emmet 代码片段,除非您牢记 Emmet 速查表,否则您可能永远不知道它们的存在。

    不适用于样式表或当 emmet.showExpandedAbbreviation 设置为 never 时。

  • emmet.extensionsPath

    提供包含 snippets.json 文件的目录的位置,该文件包含您的自定义代码片段。

  • emmet.triggerExpansionOnTab

    将此设置为 true 以启用使用 Tab 键展开 Emmet 缩写。我们使用此设置来提供适当的回退以在没有缩写可展开时提供缩进。

  • emmet.showSuggestionsAsSnippets

    如果设置为 true,则 Emmet 建议将与其他代码片段一起分组,允许您根据 editor.snippetSuggestions 设置进行排序。将其设置为 true,并将 editor.snippetSuggestions 设置为 top,以确保 Emmet 建议始终显示在其他建议之上。

  • emmet.preferences

    您可以使用此设置来自定义 Emmet,如 Emmet 首选项 中所述。目前支持以下自定义:

    • css.propertyEnd
    • css.valueSeparator
    • sass.propertyEnd
    • sass.valueSeparator
    • stylus.propertyEnd
    • stylus.valueSeparator
    • css.unitAliases
    • css.intUnit
    • css.floatUnit
    • bem.elementSeparator
    • bem.modifierSeparator
    • filter.commentBefore
    • filter.commentTrigger
    • filter.commentAfter
    • format.noIndentTags
    • format.forceIndentationForTags
    • profile.allowCompactBoolean
    • css.fuzzySearchMinScore

    Emmet 2.0 中 filter.commentAfter 首选项的格式不同且更简单。

    例如,而不是旧格式

    "emmet.preferences": {
      "filter.commentAfter": "\n<!-- /<%= attr('id', '#') %><%= attr('class', '.') %> -->"
    }
    

    您将使用

    "emmet.preferences": {
      "filter.commentAfter": "\n<!-- /[#ID][.CLASS] -->"
    }
    

    如果您想支持 Emmet 首选项 中记录的任何其他首选项,请提交一个 功能请求

后续步骤

Emmet 只是 VS Code 中众多出色的 Web 开发功能之一。继续阅读以了解有关

  • HTML - VS Code 提供带有 IntelliSense、自动闭合标签和格式化的 HTML 支持。
  • CSS - 我们为 CSS、SCSS 和 Less 提供丰富支持。

故障排除

自定义标签未在建议列表中展开

自定义标签在表达式(如 MyTag>YourTagMyTag.someclass)中使用时,会显示在建议列表中。但当它们单独使用时(如 MyTag),它们不会出现在建议列表中。这是为了避免建议列表中的噪音,因为每个单词都是一个潜在的自定义标签。

添加以下设置以启用使用 Tab 键展开 Emmet 缩写,这将始终展开自定义标签。

"emmet.triggerExpansionOnTab": true

我以 + 结尾的 HTML 代码片段不起作用

+ 结尾的 HTML 代码片段,如 Emmet 速查表 中的 select+ul+,不受支持。这是 Emmet 2.0 中的一个已知问题 Issue: emmetio/html-matcher#1。一种解决方法是为这些场景创建您自己的 自定义 Emmet 代码片段

缩写无法展开

首先,检查您是否正在使用自定义代码片段(如果存在由 emmet.extensionsPath 设置拾取的 snippets.json 文件)。自定义代码片段的格式在 VS Code release 1.53 中发生了变化。不再使用 | 来指示光标位置,而是使用 ${1}${2} 等标记。emmetio/emmet 存储库中的 默认 CSS 代码片段文件 显示了新光标位置格式的示例。

如果缩写仍然无法展开

  • 检查 内置扩展,看看 Emmet 是否已被禁用。
  • 尝试通过在 命令面板 中运行 Developer: Restart Extension Hostworkbench.action.restartExtensionHost)命令来重新启动扩展主机。

在哪里可以设置 Emmet 首选项 中记录的所有首选项?

您可以使用 emmet.preferences 设置来设置首选项。只有 Emmet 首选项 中记录的一部分首选项可以自定义。请阅读 Emmet 配置 下的首选项部分。

有什么技巧和窍门吗?

当然!

  • 在 CSS 缩写中,当您使用 : 时,左部分用于模糊匹配 CSS 属性名,右部分用于匹配 CSS 属性值。充分利用这一点,使用 pos:ftrf:rxfw:b 等缩写。
  • 探索 Emmet 文档 Emmet 操作 中记录的所有其他 Emmet 功能。
  • 不要犹豫创建您自己的 自定义 Emmet 代码片段
© . This site is unofficial and not affiliated with Microsoft.