mirror of
https://github.com/Hopiu/djLint.git
synced 2026-04-28 00:44:45 +00:00
63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
# djlint
|
|
|
|
Simple Django template linter.
|
|
|
|
[](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)
|
|
|
|
## Install
|
|
|
|
```sh
|
|
pip install djlint
|
|
```
|
|
|
|
## Usage
|
|
|
|
```sh
|
|
djlint <file or path>
|
|
```
|
|
## Optional args
|
|
|
|
| Arg | Definition | Default |
|
|
|:----|:-----------|:--------|
|
|
-e, --extension | File extension to lint. | default=html
|
|
|
|
## 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.
|