- D : s’applique spécifiquement à Django
- H : s’applique au html
- J : s’applique spécifiquement à Jinja
- M : s’applique spécifiquement à Handlebars
- N : s’applique spécifiquement à Nunjucks
- T : s’applique généralement aux modèles
djLint inclut de nombreuses règles pour vérifier le style et la validité de vos modèles. Profitez pleinement du linter en le configurant pour utiliser un profil prédéfini pour la langue du modèle de votre choix.
djlint /path/to/templates --lint
# with custom extensions
djlint /path/to/templates -e html.dj --profile=django
# or to file
djlint /path/to/this.html.j2 --profile=jinjaCréez un fichier .djlint_rules.yaml à côté de votre pyproject.toml. Des règles peuvent être ajoutées à ce fichier et djLint les reprendra.
Une bonne règle suit ce modèle :
- règle:
name: T001
message: Trouver la Trichotillomanie
indicateurs: re.DOTALL|re.I
modèles:
- TrichotillomanieLa première lettre d’un code suit le modèle :
| Code | Signification |
|---|---|
| D004 | (Django) Les urls statiques doivent suivre le modèle {% static path/to/file %}. |
| D018 | (Django) Les liens internes doivent utiliser le modèle {% url ... %}. |
| H005 | La balise Html doit avoir l’attribut lang. |
| H006 | La balise img doit avoir les attributs height et width. |
| H007 | LA BALISE <!DOCTYPE ... > doit être présent avant la balise html. |
| H008 | Les attributs doivent être entre guillemets. |
| H009 | Les noms de balises doivent être en minuscules. |
| H010 | Les noms d’attributs doivent être en minuscules. |
| H011 | Les valeurs des attributs doivent être citées. |
| H012 | Il ne doit pas y avoir d’espace autour de l’attribut =. |
| H013 | La balise img doit avoir des attributs alt. |
| H014 | Plus de 2 lignes vides. |
| H015 | Les balises “h” doivent être suivies d’un retour à la ligne. |
| H016 | Balise title manquante dans le html. |
| H017 | La balise doit se fermer automatiquement. |
| H019 | Remplacez javascript:abc() par l’événement on_ et l’url réelle. |
| H020 | Couple de balises vide trouvé. Envisagez de le supprimer. |
| H021 | Les styles en ligne doivent être évités. |
| H022 | Utilisez HTTPS pour les liens externes. |
| H023 | N’utilisez pas de références d’entités. |
| H024 | Omettre le type sur les scripts et les styles. |
| H025 | La balise semble être orpheline. |
| H026 | Les balises id et class vides peuvent être supprimées. |
| H029 | Pensez à utiliser des valeurs de méthode de formulaire en minuscules. |
| H030 | Pensez à ajouter une méta-description. |
| H031 | Pensez à ajouter des méta keywords. |
| H033 | Espace supplémentaire dans l’action du formulaire. |
| J004 | (Jinja) Les urls statiques doivent suivre le modèle { url_for('static'..) }}. |
| J018 | (Jinja) Les liens internes doivent utiliser le modèle {% url ... %}. |
| T001 | Les variables doivent être entourées d’un seul espace. Ex : {{ this }} |
| T002 | Les doubles quotes doivent être utilisées dans les balises. Ex : {% extends "this.html" %} |
| T003 | Le bloc de fin doit avoir un nom. Ex : {% endblock body %}. |
| T027 | Chaîne non fermée trouvée dans la syntaxe du modèle. |
| T028 | Envisagez d’utiliser des balises sans espace à l’intérieur des valeurs d’attributs. {%- if/for -%} |
| T032 | Espace blanc supplémentaire trouvé dans les balises du modèle. |
| T034 | Aviez-vous l’intention d’utiliser {% … %} au lieu de {% … }% ? |
Nous accueillons volontiers les pull requests contenant de nouvelles règles !
Une bonne règle consiste en
Veuillez inclure un test pour valider la règle.