mirror of
https://github.com/inventree/InvenTree.git
synced 2025-06-15 11:35:41 +00:00
Replace mklint with djlint (#4746)
* remove markuplint * remove dedicated html step - will be done by pre-commit * add djlint for django template linting * Fix T003: Endblock should have name * Fix H013: Img tag should have an alt attribute * Fix H014: Found extra blank lines * Fix T003: Endblock should have name * Fix H013: Img tag should have an alt attribute * small fixes * Fix T001: Variables should be wrapped in a single whitespace * Fix T003: Endblock should have name * small fixes * fix form method * add entry to contributing * fix template changes * another fix * use current version
This commit is contained in:
@ -128,6 +128,24 @@ The various github actions can be found in the `./github/workflows` directory
|
||||
Sumbitted Python code is automatically checked against PEP style guidelines. Locally you can run `invoke style` to ensure the style checks will pass, before submitting the PR.
|
||||
Please write docstrings for each function and class - we follow the [google doc-style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) for python. Docstrings for general javascript code is encouraged! Docstyles are checked by `invoke style`.
|
||||
|
||||
### Django templates
|
||||
|
||||
Django are checked by [djlint](https://github.com/Riverside-Healthcare/djlint) through pre-commit.
|
||||
|
||||
The following rules out of the [default set](https://djlint.com/docs/linter/) are not applied:
|
||||
```bash
|
||||
D018: (Django) Internal links should use the {% url ... %} pattern
|
||||
H006: Img tag should have height and width attributes
|
||||
H008: Attributes should be double quoted
|
||||
H021: Inline styles should be avoided
|
||||
H023: Do not use entity references
|
||||
H025: Tag seems to be an orphan
|
||||
H030: Consider adding a meta description
|
||||
H031: Consider adding meta keywords
|
||||
T002: Double quotes should be used in tags
|
||||
```
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
New features or updates to existing features should be accompanied by user documentation.
|
||||
|
Reference in New Issue
Block a user