为单个文件禁用更漂亮

Posted 2023-02-22

【中文标题】为单个文件禁用更漂亮

【英文标题】：Disable prettier for a single file

【发布时间】：2020-05-09 14:41:02

【问题描述】：

我需要在我的 Vs-code 项目中为 单个文件（API URL 文件）禁用 prettier。实际上，我需要将每个 API 及其 URL 放在一行中，但更漂亮地将它们分成两行。

之前

export const GET_SEARCH_TEACHERS = params => myexampleFunction_app_base(`teachers/search/$params.search`);

之后

export const GET_SEARCH_TEACHERS = params =>
myexampleFunction_app_base(`teachers/search/$params.search`);

【问题讨论】：

你可以发布一个正在发生的事情的例子吗？

您可能需要查阅文档以了解此类问题。 prettier.io/docs/en/ignore.htmlgithub.com/prettier/prettier/issues/3634

你提到的基于文档的 vs code 有一个包'Formatting Toggle'，但我不想安装新包。

github 链接中提到忽略 VSCode 中的单个文件并非易事，因此有人对其进行了扩展。如果您不想安装它，您可能需要自己实现。

我已经有了（请查看上面评论中的链接）

【参考方案1】：

感谢evolutionxbox，目前已经找到了几个解决方案。

忽略文件或文件夹

要从格式化中排除文件，请在项目root 中的.prettierignore 文件中添加条目或设置--ignore-path CLI 选项。 .prettierignore 使用 gitignore 语法。

/app/src/scripts/example.js
/app/src/folder/

基于扩展忽略

要根据扩展名排除文件，您也可以将条目添加到 .prettierignore 文件中

*.html.erb

忽略行

JavaScript

// prettier-ignore 的 javascript 注释将从格式化中排除抽象语法树中的下一个节点。

    matrix(
      1, 0, 0,
      0, 1, 0,
      0, 0, 1
    )

    // prettier-ignore
    matrix(
      1, 0, 0,
      0, 1, 0,
      0, 0, 1
    )

将转换为：

    matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);

    // prettier-ignore
    matrix(
      1, 0, 0,
      0, 1, 0,
      0, 0, 1
    )

JSX

    <div>
      /* prettier-ignore */
      <span     ugly  format=''   />
    </div>

更多：https://prettier.io/docs/en/ignore.html

使用扩展

当您需要时，我们可以使用扩展程序在特定页面上切换格式，例如更漂亮。

格式切换 https://marketplace.visualstudio.com/items?itemName=tombonnike.vscode-status-bar-format-toggle

【参考方案2】：

在您的存储库的根目录中创建 .prettierignore 文件，并添加您要忽略的文件夹的名称，并添加您要忽略的文件的完整路径并保存它。

使用 .gitignore 格式更新您的文件 你也可以在更漂亮的网站上阅读它https://prettier.io/docs/en/ignore.html#ignoring-files

【参考方案3】：

如果您希望 repo 中的某个文件永远不会被 prettier 格式化，您可以将其添加到 .prettierignore 文件中：Disable Prettier for one file

来自文档：

要从格式化中排除文件，请在 您项目的根目录。 .prettierignore 使用gitignore 语法。

例子：

# Ignore artifacts: 
build 
coverage

# Ignore all HTML files:
*.html 

【讨论】：

如果你想禁用整个东西，只需将 ** 放在 prettierignore 文件中