\n\n# Intro\n\nPrettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.\n\nThis plugin adds support for the Pug language to Prettier.\n\n---\n\n- [Getting started](#getting-started)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Workarounds / Known Issues](#workarounds--known-issues)\n- [Integration with editors](#integration-with-editors)\n- [Implementation details](#implementation-details)\n- [Contributing](#contributing)\n- [Credits](#credits)\n\n## Getting started\n\nSimply install `prettier` and `@prettier/plugin-pug` as your project’s `devDependencies`:\n\n```bash\nnpm add --save-dev prettier @prettier/plugin-pug\n# or\nyarn add --dev prettier @prettier/plugin-pug\n# or\npnpm add --save-dev prettier @prettier/plugin-pug\n```\n\n## Usage\n\n### CLI\n\n```bash\nnpx prettier --write \"**/*.pug\" --plugin=\"@prettier/plugin-pug\"\n# or\nyarn prettier --write \"**/*.pug\" --plugin=\"@prettier/plugin-pug\"\n# or\npnpm prettier --write \"**/*.pug\" --plugin=\"@prettier/plugin-pug\"\n```\n\n### Configuration file (.prettierrc)\n\n```json\n{\n \"plugins\": [\"@prettier/plugin-pug\"]\n}\n```\n\nSee [Standard Prettier overrides](https://prettier.github.io/plugin-pug/guide/standard-prettier-overrides.html) and [Pug specific options](https://prettier.github.io/plugin-pug/guide/pug-specific-options.html) for more options.\n\n### API\n\n```js\nawait prettier.format('code', {\n parser: 'pug',\n plugins: ['@prettier/plugin-pug'],\n});\n```\n\n## Workaround / Known Issue\n\nThere are some code examples that are not formatted well with this plugin and can damage your code. \nBut there are workarounds for it. These generate even better pug code!\n\n### Example\n\n[Issue 114](https://github.com/prettier/plugin-pug/issues/114)\n\nIf you have tags at the top/root that are indented, they will lose indentation due to a technical limitation of pug. \nPlease check these before committing after running this plugin for the first time and fix them manually.\n\n## Integration with editors\n\nIf you are using a text editor that supports Prettier integration (e.g. [Atom](https://atom.io/packages/prettier-atom)), you can have all Prettier perks for your Pug code too!\n\nUse [VSCode extension](https://github.com/prettier/prettier-vscode) to get support for [VSCode](https://code.visualstudio.com).\n\nIn order to get `@prettier/plugin-pug` working in projects that do not have local npm dependencies, you can install this plugin globally:\n\n```bash\nnpm install --global prettier @prettier/plugin-pug\n```\n\nIn this case, you might need to check the settings of your editor’s Prettier extension to make sure that a globally installed Prettier is used when it is not found in project dependencies (i.e. `package.json`).\n\nNevertheless, it is recommended to rely on local copies of `prettier` and `@prettier/plugin-pug` as this reduces the chance of formatting conflicts between project collaborators.\nThis may happen if different global versions of Prettier or its Pug plugin are used.\n\nInstalling `@prettier/plugin-pug` either locally or globally may require you to restart the editor if formatting does not work right away.\n\n## Implementation details\n\nThis plugin is written in TypeScript and its quality is maintained using Prettier and [Vitest](https://vitest.dev).\n\n## Contributing\n\nIf you’re interested in contributing to the development of Prettier for Pug, you can follow the [CONTRIBUTING guide from Prettier](https://github.com/prettier/prettier/blob/master/CONTRIBUTING.md), as it all applies to this repository too.\n\nTo run `@prettier/plugin-pug` locally:\n\n- Clone this repository.\n- Execute `pnpm run preflight`.\n\n## Credits\n\nThis project was inspired by https://github.com/gicentre/prettier-plugin-elm. \nMany thanks also to [@j-f1](https://github.com/j-f1), [@lipis](https://github.com/lipis) and [@azz](https://github.com/azz) for the help in transferring this repository to the prettier organization.\n\nThanks to [@fisker](https://github.com/fisker) for the constant help and support in terms of Prettier Core support.\n\nThanks to [@Peilonrayz](https://github.com/Peilonrayz), who gave me the [idea](https://codereview.stackexchange.com/a/236031/128216) to rewrite the printer into a [class](https://github.com/prettier/plugin-pug/commit/a6e3a4b776ce67f0d5d763aaf1f88c0c860c6ed3) and thus make the code a lot more maintainable.\n\nThanks to [@lehni](https://github.com/lehni), [@SkyaTura](https://github.com/SkyaTura) and [@shadowgate15](https://github.com/shadowgate15) for the massive contribution and the introduction of many new features into the project.\n\nThanks to [@maoberlehner](https://github.com/maoberlehner) to acknowledge `@prettier/plugin-pug` as officially well TTD tested at Vue Amsterdam 2023.\n","readmeFilename":"","users":{"flumpus-dev":true}}
![\"Prettier\"](\"https://cdn.rawgit.com/prettier/prettier-logo/master/images/prettier-icon-light.svg\"){kind=icon}
\n \n \n \n \n ![\"Pug\"](\"https://cdn.rawgit.com/pugjs/pug-logo/eec436cee8fd9d1726d7839cbe99d1f694692c0c/SVG/pug-final-logo-_-colour-128.svg\"){kind=logo}
\n \n \n![\"license:](\"https://img.shields.io/github/license/prettier/plugin-pug.svg?style=flat-square\")
\n ![\"NPM](\"https://img.shields.io/npm/v/@prettier/plugin-pug.svg?style=flat-square\")
\n ![\"downloads\"](\"https://img.shields.io/npm/dt/@prettier/plugin-pug.svg?style=flat-square\")
\n ![\"Code](\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square\"){kind=icon}
\n ![\"Build](\"https://github.com/prettier/plugin-pug/actions/workflows/ci.yml/badge.svg?branch=main\"){kind=icon}
\n