djlint 1.28.0 → 1.30.0

package/pyproject.toml

@@ -0,0 +1,100 @@
+[build-system]
+requires = ["poetry_core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool]
+
+[tool.poetry]
+name="djlint"
+version="1.30.0"
+description="HTML Template Linter and Formatter"
+license="GPL-3.0-or-later"
+authors=["Christopher Pickering <cpickering@rhc.net>"]
+maintainers=["Christopher Pickering <cpickering@rhc.net>"]
+readme="README.md"
+repository="https://github.com/Riverside-Healthcare/djlint"
+documentation="https://djlint.com"
+classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+        "Operating System :: OS Independent",
+    ]
+packages = [
+    { include = "djlint", from = "src" },
+]
+include = ["rules.yaml"]
+
+[tool.poetry.dependencies]
+python = "^3.8.0,<4.0"
+click = "^8.0.1"
+PyYAML = "^6.0"
+colorama = "^0.4.4"
+regex = "^2023.0.0"
+tqdm = "^4.62.2"
+tomli = { version = "^2.0.1", python = "<3.11" }
+pathspec = "^0.11.0"
+html-void-elements = "^0.1.0"
+html-tag-names = "^0.1.2"
+jsbeautifier = "^1.14.4"
+cssbeautifier = "^1.14.4"
+json5 = "^0.9.11"
+
+[tool.poetry.scripts]
+djlint = "djlint:main"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^23.1.0"
+isort = "^5.12.0"
+coverage = "^7.2.2"
+pytest = "^7.2.2"
+pytest-cov = "^4.0.0"
+pytest-xdist = "^3.2.1"
+ruff = "^0.0.270"
+mypy = "^1.1.1"
+types-pyyaml = "^6.0.12.8"
+tox = "^4.4.8"
+
+[tool.black]
+max_line_length = 99
+quiet = true
+
+[tool.isort]
+profile = "black"
+quiet = true
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 146
+select = [
+    "A",
+    "C4",
+    "D",
+    "DJ",
+    "E",
+    "F",
+    "I",
+    "N",
+    "PL",
+    "PT",
+    "SIM",
+    "T20",
+    "W",
+]
+target-version = "py311"
+ignore = ["E501", "PLR0913", "PLR0915", "PLR0912", "D203", "D213"]
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["N802", "D103", "T201", "D104", "PLR0915", "PLR2004"]
+"src/djlint/__init__.py" = ["D403"]
+"src/djlint/formatter/__init__.py" = ["D104"]
+"src/djlint/formatter/css.py" = ["PLW2901"]
+"src/djlint/formatter/js.py" = ["PLW2901"]
+"src/djlint/lint.py" = ["PLW2901"]
+"src/djlint/formatter/indent.py" = ["SIM114", "E722"]
+
+[tool.ruff.mccabe]
+max-complexity = 10

package/renovate.json

@@ -0,0 +1,44 @@
+{
+  "extends": [
+    "config:base",
+    "group:allNonMajor",
+    ":separateMultipleMajorReleases",
+    ":ignoreUnstable",
+    ":enableVulnerabilityAlertsWithLabel(security)",
+    ":rebaseStalePrs",
+    ":npm",
+    "npm:unpublishSafe"
+  ],
+  "bumpVersion": "patch",
+  "commitMessagePrefix": "chore(deps)",
+  "labels": [
+    "maintenance",
+    "renovate"
+  ],
+  "baseBranches": ["dev"],
+  "packageRules": [
+    {
+      "matchUpdateTypes": ["pin","digest", "minor", "patch"],
+      "automerge": true
+    },
+    {
+      "matchDepTypes": ["devDependencies"],
+      "automerge": true
+    },
+    {
+      "extends": "packages:linters",
+      "groupName": "linters",
+      "automerge": true
+    },
+    {
+      "extends": "packages:test",
+      "groupName": "test packages",
+      "automerge": true
+    }
+  ],
+  "pre-commit": {
+    "enabled": true
+  },
+  "schedule": ["before 10pm on Sunday"],
+  "timezone": "America/Chicago"
+}

package/scripts/updateVersion.js

@@ -0,0 +1,16 @@
+const fs = require('fs/promises');
+const prettier = require('prettier');
+
+const updateVersion = async () => {
+  const nextVersion = process.argv[2];
+  const packageJson = JSON.parse(
+    (await fs.readFile('package.json')).toString(),
+  );
+  packageJson.scripts.postinstall = `python3 -m pip install --upgrade djlint==${nextVersion}`;
+  await fs.writeFile(
+    'package.json',
+    prettier.format(JSON.stringify(packageJson), { filepath: 'package.json' }),
+  );
+};
+
+updateVersion();

