--- id: ignore title: Ignoring Code --- Use `.prettierignore` to ignore (i.e. not reformat) certain files and folders completely. Use “prettier-ignore” comments to ignore parts of files. ## Ignoring Files: .prettierignore To exclude files from formatting, create a `.prettierignore` file in the root of your project. `.prettierignore` uses [gitignore syntax](https://git-scm.com/docs/gitignore#_pattern_format). Example: ```text # Ignore artifacts: build coverage # Ignore all HTML files: **/*.html ``` It’s recommended to have a `.prettierignore` in your project! This way you can run `prettier --write .` to make sure that everything is formatted (without mangling files you don’t want, or choking on generated files). And – your editor will know which files _not_ to format! By default prettier ignores files in version control systems directories (".git", ".jj", ".sl", ".svn" and ".hg") and `node_modules` (unless the [`--with-node-modules` CLI option](cli.md#--with-node-modules) is specified). Prettier will also follow rules specified in the ".gitignore" file if it exists in the same directory from which it is run. So by default it will be ```text **/.git **/.svn **/.hg **/node_modules ``` and ```text **/.git **/.svn **/.hg ``` if [`--with-node-modules` CLI option](cli.md#--with-node-modules) provided (See also the [`--ignore-path` CLI option](cli.md#--ignore-path).) ## JavaScript A JavaScript comment of `// prettier-ignore` will exclude the next node in the abstract syntax tree from formatting. For example: ```js matrix( 1, 0, 0, 0, 1, 0, 0, 0, 1, ); // prettier-ignore matrix( 1, 0, 0, 0, 1, 0, 0, 0, 1, ); ``` will be transformed to: ```js matrix(1, 0, 0, 0, 1, 0, 0, 0, 1); // prettier-ignore matrix( 1, 0, 0, 0, 1, 0, 0, 0, 1, ); ``` ## JSX ```jsx
{/* prettier-ignore */}
``` ## HTML ```html
hello world
``` ## CSS ```css /* prettier-ignore */ .my ugly rule { } ``` ## Markdown ```markdown Do not format this ``` ### Range Ignore _available in v1.12.0+_ This type of ignore is only allowed to be used in top-level and aimed to disable formatting for auto-generated content, e.g. [`all-contributors`](https://github.com/kentcdodds/all-contributors), [`markdown-toc`](https://github.com/jonschlinkert/markdown-toc), etc. ```markdown | MY | AWESOME | AUTO-GENERATED | TABLE | |-|-|-|-| | a | b | c | d | ``` **Important:** You must have a blank line before `` and `` for Prettier to recognize the comments. ## YAML To ignore a part of a YAML file, `# prettier-ignore` should be placed on the line immediately above the ignored node: ```yaml # prettier-ignore key : value hello: world ``` ## GraphQL ```graphql { # prettier-ignore addReaction(input:{superLongInputFieldName:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}) { reaction {content} } } ``` ## Handlebars ```hbs {{! prettier-ignore }}
"hello! my parent was ignored" {{#my-crazy-component "shall" be="preserved"}} {{/my-crazy-component}}
``` ## Command Line File Patterns For one-off commands, when you want to exclude some files without adding them to `.prettierignore`, negative patterns can come in handy: ```bash prettier . "!**/*.{js,jsx,vue}" --write ``` See [fast-glob](https://prettier.io/docs/cli#file-patterns) to learn more about advanced glob syntax.