Jinja2 Enhance

Jinja2 Enhance is a Visual Studio Code extension that adds syntax highlighting support for the Jinja2 templating language inside .html files and provides variable checking functionality. It extends the native HTML highlighting with additional rules for Jinja2, allowing seamless editing of templates that mix both HTML and Jinja2.

Donations

If you find this extension helpful, consider supporting the developer by buying them a coffee:

1.10.0 Has Been Released!

This release includes new themes and an updated theme selection feature. You can now choose from multiple themes to customize your Jinja2 syntax highlighting experience.

Features

• Jinja2 Enhance:

  • Supports Jinja2 control structures like {% for %}, {% if %}, {% block %}, etc.
  • Highlights variable interpolation using {{ }} syntax.
  • Keywords like for, if, block are highlighted with a distinct color for better readability.
  • Pipe filters like capitalize, default, length, lower, etc., are highlighted after the pipe (|).

• HTML and Jinja2 Together:

  • Maintains the standard HTML syntax highlighting while injecting Jinja2 rules.
  • Useful for projects that use Jinja2 templating language for dynamic content within HTML.

• Variable Checking:

  • Analyzes Jinja2 templates to identify used and set variables.
  • Provides warnings for variables that are used but not set within the template.
  • Recognizes variables set in various contexts, including {% set %} statements and {% for %} loops.
  • Automatically checks variables on file save and provides a command to manually trigger checking.

• UI Variable Panel:

  • Displays a panel in the sidebar that shows the variables used and set in the current template.
  • Update the panel by saving the file or manually triggering variable checking.

• Save variables in configuration:

  • Save the variables in the configuration file to avoid rechecking the variables every time you open the file.
  • This feature is useful for large files with many variables, and it works with the quick fix vscode feature.

• Toggle Variable Checking:

  • Allows you to toggle the variable checking feature on and off.
  • Useful for debugging or when you want to temporarily disable variable checking.
  • Use command "Toggle check jinja2 variable check" to toggle the feature.
  • Use configuration Toggle check jinja2 variable check to set the variable checking feature.

• Theme Support:

  • Choose from multiple themes for Jinja2 syntax highlighting.
  • You can select a theme using the command "Choose Jinja2 Theme" from the command palette (Ctrl+Shift+P).
  • Themes include:
    • Dark Default
    • Light Default
    • Dark High Contrast
    • Light High Contrast
    • Xuby Selection (custom theme)
  • Also you can change the theme colors on your settings:
  • Enter "editor.tokenColorCustomizations": { "textMateRules": [] } in your settings.json file.

Example

Here's an example of the syntax highlighting in action:

And here's an example of the variable checking and UI variable panel:

And here's an example of the variable saving in the configuration file:

Theme Selection

You can choose from multiple themes for Jinja2 syntax highlighting. To select a theme, use the command "Choose Jinja2 Theme" from the command palette (Ctrl+Shift+P). The available themes are:

Dark Default theme, which provides a dark background with contrasting colors for Jinja2 syntax.

Light Default theme, which provides a light background with contrasting colors for Jinja2 syntax.

Dark High Contrast theme, which provides a high contrast dark background for better visibility.

Light High Contrast theme, which provides a high contrast light background for better visibility.

Xuby Selection theme, which is a custom theme with unique colors for Jinja2 syntax.

Installation

1. Open Visual Studio Code.
2. Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or press Ctrl+Shift+X.
3. Search for Jinja2 Enhance.
4. Click Install.

Alternatively, you can install the extension from the Visual Studio Code Marketplace.

Usage

1. Open a file with the .html extension.
2. The extension will automatically apply syntax highlighting to both HTML and Jinja2 templating language.
3. Variable checking will occur automatically when you save the file.
4. To manually check variables, use the command "Check Jinja2 Variables" from the command palette (Ctrl+Shift+P).
5. The UI variable panel will display the variables, use the command "Open jinja2 Variable Panel" to open it.
6. Warnings for undefined variables will appear as diagnostics in your editor.

Supported Jinja2 Syntax

• {% for %}, {% if %}, {% block %}, and other control structures.
• {{ variable }} for variable interpolation.
• {% extends %}, {% include %}, {% set %}, {% import %}, {% macro %}, and more.
• Pipe filters like | capitalize, | default, | length, | lower, | upper, etc.

Customization

You can customize the colors used for Jinja2 syntax highlighting by modifying your VSCode theme settings. For example, to change the color of keywords and filters, you can add the following to your settings:

Contributing

If you want to contribute to this project, feel free to submit issues or pull requests in the GitHub repository

License

This project is licensed under the MIT License - see the LICENSE file for details.