package/src/djlint/__init__.py

@@ -0,0 +1,451 @@
+#!/usr/bin/python
+"""djLint · lint and reformat HTML templates."""
+
+import os
+import sys
+import tempfile
+from concurrent.futures import ProcessPoolExecutor, as_completed
+from functools import partial
+from pathlib import Path
+from typing import Dict, List, Optional, Tuple
+
+import click
+from click import echo
+from colorama import Fore, Style, colorama_text
+from tqdm import tqdm
+
+from .lint import lint_file
+from .output import print_output
+from .reformat import reformat_file
+from .settings import Config
+from .src import get_src
+
+
+@click.command(context_settings={"help_option_names": ["-h", "--help"]})
+@click.argument(
+    "src",
+    type=click.Path(
+        exists=True, file_okay=True, dir_okay=True, readable=True, allow_dash=True
+    ),
+    nargs=-1,
+    required=True,
+    metavar="SRC ...",
+)
+@click.version_option(package_name="djlint")
+@click.option(
+    "-e",
+    "--extension",
+    type=str,
+    default="",
+    help="File extension to check [default: html]",
+    show_default=False,
+)
+@click.option(
+    "-i",
+    "--ignore",
+    type=str,
+    default="",
+    help='Codes to ignore. ex: "H014,H017"',
+    show_default=False,
+)
+@click.option(
+    "--reformat",
+    is_flag=True,
+    help="Reformat the file(s).",
+)
+@click.option(
+    "--check",
+    is_flag=True,
+    help="Check formatting on the file(s).",
+)
+@click.option(
+    "--indent",
+    type=int,
+    help="Indent spacing. [default: 4]",
+    show_default=False,
+)
+@click.option(
+    "--quiet",
+    is_flag=True,
+    help="Do not print diff when reformatting.",
+)
+@click.option(
+    "--profile",
+    type=str,
+    help="Enable defaults by template language. ops: django, jinja, nunjucks, handlebars, golang, angular, html [default: html]",
+)
+@click.option(
+    "--require-pragma",
+    is_flag=True,
+    help="Only format or lint files that starts with a comment with the text 'djlint:on'",
+)
+@click.option(
+    "--lint",
+    is_flag=True,
+    help="Lint for common issues. [default option]",
+)
+@click.option(
+    "--use-gitignore",
+    is_flag=True,
+    help="Use .gitignore file to extend excludes.",
+)
+@click.option(
+    "--warn",
+    is_flag=True,
+    help="Return errors as warnings.",
+)
+@click.option(
+    "--preserve-leading-space",
+    is_flag=True,
+    help="Attempt to preserve leading space on text.",
+)
+@click.option(
+    "--preserve-blank-lines",
+    is_flag=True,
+    help="Attempt to preserve blank lines.",
+)
+@click.option(
+    "--format-css",
+    is_flag=True,
+    help="Also format contents of <style> tags.",
+)
+@click.option(
+    "--format-js",
+    is_flag=True,
+    help="Also format contents of <script> tags.",
+)
+@click.option(
+    "--configuration",
+    type=click.Path(
+        exists=True, file_okay=True, dir_okay=True, readable=True, allow_dash=True
+    ),
+    required=False,
+    help="Path to global configuration file in .djlintrc format",
+)
+@click.option(
+    "--statistics",
+    is_flag=True,
+    help="Count the number of occurrences of each error/warning code.",
+)
+@click.option(
+    "--include",
+    type=str,
+    default="",
+    help='Codes to include. ex: "H014,H017"',
+    show_default=False,
+)
+@click.option(
+    "--ignore-case",
+    is_flag=True,
+    help="Do not fix case on known html tags.",
+)
+@click.option(
+    "--ignore-blocks",
+    type=str,
+    default="",
+    help="Comma list of template blocks to not indent.",
+)
+@click.option(
+    "--blank-line-after-tag",
+    type=str,
+    default="",
+    help="Add an additional blank line after {% <tag> ... %} tag groups.",
+)
+@click.option(
+    "--blank-line-before-tag",
+    type=str,
+    default="",
+    help="Add an additional blank line before {% <tag> ... %} tag groups.",
+)
+@click.option(
+    "--line-break-after-multiline-tag",
+    is_flag=True,
+    help="Do not condense the content of multi-line tags into the line of the last attribute.",
+)
+@click.option(
+    "--custom-blocks",
+    type=str,
+    default="",
+    help="Indent custom template blocks. For example {% toc %}...{% endtoc %}",
+)
+@click.option(
+    "--custom-html",
+    type=str,
+    default="",
+    help="Indent custom HTML tags. For example <mjml>",
+)
+@click.option(
+    "--exclude",
+    type=str,
+    default="",
+    help="Override the default exclude paths.",
+)
+@click.option(
+    "--extend-exclude",
+    type=str,
+    default="",
+    help="Add additional paths to the default exclude.",
+)
+@click.option(
+    "--linter-output-format",
+    type=str,
+    default="",
+    help="Customize order of linter output message.",
+)
+@click.option(
+    "--max-line-length",
+    type=int,
+    help="Max line length. [default: 120]",
+    show_default=False,
+)
+@click.option(
+    "--max-attribute-length",
+    type=int,
+    help="Max attribute length. [default: 70]",
+    show_default=False,
+)
+@click.option(
+    "--format-attribute-template-tags",
+    is_flag=True,
+    help="Attempt to format template syntax inside of tag attributes.",
+)
+@click.option(
+    "--per-file-ignores",
+    type=(str, str),
+    multiple=True,
+    help="Ignore linter rules on a per-file basis.",
+)
+@click.option(
+    "--indent-css",
+    type=int,
+    help="Set CSS indent level.",
+    show_default=False,
+)
+@click.option(
+    "--indent-js",
+    type=int,
+    help="Set JS indent level.",
+    show_default=False,
+)
+@click.option(
+    "--close-void-tags",
+    is_flag=True,
+    help="Add closing mark on known void tags. Ex: <img> becomse <img />",
+)
+@click.option(
+    "--no-line-after-yaml",
+    is_flag=True,
+    help="Do not add a blank line after yaml front matter.",
+)
+@colorama_text(autoreset=True)
+def main(
+    src: List[str],
+    extension: str,
+    ignore: str,
+    reformat: bool,
+    indent: Optional[int],
+    check: bool,
+    quiet: bool,
+    profile: str,
+    require_pragma: bool,
+    lint: bool,
+    use_gitignore: bool,
+    warn: bool,
+    preserve_leading_space: bool,
+    preserve_blank_lines: bool,
+    format_css: bool,
+    format_js: bool,
+    configuration: Optional[str],
+    statistics: bool,
+    include: str,
+    ignore_case: bool,
+    ignore_blocks: str,
+    blank_line_after_tag: str,
+    blank_line_before_tag: str,
+    line_break_after_multiline_tag: bool,
+    custom_blocks: str,
+    custom_html: str,
+    exclude: str,
+    extend_exclude: str,
+    linter_output_format: str,
+    max_line_length: Optional[int],
+    max_attribute_length: Optional[int],
+    format_attribute_template_tags: bool,
+    per_file_ignores: Optional[List[Tuple[str, str]]],
+    indent_css: Optional[int],
+    indent_js: Optional[int],
+    close_void_tags: bool,
+    no_line_after_yaml: bool,
+) -> None:
+    """djLint · HTML template linter and formatter."""
+    config = Config(
+        src[0],
+        extension=extension,
+        ignore=ignore,
+        indent=indent,
+        quiet=quiet,
+        profile=profile,
+        require_pragma=require_pragma,
+        lint=lint or not (reformat or check),
+        reformat=reformat,
+        check=check,
+        use_gitignore=use_gitignore,
+        warn=warn,
+        preserve_leading_space=preserve_leading_space,
+        preserve_blank_lines=preserve_blank_lines,
+        format_css=format_css,
+        format_js=format_js,
+        configuration=configuration,
+        statistics=statistics,
+        include=include,
+        ignore_case=ignore_case,
+        ignore_blocks=ignore_blocks,
+        blank_line_after_tag=blank_line_after_tag,
+        blank_line_before_tag=blank_line_before_tag,
+        line_break_after_multiline_tag=line_break_after_multiline_tag,
+        custom_blocks=custom_blocks,
+        custom_html=custom_html,
+        exclude=exclude,
+        extend_exclude=extend_exclude,
+        linter_output_format=linter_output_format,
+        max_line_length=max_line_length,
+        max_attribute_length=max_attribute_length,
+        format_attribute_template_tags=format_attribute_template_tags,
+        per_file_ignores=per_file_ignores,
+        indent_css=indent_css,
+        indent_js=indent_js,
+        close_void_tags=close_void_tags,
+        no_line_after_yaml=no_line_after_yaml,
+    )
+
+    temp_file = None
+
+    if set("-").intersection(set(src)):
+        if config.files:
+            file_list = get_src([Path(x) for x in config.files], config)
+
+        else:
+            config.stdin = True
+            stdin_stream = click.get_text_stream("stdin", encoding="utf8")
+            stdin_text = stdin_stream.read()
+            temp_file = tempfile.NamedTemporaryFile(delete=False)
+            temp_file.write(str.encode(stdin_text))
+            temp_file.seek(0)
+
+            # cannot use gitignore for stdin paths.
+            config.use_gitignore = False
+
+            file_list = get_src([Path(temp_file.name)], config)
+
+    else:
+        file_list = get_src([Path(x) for x in src], config)
+
+    if len(file_list) == 0:
+        return
+
+    message = ""
+
+    if config.check is True:
+        message = "Checking"
+    elif config.reformat is True:
+        message = "Reformatting"
+
+    if config.lint:
+        if message:
+            message += " and "
+        message += "Linting"
+
+    # pylint: disable=C0209
+    bar_message = (
+        "{}{}{} {}{{n_fmt}}/{{total_fmt}}{} {}files{} {{bar}} {}{{elapsed}}{}".format(
+            Fore.BLUE + Style.BRIGHT,
+            message,
+            Style.RESET_ALL,
+            Fore.RED + Style.BRIGHT,
+            Style.RESET_ALL,
+            Fore.BLUE + Style.BRIGHT,
+            Style.RESET_ALL,
+            Fore.GREEN + Style.BRIGHT,
+            Style.RESET_ALL + "    ",
+        )
+    )
+    if config.stdin is False and config.quiet is False:
+        echo()
+
+    worker_count = os.cpu_count() or 1
+
+    progress_char = "┈━"
+
+    if sys.platform == "win32":
+        # Work around https://bugs.python.org/issue26903
+        worker_count = min(worker_count, 60)
+        progress_char = " »"
+
+    with ProcessPoolExecutor(max_workers=worker_count) as exe:
+        file_errors = []
+
+        func = partial(process, config)
+        futures = {exe.submit(func, this_file): this_file for this_file in file_list}
+
+        if temp_file is None:
+            elapsed = "00:00"
+            with tqdm(
+                total=len(file_list),
+                bar_format=bar_message,
+                colour="BLUE",
+                ascii=progress_char,
+                leave=False,
+            ) as pbar:
+                for future in as_completed(futures):
+                    file_errors.append(future.result())
+                    pbar.update()
+                    elapsed = pbar.format_interval(pbar.format_dict["elapsed"])
+
+            finished_bar_message = "{}{}{} {}{{n_fmt}}/{{total_fmt}}{} {}files{} {{bar}} {}{}{}    ".format(
+                Fore.BLUE + Style.BRIGHT,
+                message,
+                Style.RESET_ALL,
+                Fore.GREEN + Style.BRIGHT,
+                Style.RESET_ALL,
+                Fore.BLUE + Style.BRIGHT,
+                Style.RESET_ALL,
+                Fore.GREEN + Style.BRIGHT,
+                elapsed,
+                Style.RESET_ALL,
+            )
+
+            finished_bar = tqdm(
+                total=len(file_list),
+                initial=len(file_list),
+                bar_format=finished_bar_message,
+                colour="GREEN",
+                ascii=progress_char,
+                leave=True,
+            )
+            finished_bar.close()
+        else:
+            for future in as_completed(futures):
+                file_errors.append(future.result())
+
+    if temp_file and (config.reformat or config.check):
+        # if using stdin, only give back formatted code.
+        echo(Path(temp_file.name).read_text(encoding="utf8").rstrip().encode("utf8"))
+
+    if temp_file:
+        temp_file.close()
+        os.unlink(temp_file.name)
+
+    if bool(print_output(config, file_errors, len(file_list))) and config.warn is False:
+        sys.exit(1)
+
+
+def process(config: Config, this_file: Path) -> Dict:
+    """Run linter or formatter."""
+    output = {}
+    if config.reformat or config.check:
+        output["format_message"] = reformat_file(config, this_file)
+
+    if config.lint:
+        output["lint_message"] = lint_file(config, this_file)
+
+    return output

package/src/djlint/__main__.py

@@ -0,0 +1,4 @@
+"""Djlint access through python -m djlint."""
+from djlint import main
+
+main()

package/src/djlint/formatter/__init__.py

@@ -0,0 +1 @@
+# flake8:noqa