djlint 1.30.0 → 1.30.2

package/docs/src/docs/getting-started.md

@@ -1,126 +0,0 @@
----
-description: Getting started with djLint for HTML Template Linting and Formatting. Take advantage of the easy cli interface and many formatter options.
-title: Getting Started
-keywords: template linter, template formatter, djLint, HTML, templates, formatter, linter, usage
----
-
-# Getting Started
-
-## Installation from [Pypi](https://pypi.org/project/djlint/)
-
-djLint is build with [Python](https://python.org), it can be installed by simply running:
-
-```bash
-pip install djlint
-```
-
-_Or with the npm experimental install - Note, this requires python and pip to be on your system path._
-
-```bash
-npm i djlint
-```
-
-## CLI Usage
-
-djLint is a command line application. See `configuration` for advanced configuration.
-
-{% raw %}
-
-```bash
-Usage: djlint [OPTIONS] SRC ...
-
-  djLint · lint and reformat HTML templates.
-
-Options:
-  --version                       Show the version and exit.
-  -e, --extension TEXT            File extension to check [default: html]
-  -i, --ignore TEXT               Codes to ignore. ex: "H014,H017"
-  --reformat                      Reformat the file(s).
-  --check                         Check formatting on the file(s).
-  --indent INTEGER                Indent spacing. [default: 4]
-  --quiet                         Do not print diff when reformatting.
-  --profile TEXT                  Enable defaults by template language. ops:
-                                  django, jinja, nunjucks, handlebars, golang,
-                                  angular, html [default: html]
-  --require-pragma                Only format or lint files that starts with a
-                                  comment with the text 'djlint:on'
-  --lint                          Lint for common issues. [default option]
-  --use-gitignore                 Use .gitignore file to extend excludes.
-  --warn                          Return errors as warnings.
-  --preserve-leading-space        Attempt to preserve leading space on text.
-  --preserve-blank-lines          Attempt to preserve blank lines.
-  --format-css                    Also format contents of <style> tags.
-  --format-js                     Also format contents of <script> tags.
-  --configuration PATH            Path to global configuration file in
-                                  .djlintrc format
-  --statistics                    Count the number of occurrences of each
-                                  error/warning code.
-  --include TEXT                  Codes to include. ex: "H014,H017"
-  --ignore-case                   Do not fix case on known html tags.
-  --ignore-blocks TEXT            Comma list of template blocks to not indent.
-  --blank-line-after-tag TEXT     Add an additional blank line after {% <tag>
-                                  ... %} tag groups.
-  --blank-line-before-tag TEXT    Add an additional blank line before {% <tag>
-                                  ... %} tag groups.
-  --custom-blocks TEXT            Indent custom template blocks. For example
-                                  {% toc %}...{% endtoc %}
-  --custom-html TEXT              Indent custom HTML tags. For example <mjml>
-  --exclude TEXT                  Override the default exclude paths.
-  --extend-exclude TEXT           Add additional paths to the default exclude.
-  --linter-output-format TEXT     Customize order of linter output message.
-  --max-line-length INTEGER       Max line length. [default: 120]
-  --max-attribute-length INTEGER  Max attribute length. [default: 70]
-  --format-attribute-template-tags
-                                  Attempt to format template syntax inside of
-                                  tag attributes.
-  --per-file-ignores <TEXT TEXT>...
-                                  Ignore linter rules on a per-file basis.
-  --indent-css INTEGER            Set CSS indent level.
-  --indent-js INTEGER             Set JS indent level.
-  --close-void-tags               Add closing mark on known void tags. Ex:
-                                  <img> becomse <img />
-  --no-line-after-yaml            Do not add a blank line after yaml front
-                                  matter.
-  -h, --help                      Show this message and exit.
-```
-
-{% endraw %}
-{% admonition
-   "note",
-   "Note",
-   "If the command `djlint` is not found, ensure sure that Python is [in your path](https://www.geeksforgeeks.org/how-to-add-python-to-windows-path/)."
-%}
-
-## Using Path vs Stdin
-
-djLint works with a path or stdin.
-
-Running with a path -
-
-```bash
-djlint /path/to/templates --lint
-```
-
-Or a specific file -
-
-```bash
-djlint /path/to/this.mustache --lint
-```
-
-Or with stdin -
-
-```bash
-echo "<div></div>" | djlint -
-```
-
-Stdin can also be used to reformat code. The output will be only the formatted code without messages.
-
-```bash
-echo "<div></div>" | djlint - --reformat
-```
-
-Output -
-
-```html
-<div></div>
-```

package/docs/src/docs/ignoring-code.md

@@ -1,75 +0,0 @@
----
-description: How to prevent djLint from formatting a block of code. How ignore djLint rules inline.
-title: Ignoring Code
-keywords: template linter, template formatter, djLint, HTML, templates, formatter, linter, formatter usage, ignore code, ignore rules
-date: Last Modified
----
-
-# Ignoring Code
-
-Code can be ignored by wrapping it in `djlint` tags:
-
-{% raw %}
-
-For plain old html -
-
-```html
-<!-- djlint:off -->
-<bad html to ignore> <!-- djlint:on --></bad>
-```
-
-or as a comment -
-
-```html
-{# djlint:off #} <bad html to ignore> {# djlint:on #}</bad>
-```
-
-or as a long comment -
-
-```html
-{% comment %} djlint:off {% endcomment %}
-<bad html to ignore> {% comment %} djlint:on {% endcomment %}</bad>
-```
-
-or as a javascript style comment -
-
-```html
-{{ /* djlint:off */ }} <bad html to ignore> {{ /* djlint:on */ }}</bad>
-```
-
-or as a golang style comment -
-
-```html
-{{!-- djlint:off --}} <bad html to ignore> {{!-- djlint:on --}}</bad>
-```
-
-{% endraw %}
-
-## Ignoring Rules
-
-Specific linter rules can also be ignored by adding the rule name into the ignored block opening tag.
-
-{% raw %}
-
-```html
-{# djlint:off H025,H026 #}
-<p>
-  {# djlint:on #}
-
-  <!-- djlint:off H025-->
-</p>
-
-<p>
-  <!-- djlint:on -->
-
-  {% comment %} djlint:off H025 {% endcomment %}
-</p>
-
-<p>{% comment %} djlint:on {% endcomment %} {{!-- djlint:off H025 --}}</p>
-
-<p>{{!-- djlint:on --}} {{ /* djlint:off H025 */ }}</p>
-
-<p>{{ /* djlint:on */ }}</p>
-```
-
-{% endraw %}

package/docs/src/docs/integrations.md

@@ -1,120 +0,0 @@
----
-description: Integrate djLint with your favorite editor. Auto format your templates with Pre-Commit. Lint with SublimeText.
-title: Integrations
-keywords: template linter, template formatter, djLint, HTML, templates, formatter, linter, integrations
----
-
-# Integrations
-
-There are several editor integrations build for djLint.
-
-## Pre-Commit
-
-djLint can be used as a [pre-commit](https://pre-commit.com) hook as both a linter and a formatter.
-
-The repo provides multiple pre-configured hooks for specific djLint profiles (it just pre-sets the `--profile` argument and tells pre-commit which file extensions to look for):
-
-::: content
-
-- `djlint` for linting and `djlint-reformat` for formatting
-  This will look for files matching `templates/**.html` without setting `--profile`.
-- `djlint-django` and `djlint-reformat-django`
-  This will look for files matching `templates/**.html` and set `--profile=django`.
-- `djlint-jinja` and `djlint-reformat-jinja`
-  This will look for files matching `*.j2`,`*.jinja` or `*.jinja2` and set `--profile=jinja`.
-- `djlint-nunjucks` and `djlint-reformat-nunjucks`
-  This will look for files matching `*.njk` and set `--profile=nunjucks`.
-- `djlint-handlebars` and `djlint-reformat-handlebars`
-  This will look for files matching `*.hbs` and set `--profile=handlebars`.
-- `djlint-golang` and `djlint-reformat-golang`
-  This will look for files matching `*.tmpl` and set `--profile=golang`.
-  :::
-
-Note that these predefined hooks are sometimes too conservative in the inputs they accept (your templates may be using a different extension) so pre-commit explicitly allows you to override any of these pre-defined options. See the [pre-commit docs](https://pre-commit.com/#pre-commit-configyaml---hooks) for additional configuration
-
-### Default Django example
-
-```yaml
-repos:
-  - repo: https://github.com/Riverside-Healthcare/djLint
-    rev: v{{ djlint_version }}
-    hooks:
-      - id: djlint-reformat-django
-      - id: djlint-django
-```
-
-### Handlebars with .html extension instead of .hbs
-
-```yaml
-repos:
-  - repo: https://github.com/Riverside-Healthcare/djLint
-    rev: v{{ djlint_version }}
-    hooks:
-      - id: djlint-reformat-handlebars
-        files: "\\.html"
-        types_or: ['html']
-      - id: djlint-handlebars
-        files: "\\.html"
-        types_or: ['html']
-```
-
-You can use the `files` or `exclude` parameters to constrain each hook to its own directory, allowing you to support multiple template languages within the same repo.
-
-## SublimeText Linter
-
-djLint can be used as a SublimeText Linter plugin. It can be installed via [package-control](https://packagecontrol.io/packages/SublimeLinter-contrib-djlint).
-
-::: content
-
-1. `cmd + shift + p`
-2. Install SublimeLinter
-3. Install SublimeLinter-contrib-djlint
-   :::
-
-Ensure djLint is installed in your global python, or on your `PATH`.
-
-## Visual Studio Code
-
-::: content
-
-- [GitHub repository](https://github.com/monosans/djlint-vscode)
-- [VS Marketplace page](https://marketplace.visualstudio.com/items?itemName=monosans.djlint)
-- [Open VSX page](https://open-vsx.org/extension/monosans/djlint)
-  :::
-
-## neovim
-
-djLint can use used as formatter in neovim using the `null-ls` plugin.
-
-::: content
-
-- [GitHub repository](https://github.com/jose-elias-alvarez/null-ls.nvim/)
-- [Config example](https://github.com/shaeinst/roshnivim/blob/5d991fcfa1b8f865f9653a98c6d97a829d4a2add/lua/plugins/null-ls_nvim.lua#L84-L91)
-  :::
-
-## coc.nvim
-
-::: content
-
-- [npm package](https://www.npmjs.com/package/coc-htmldjango)
-  :::
-
-## null-ls.nvim
-
-::: content
-
-- [GitHub repository](https://github.com/jose-elias-alvarez/null-ls.nvim)
-- [Lint](https://github.com/jose-elias-alvarez/null-ls.nvim/blob/main/lua/null-ls/builtins/diagnostics/djlint.lua#L14)
-- [Format](https://github.com/jose-elias-alvarez/null-ls.nvim/blob/main/lua/null-ls/builtins/formatting/djlint.lua#L13)
-
-## MegaLinter
-
-djlint is natively embedded within the 100+ linters of [MegaLinter](https://megalinter.io)
-
-To install it, just run `npx mega-linter-runner --install` and follow instructions
-
-::: content
-
-- [GitHub repository](https://github.com/oxsecurity/megalinter)
-- [djlint in MegaLinter documentation](https://megalinter.io/latest/descriptors/html_djlint/)
-  :::

package/docs/src/docs/languages/angular.md

@@ -1,31 +0,0 @@
----
-title: Angular Template Linter
-keywords: angular, djlint, angular template linter, lint angular templates
-description: djLint is a angular template linter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: angular
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is Angular?](https://angular.io/guide/template-syntax)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>

package/docs/src/docs/languages/django.md

@@ -1,40 +0,0 @@
----
-title: Django Template Linter and Formatter
-keywords: django, djlint, django template linter, django template formatter, format django templates
-description: djLint is a django template linter and a django template formatter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: django
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is Django?](https://django.readthedocs.io/en/stable/ref/templates/language.html)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>
-
-## Real Life Examples!
-
-<div class="mb-5">
-
-- [Django](https://github.com/django/django) source code [reformatted](https://github.com/Riverside-Healthcare/djLint/compare/django-source...Riverside-Healthcare:djLint:django-djlint)
-- [Wagtail](https://github.com/wagtail/wagtail) source code [reformatted](https://github.com/Riverside-Healthcare/djLint/compare/wagtail-source...Riverside-Healthcare:djLint:wagtail-djlint)
-
-</div>

package/docs/src/docs/languages/golang.md

@@ -1,31 +0,0 @@
----
-title: GoLang Template Linter and Formatter
-keywords: GoLang, djlint, GoLang template linter, GoLang template formatter, format GoLang templates
-description: djLint is a GoLang template linter and a GoLang template formatter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: golang
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is GoLang?](https://pkg.go.dev/text/template)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>

package/docs/src/docs/languages/handlebars.md

@@ -1,31 +0,0 @@
----
-title: Handlebars Template Linter and Formatter
-keywords: handlebars, djlint, handlebars template linter, handlebars template formatter, format handlebars templates
-description: djLint is a handlebars template linter and a handlebars template formatter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: handlebars
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is Handlebars?](https://handlebarsjs.com/)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>

package/docs/src/docs/languages/jinja.md

@@ -1,39 +0,0 @@
----
-title: Jinja Template Linter and Formatter
-keywords: jinja, djlint, jinja template linter, jinja template formatter, format jinja templates
-description: djLint is a jinja template linter and a jinja template formatter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: jinja
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is Jinja?](https://jinja2docs.readthedocs.io/en/stable/)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>
-
-## Real Life Examples!
-
-<div class="mb-5">
-
-- [Pallets](https://github.com/pallets/website) source code [reformatted](https://github.com/Riverside-Healthcare/djLint/compare/pallets-source...Riverside-Healthcare:djLint:pallets-djlint)
-
-</div>

package/docs/src/docs/languages/languages.json

@@ -1,3 +0,0 @@
-{
-  "layout": "languages_layout.njk"
-}

package/docs/src/docs/languages/mustache.md

@@ -1,31 +0,0 @@
----
-title: Mustache Template Linter and Formatter
-keywords: mustache, djlint, mustache template linter, mustache template formatter, format mustache templates
-description: djLint is a mustache template linter and a mustache template formatter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: handlebars
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is Mustache?](http://mustache.github.io/mustache.5.html)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>

package/docs/src/docs/languages/nunjucks.md

@@ -1,39 +0,0 @@
----
-title: Nunjucks Template Linter and Formatter
-keywords: nunjucks, djlint, nunjucks template linter, nunjucks template formatter, format nunjucks templates
-description: djLint is a nunjucks template linter and a nunjucks template formatter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: nunjucks
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is Nunjucks?](https://mozilla.github.io/nunjucks/)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>
-
-## Real Life Examples!
-
-<div class="mb-5">
-
-- [apostrophe](https://github.com/apostrophecms/apostrophe) source code [reformatted](https://github.com/Riverside-Healthcare/djLint/compare/apostrophe-source...Riverside-Healthcare:djLint:apostrophe-djlint)
-
-</div>

package/docs/src/docs/languages/twig.md

@@ -1,41 +0,0 @@
----
-title: Twig Template Linter and Formatter
-keywords: twig, djlint, twig template linter, twig template formatter, format twig templates
-description: djLint is a twig template linter and a twig template formatter! Take advantage of the pre-build profile when linting and formatting your templates with djLint.
-tool: nunjucks
----
-
-# {{ title }}
-
-{{ description }}
-
-**[What is Twig?](https://twig.symfony.com/)**
-
-#### Using the Command Line
-
-```bash
-djlint /path/to/templates --profile={{ tool }}
-```
-
-#### Or, Use a Config File
-
-Configure djLint in your projects `pyproject.toml`.
-
-```toml
-[tool.djlint]
-profile="{{ tool }}"
-```
-
-<div class="box notification is-info is-light">
-    <span class="icon is-large"><i class="fas fa-2x fa-circle-arrow-right"></i></span><div class="my-auto ml-3 is-inline-block"><a href="/docs/configuration/">Check out the configuration guide for all the options!</a></div>
-</div>
-
-## Real Life Examples!
-
-<div class="mb-5">
-
-- [bolt](https://github.com/bolt/core) source code [reformatted](https://github.com/Riverside-Healthcare/djLint/compare/bolt-source...Riverside-Healthcare:djLint:bolt-djlint)
-
-- [Sylius](https://github.com/Sylius/Sylius) source code [reformatted](https://github.com/Riverside-Healthcare/djLint/compare/sylius-source...Riverside-Healthcare:djLint:sylius-djlint)
-
-</div>