Formatting Toggle

Formatting Toggle是一款为Visual Studio Code（VS Code）设计的扩展工具，允许您通过简单的一键操作来切换格式化设置的开启与关闭，极大地简化了开发过程。

安装

在命令面板中（CMD SHIFT P），选择“安装扩展”，然后选择“Formatting Toggle”进行安装。

使用

安装后，该扩展将显示在状态栏的右侧。您只需点击它即可切换格式化设置的开启与关闭。此外，您也可以在命令面板中（CMD SHIFT P）运行“Toggle Formatting”命令。

⚠️ 注意：Formatting Toggle不会覆盖您的工作区设置，因为这些设置通常由Git跟踪。如果需要忽略特定文件，建议使用忽略配置文件（如.prettierignore），以便项目所有贡献者都能忽略这些文件。

自定义

默认情况下，Formatting Toggle会切换所有格式化设置：editor.formatOnPaste、editor.formatOnSave和editor.formatOnType。要切换不同的设置，或防止某个特定设置被切换，您可以在编辑器设置中（代码›首选项›设置）使用formattingToggle.affects设置进行配置。

? Formatting Toggle最初是为格式化设置设计的，但它允许您切换位于VSCode配置根部的任何布尔设置。目前，editor.codeActionsOnSave是唯一支持的深层嵌套设置。

状态栏文本也可以通过formattingToggle.statusBarText设置进行自定义。formattingEnabled和formattingDisabled的值是不同的，可以为每个状态设置不同的codicons。请参阅产品图标参考以了解所有选项。

示例

始终保持editor.formatOnPaste和editor.formatOnType启用：

{
  "editor.formatOnPaste": true,
  "editor.formatOnType": true,
  "formattingToggle.affects": ["editor.formatOnSave"]
}

始终保持editor.formatOnType禁用：

{
  "editor.formatOnType": false,
  "formattingToggle.affects": ["editor.formatOnPaste", "editor.formatOnSave"]
}

允许editor.codeActionsOnSave被切换：

{
  "formattingToggle.affects": ["editor.codeActionsOnSave.source.fixAll.eslint"]
}

允许所有格式化设置被切换（默认）：

{
  "formattingToggle.affects": [
    "editor.formatOnPaste",
    "editor.formatOnSave",
    "editor.formatOnType"
  ]
}

自定义状态栏文本：

{
  "formattingToggle.statusBarText": {
    "formattingEnabled": "On $(heart-filled)",
    "formattingDisabled": "Off $(heart)"
  },
}