mirror of
https://github.com/Hopiu/djLint.git
synced 2026-04-28 00:44:45 +00:00
md to rst
This commit is contained in:
Christopher Pickering
parent
f7b4926cb6
commit
8538e03516
1 changed files with 99 additions and 57 deletions
156
README.md
156
README.md
|
|
@ -1,81 +1,123 @@
|
|||
# djlint
|
||||
djlint
|
||||
======
|
||||
|
||||
Simple Django template linter and reformatter. Ps, reformatting might work with Jinja and Handlebar templates as well! Test it out with the `--check` flag.
|
||||
Simple Django template linter and reformatter. Ps, reformatting might
|
||||
work with Jinja and Handlebar templates as well! Test it out with the
|
||||
``--check`` flag.
|
||||
|
||||
[](https://codecov.io/gh/Riverside-Healthcare/djlint)
|
||||
[](https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml)
|
||||
[](https://www.codacy.com/gh/Riverside-Healthcare/djlint/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Riverside-Healthcare/djlint&utm_campaign=Badge_Grade)
|
||||
[](https://codeclimate.com/github/Riverside-Healthcare/djlint/maintainability)
|
||||
|codecov| |test| |Codacy Badge| |Maintainability|
|
||||
|
||||
## Install
|
||||
Install from `Pypi <https://pypi.org/project/djlint/>`__
|
||||
--------------------------------------------------------
|
||||
|
||||
```sh
|
||||
pip install djlint
|
||||
```
|
||||
## Linter Usage
|
||||
.. code:: sh
|
||||
|
||||
```sh
|
||||
djlint src # file or path
|
||||
pip install djlint
|
||||
|
||||
# with custom extensions
|
||||
djlint src -e html.dj
|
||||
```
|
||||
Linter Usage
|
||||
------------
|
||||
|
||||
## Reformatter Usage
|
||||
.. code:: sh
|
||||
|
||||
Reforamtting is beta. Check the output before applying changes. Please PR any changes needed 👍🏽
|
||||
djlint src # file or path
|
||||
|
||||
```sh
|
||||
djlint src --reformat --check
|
||||
# with custom extensions
|
||||
djlint src -e html.dj
|
||||
|
||||
djlint src --reformat
|
||||
```
|
||||
Reformatter Usage
|
||||
-----------------
|
||||
|
||||
## Optional args
|
||||
Reforamtting is beta. Check the output before applying changes. Please
|
||||
PR any changes needed 👍🏽
|
||||
|
||||
| Arg | Definition | Default |
|
||||
|:----|:-----------|:--------|
|
||||
-e, --extension | File extension to lint. | default=html
|
||||
--check | Checks file formatting |
|
||||
--reformat | Reformats html |
|
||||
.. code:: sh
|
||||
|
||||
## Linter Rules
|
||||
djlint src --reformat --check
|
||||
|
||||
### Error Codes
|
||||
djlint src --reformat
|
||||
|
||||
| Code | Meaning |
|
||||
|------|--------------------------------------------------------------------|
|
||||
| E001 | Variables should be wrapped in a single whitespace. Ex: {{ this }} |
|
||||
| E002 | Double quotes should be used in tags. Ex {% extends "this.html" %} |
|
||||
Optional args
|
||||
-------------
|
||||
|
||||
### Warning Codes
|
||||
+-------------------+---------------------------+----------------+
|
||||
| Arg | Definition | Default |
|
||||
+===================+===========================+================+
|
||||
| -e, --extension | File extension to lint. | default=html |
|
||||
+-------------------+---------------------------+----------------+
|
||||
| --check | Checks file formatting |
|
||||
+-------------------+---------------------------+----------------+
|
||||
| --reformat | Reformats html |
|
||||
+-------------------+---------------------------+----------------+
|
||||
|
||||
| Code | Meaning |
|
||||
|------|--------------------------------------------------------------|
|
||||
| W003 | Endblock should have name. Ex: {% endblock body %}. |
|
||||
| W004 | Status urls should follow {% static path/to/file %} pattern. |
|
||||
| W005 | Html tag should have lang attribute. |
|
||||
| W006 | Img tag should have alt, height and width attributes. |
|
||||
| W007 | \<!DOCTYPE ... > should be present before the html tag. |
|
||||
| W008 | Attributes should be double quoted. |
|
||||
| W009 | Tag names should be lowercase. |
|
||||
| W010 | Attribute names should be lowercase. |
|
||||
| W011 | Attirbute values should be quoted. |
|
||||
| W012 | There should be no spaces around attribute =. |
|
||||
| W013 | Line is longer than 99 chars. |
|
||||
| W014 | More than 2 blank lines. |
|
||||
| W015 | Follow h tags with a blank line. |
|
||||
| W016 | Missging title tag in html. |
|
||||
Linter Rules
|
||||
------------
|
||||
|
||||
## Adding Rules
|
||||
Error Codes
|
||||
~~~~~~~~~~~
|
||||
|
||||
+--------+----------------------------------------------------------------------+
|
||||
| Code | Meaning |
|
||||
+========+======================================================================+
|
||||
| E001 | Variables should be wrapped in a single whitespace. Ex: {{ this }} |
|
||||
+--------+----------------------------------------------------------------------+
|
||||
| E002 | Double quotes should be used in tags. Ex {% extends "this.html" %} |
|
||||
+--------+----------------------------------------------------------------------+
|
||||
|
||||
Warning Codes
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
+--------+----------------------------------------------------------------+
|
||||
| Code | Meaning |
|
||||
+========+================================================================+
|
||||
| W003 | Endblock should have name. Ex: {% endblock body %}. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W004 | Status urls should follow {% static path/to/file %} pattern. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W005 | Html tag should have lang attribute. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W006 | Img tag should have alt, height and width attributes. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W007 | <!DOCTYPE ... > should be present before the html tag. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W008 | Attributes should be double quoted. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W009 | Tag names should be lowercase. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W010 | Attribute names should be lowercase. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W011 | Attirbute values should be quoted. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W012 | There should be no spaces around attribute =. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W013 | Line is longer than 99 chars. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W014 | More than 2 blank lines. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W015 | Follow h tags with a blank line. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
| W016 | Missging title tag in html. |
|
||||
+--------+----------------------------------------------------------------+
|
||||
|
||||
Adding Rules
|
||||
------------
|
||||
|
||||
A good rule consists of
|
||||
|
||||
- Name
|
||||
- Code - Codes beginning with "E" signify error, and "W" warning.
|
||||
- Message - Message to display when error is found.
|
||||
- Patterns - regex expressions that will find the error.
|
||||
- Name
|
||||
- Code - Codes beginning with "E" signify error, and "W" warning.
|
||||
- Message - Message to display when error is found.
|
||||
- Patterns - regex expressions that will find the error.
|
||||
|
||||
## Contributing - Please Help!
|
||||
Contributing - Please Help!
|
||||
---------------------------
|
||||
|
||||
Checkout the issue list and help where you can!
|
||||
|
||||
.. |codecov| image:: https://codecov.io/gh/Riverside-Healthcare/djlint/branch/master/graph/badge.svg?token=eNTG721BAA
|
||||
:target: https://codecov.io/gh/Riverside-Healthcare/djlint
|
||||
.. |test| image:: https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml/badge.svg
|
||||
:target: https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml
|
||||
.. |Codacy Badge| image:: https://app.codacy.com/project/badge/Grade/dba6338b0e7a4de896b45b382574f369
|
||||
:target: https://www.codacy.com/gh/Riverside-Healthcare/djlint/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Riverside-Healthcare/djlint&utm_campaign=Badge_Grade
|
||||
.. |Maintainability| image:: https://api.codeclimate.com/v1/badges/5febe4111a36c7e0d2ed/maintainability
|
||||
:target: https://codeclimate.com/github/Riverside-Healthcare/djlint/maintainability
|
||||
|
|
|
|||
Loading…
Reference in a new issue