Skip to content

SmileyChris/prettier-plugin-jinja-template

 
 

Repository files navigation

prettier-plugin-jinja-template

Formatter plugin for jinja2 template files.

Install

npm install --save-dev prettier prettier-plugin-jinja-template

Add the plugin to your .prettierrc:

{
  "plugins": ["prettier-plugin-jinja-template"]
}

Use

To format basic .html files, you'll have to override the used parser inside your .prettierrc:

{
  "overrides": [
    {
      "files": ["*.html"],
      "options": {
        "parser": "jinja-template"
      }
    }
  ]
}

Run it on all html files in your project:

npx prettier --write **/*.html

If you don't have a prettier config you can run the plugin with this command:

npx prettier --write **/*.html --plugin=prettier-plugin-jinja-template

Ignoring Code

Using range ignores is the best way to tell prettier to igone part of files. Most of the time this is necessary for Jinja tags inside script or style tags:

<!-- prettier-ignore-start -->
  <script>
    window.someData = {{ data | safe }}
  </script>
<!-- prettier-ignore-end -->

<!-- prettier-ignore-start -->
  <style>
    :root { --accent-color: {{ theme_accent_color }} }
  </style>
<!-- prettier-ignore-end -->

Options

This Plugin provides additional options:

Quote Attributes

Surrounds the value of html attributes with quotes. This option was introduced to support JinjaX syntax.

true - Example:

<Paginator items="{products}" />

false - Example:

<Paginator items={products} />
Default CLI Override API Override
true --no-quote-attributes quoteAttributes: <bool>

About

Formatter plugin for jinja2 template files.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 60.8%
  • HTML 38.6%
  • JavaScript 0.6%