Merge pull request #77 from rtts/release-candidate

DjHTML Version 3
rtts · Feb 23, 2023 · 342c61f · 342c61f
2 parents 03699d5 + 8a89686
commit 342c61f
Show file tree

Hide file tree

Showing 36 changed files with 2,793 additions and 1,429 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -9,13 +9,11 @@ on:
 jobs:
   tests:
     name: Python ${{ matrix.python-version }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     strategy:
       matrix:
         python-version:
-        - 3.6
-        - 3.7
         - 3.8
         - 3.9
         - '3.10'

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,7 +4,7 @@ repos:
   hooks:
   - id: isort
 - repo: https://github.com/psf/black
-  rev: 22.12.0
+  rev: 23.1.0
   hooks:
   - id: black
 - repo: https://github.com/pycqa/flake8

diff --git a/README.md b/README.md
@@ -2,8 +2,7 @@
 
 ***A pure-Python Django/Jinja template indenter without dependencies.***
 
-DjHTML is a fully automatic template indenter that works with mixed
-HTML/CSS/Javascript templates that contain
+DjHTML indents mixed HTML/CSS/JavaScript templates that contain
 [Django](https://docs.djangoproject.com/en/stable/ref/templates/language/)
 or [Jinja](https://jinja.palletsprojects.com/templates/) template
 tags. It works similar to other code-formatting tools such as
@@ -15,54 +14,77 @@ whitespace at the beginning of lines. It will not insert newlines or
 other characters. The goal is to correctly indent already
 well-structured templates, not to fix broken ones.
 
-For example, consider the following incorrectly indented template:
+
+### New! Multi-line HTML elements
+
+As of version 3, DjHTML indents multi-line HTML elements and
+multi-line attribute values like this:
+
+```jinja
+<blockquote cite="Guido Van Rossum"
+            style="font-style: italic;
+                   {% if dark_mode %}
+                       background: black;
+                   {% endif %}
+                  ">
+    Don't you hate code that's not properly indented?
+</blockquote>
+```
+
+
+### New! Multi-line CSS indentation
+
+Multi-line CSS values are now continued at the same indentation level:
 
 ```jinja
-<!doctype html>
-<html>
-    <body>
-        {% block content %}
-        Hello, world!
-        {% endblock %}
-        <script>
-            $(function() {
-            console.log('Hi mom!');
-            });
-        </script>
-    </body>
-</html>
+<style>
+    @font-face {
+        font-family: Helvetica;
+        src: {% for format, filename in licensed_fonts %}
+                 url('{% static filename %}') format('{{ format }}'),
+             {% endfor %}
+             url('Arial.woff2') format('woff2'),
+             url('Arial.woff') format('woff');
+    }
+</style>
 ```
 
-This is what it will look like after processing by DjHTML:
+
+### New! Improved JavaScript indentation
+
+Many new JavaScript indention rules have been added, such as the
+indentation of method chaining:
 
 ```jinja
-<!doctype html>
-<html>
-    <body>
-        {% block content %}
-            Hello, world!
-        {% endblock %}
-        <script>
-            $(function() {
-                console.log('Hi mom!');
-            });
-        </script>
-    </body>
-</html>
+<script>
+    window.fetch('/test.html')
+        .then((html) => {
+            document.body.innerHTML = html;
+            {% block extra_statements %}
+            {% endblock %}
+        });
+</script>
 ```
 
 
+### New! Tabwidth guessing
+
+Without the `-t` / `--tabwidth` argument, DjHTML no longer defaults to
+a tabwidth of 4 but instead guesses the correct tabwidth.
+
+
 ## Installation
 
-DjHTML is compatible with all operating systems supported by Python.
-Install DjHTML with the following command:
+DjHTML requires Python 3.8 or higher and is compatible with all
+operating systems supported by Python. Install DjHTML with the
+following command:
 
     $ pip install djhtml
 
-Note that [Windows still uses legacy code pages for the system
-encoding](https://docs.python.org/3/using/windows.html#win-utf8-mode).
-It is highly advised to set the environment variable `PYTHONUTF8` to
-`1` to avoid issues with indenting UTF-8 files. You can do so with the
+Note that
+[Windows still uses legacy code pages](https://docs.python.org/3/using/windows.html#win-utf8-mode)
+instead of UTF-8. It is highly advised to set the environment variable
+`PYTHONUTF8` to `1` with the
 [setx](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/setx)
 command:
 
@@ -78,12 +100,14 @@ command:
     reindented template.html
     1 template has been reindented.
 
+You can also run `djhtml .` to indent all HTML files beneath the
+current directory.
+
 An exit status of 0 means that everything went well, regardless of
 whether any files were changed. When the option `-c` / `--check` is
 used, the exit status is 1 when one or more files would have changed,
-but no changes are actually made. The exit status of 123 means that
-there was an error while indenting one or more files. All available
-options are given by `djthml -h` / `djthml --help`.
+but no changes are actually made. All available options are given by
+`djthml -h` / `djthml --help`.
 
 
 ## `fmt:off` and `fmt:on`
@@ -92,13 +116,11 @@ You can exclude specific lines from being processed with the
 `{# fmt:off #}` and `{# fmt:on #}` operators:
 
 ```jinja
-<div class="
-    {# fmt:off #}
-      ,-._|\
-     /     .\
-     \_,--._/
-    {# fmt:on #}
-"/>
+{# fmt:off #}
+   ,-._|\
+  /     .\
+  \_,--._/
+{# fmt:on #}
 ```
 
 Contents inside `<pre> ... </pre>`, `<!-- ... --->`, `/* ... */`, and
@@ -124,7 +146,7 @@ The indenter operates in one of three different modes:
 
 ## pre-commit configuration
 
-The best way to use DjHTML is as a [pre-commit](https://pre-commit.com/)
+A great way to use DjHTML is as a [pre-commit](https://pre-commit.com/)
 hook, so all your HTML, CSS and JavaScript files will automatically be
 indented upon every commit.
 
@@ -203,25 +225,36 @@ happy, please do the following:
 
 Your feedback for improving DjHTML is very welcome!
 
+
 ## Development
 
-Use your preferred system for setting up a virtualenv, docker environment,
-or whatever else, then run the following:
+First of all, clone this repository:
 
-```sh
-python -m pip install -e '.[dev]'
-pre-commit install --install-hooks
-```
+    $ git clone https://github.com/rtts/djhtml
+    $ cd djhtml
 
-Tests can then be run quickly in that environment:
+Then, create a Python virtualenv and activate it:
 
-```sh
-python -m unittest discover -v
-```
+    $ python -m venv ~/.virtualenvs/djhtml
+    $ . ~/.virtualenvs/djhtml/bin/activate
 
-Or testing in all available supported environments and linting can be run
-with [`nox`](https://nox.thea.codes):
+Then, install the package in [development
+mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)
+including the `dev` dependencies, and install the pre-commit hooks:
 
-```sh
-nox
-```
+    $ python -m pip install -e '.[dev]'
+    $ pre-commit install --install-hooks
+
+You can run the unittests with:
+
+    $ python -m unittest
+
+Or use [`nox`](https://nox.thea.codes) to test all supported Python
+interpreters:
+
+    $ nox
+
+Finally, to get a little insight into the tokenization step of the
+indenting algorithm, you can run DjHTML with the `-d` / `--debug`
+argument. You will see a Python representation of the tokens that are
+created.
diff --git a/djhtml/__main__.py b/djhtml/__main__.py
@@ -7,6 +7,12 @@
 standard output. Example usage:
 
     $ djhtml - < input.html > output.html
+
+Passing a directory name will recurse into the directory and format
+all files with typical extensions. For more fine-grained control of
+which files get processed, use external tools like find, xargs or
+pre-commit.
+
 """
 
 import sys
@@ -51,12 +57,25 @@ def main():
             _error(e)
             continue
 
+        # Guess tabwidth
+        if not options.tabwidth:
+            prev = 0
+            probabilities = [0] * 9
+            for line in source.splitlines():
+                if line and not line.isspace():
+                    depth = _get_depth(line)
+                    if abs(depth - prev) in [2, 4, 8]:
+                        probabilities[abs(depth - prev)] += 1
+                    prev = depth
+            guess = probabilities.index(max(probabilities))
+
         # Indent input file
         try:
-            if options.debug:
-                print(Mode(source).debug())
-                sys.exit()
-            result = Mode(source).indent(options.tabwidth)
+            result = Mode(source).indent(options.tabwidth or guess or 4)
+        except modes.MaxLineLengthExceeded:
+            problematic_files += 1
+            _error(f"Maximum line length exceeded in {filename}")
+            continue
         except Exception:
             _error(
                 f"Fatal error while processing {filename}\n\n"
@@ -66,17 +85,15 @@ def main():
             )
             raise
 
-        changed = _verify_changed(source, result)
-        if changed:
+        if changed := _verify_changed(source, result):
             changed_files += 1
         else:
             unchanged_files += 1
 
         # Write output file
         if not options.check:
             if filename == "-":
-                if not options.quiet:
-                    print(result, end="")
+                print(result, end="")
             elif changed:
                 try:
                     with open(filename, "w") as output_file:
@@ -102,6 +119,9 @@ def main():
             f"{problematic_files} template{s} could not be processed due to an error."
         )
 
+    if options.debug:
+        print(Mode(source).debug(), file=sys.stderr)
+
     # Exit with appropriate exit status
     if problematic_files:
         sys.exit(123)
@@ -141,9 +161,20 @@ def _verify_changed(source, result):
     return changed
 
 
+def _get_depth(line):
+    count = 0
+    for char in line:
+        if char == " ":
+            count += 1
+        elif char == "\t":
+            count += 4
+        else:
+            break
+    return count
+
+
 def _info(msg):
-    if not options.quiet:
-        print(msg, file=sys.stderr)
+    print(msg, file=sys.stderr)
 
 
 def _error(msg):