メインコンテンツへスキップ

コードの無視

非公式ベータ版翻訳

このページは PageTurner AI で翻訳されました（ベータ版）。プロジェクト公式の承認はありません。 エラーを見つけましたか？ 問題を報告 →

特定のファイルやフォルダを完全に無視（つまり再フォーマットしない）するには.prettierignoreを使用します。

ファイルの一部を無視するには「prettier-ignore」コメントを使用します。

ファイルの無視: .prettierignore​

フォーマットから除外するファイルを指定するには、プロジェクトルートに.prettierignoreファイルを作成します。.prettierignoreはgitignore構文を使用します。

例:

# Ignore artifacts:
build
coverage

# Ignore all HTML files:
**/*.html

プロジェクトに.prettierignoreを設置することを推奨します！これによりprettier --write .を実行して全てがフォーマットされることを保証しつつ（不要なファイルを破壊したり、自動生成ファイルでエラーを起こしたりせず）、エディタもどのファイルをフォーマットすべきでないかを認識できます！

デフォルトでは、Prettierはバージョン管理システムディレクトリ（".git", ".jj", ".sl", ".svn", ".hg"）とnode_modulesを無視します（--with-node-modules CLIオプションが指定されていない場合）。また、実行ディレクトリに".gitignore"が存在する場合、そのルールに従います。

従ってデフォルトでは

**/.git
**/.svn
**/.hg
**/node_modules

となり、

**/.git
**/.svn
**/.hg

--with-node-modules CLIオプションが指定された場合は

（--ignore-path CLIオプションも参照してください）

JavaScript​

// prettier-ignoreというJavaScriptコメントは、抽象構文木（AST）において次のノードをフォーマット対象から除外します。

例:

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>

HTML​

<!-- prettier-ignore -->
<div         class="x"       >hello world</div            >

<!-- prettier-ignore-attribute -->
<div
  (mousedown)="       onStart    (    )         "
  (mouseup)="         onEnd      (    )         "
></div>

<!-- prettier-ignore-attribute (mouseup) -->
<div
  (mousedown)="onStart()"
  (mouseup)="         onEnd      (    )         "
></div>

CSS​

/* prettier-ignore */
.my    ugly rule
{

}

Markdown​

<!-- prettier-ignore -->
Do   not    format   this

範囲指定での無視​

v1.12.0以降で利用可能

この無視方法はトップレベルでのみ使用可能で、自動生成コンテンツ（例: all-contributors, markdown-tocなど）のフォーマットを無効化することを目的としています。

<!-- prettier-ignore-start -->
<!-- SOMETHING AUTO-GENERATED BY TOOLS - START -->

| MY | AWESOME | AUTO-GENERATED | TABLE |
|-|-|-|-|
| a | b | c | d |

<!-- SOMETHING AUTO-GENERATED BY TOOLS - END -->
<!-- prettier-ignore-end -->

重要: Prettierがコメントを認識するには、<!-- prettier-ignore-start -->と<!-- prettier-ignore-end -->の前に空行が必要です。

YAML​

YAMLファイルの一部を無視するには、無視対象ノードの直前行に# prettier-ignoreを配置します:

# prettier-ignore
key  : value
hello: world

GraphQL​

{
  # prettier-ignore
  addReaction(input:{superLongInputFieldName:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}) {
    reaction {content}
  }
}

Handlebars​

{{! prettier-ignore }}
<div>
  "hello! my parent was ignored"
  {{#my-crazy-component     "shall"     be="preserved"}}
    <This
      is  =  "also preserved as is"
    />
  {{/my-crazy-component}}
</div>

コマンドラインのファイルパターン​

一時的なコマンド実行時に、.prettierignoreに追加せずにファイルを除外したい場合、否定パターンが便利です:

prettier . "!**/*.{js,jsx,vue}" --write

高度なglob構文についてはfast-globを参照してください。