Hopiu/djLint
1
0
Fork 0
mirror of https://github.com/Hopiu/djLint.git synced 2026-05-22 11:51:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
✨ HTML Template Linter and Formatter. Django - Jinja - Nunjucks - Handlebars - GoLang
260 commits 1 branch 0 tags 24 MiB
Python 97.9%
HTML 2%
Shell 0.1%
Find a file
Mathias Jakobsen ed3951838f
Add require_pragma option 
This patch adds a configuration option for requiring files to have a
pragma comment at the beginning of the file in order to reformat the
file. This behaviour is useful for a slow adoption of the tool instead
of requiring the whole codebase to be converted at once.

The patch also contains tests for the different kinds of supported
pragma comments, based on the profile defined for the project.
2021-10-13 15:30:10 +01:00
.github fixed format 2021-10-04 15:55:57 +02:00
docs Add require_pragma option 2021-10-13 15:30:10 +01:00
src Add require_pragma option 2021-10-13 15:30:10 +01:00
tests Add require_pragma option 2021-10-13 15:30:10 +01:00
.coveragerc fixed test coverage 2021-08-17 08:56:40 -05:00
.gitignore fixed bug with col number 2021-07-23 09:19:41 -05:00
.pre-commit-config.yaml initial commit 2021-07-12 13:26:46 -05:00
LICENSE initial commit 2021-07-12 13:26:46 -05:00
MANIFEST.in updated formatter and docs 2021-07-29 13:41:34 -05:00
poetry.lock fixed regex for colgroup. closes #36 2021-10-04 10:24:58 +02:00
pyproject.toml updated version 2021-10-11 16:13:05 +03:00
README.md added space 2021-10-05 10:37:51 +02:00
setup.cfg updated py version 2021-09-20 17:28:58 +02:00
tox.ini added docs workflow 2021-09-16 10:14:45 +02:00

README.md

djLint Logo

Find common formatting issues and reformat HTML templates.

Django · Jinja · Nunjucks · Handlebars · Mustache · GoLang

Ps, --check it out on other templates as well!

codecov test Codacy Badge Maintainability Downloadschat PyPI

Documentation

Read the documentation

Installation and Usage

djLint can be installed with pip install djlint, and is easy to run:

# to lint a directory
djlint /path

# to lint a directory with custom extension
djlint /path -e html.dj

# to check formatting on a file
djlint /path/file.html.j2 --check

# to reformt a directory without printing the file diff
djlint /path --reformat --quiet

# using stdin
echo "<div></div>" | djlint -

Show your format

Add a badge to your projects readme.md:

[![Code style: djlint](https://img.shields.io/badge/html%20style-djlint-blue.svg)](https://github.com/Riverside-Healthcare/djlint)

Add a badge to your readme.rst:

.. image:: https://img.shields.io/badge/html%20style-djlint-blue.svg
   :target: https://github.com/Riverside-Healthcare/djlint

Looks like this:

djLint

Contributing

Send a pr with a new feature, or checkout the issue list and help where you can.