Skip to content

Commit fdeb5d0

Browse files
committed
Release v0.8.0
1 parent 5fbcd75 commit fdeb5d0

File tree

3 files changed

+13
-33
lines changed

3 files changed

+13
-33
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
55
## Unreleased
66

7+
## [v0.8.0](https://github.com/thibaudcolas/curlylint/releases/tag/v0.8.0) 2020-05-04
8+
79
### Added
810

911
- Add support for configurable formatters with `--format` CLI parameter / `format` config attribute.

README.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,19 @@
44

55
> **{{ 🎀}}** Prototype linter for [Jinja](https://jinja.palletsprojects.com/) and [Django templates](https://docs.djangoproject.com/en/dev/topics/templates/), forked from [jinjalint](https://github.com/motet-a/jinjalint).
66
7-
It works with [Django’s templates](https://docs.djangoproject.com/en/1.11/ref/templates/language/) too, it should
8-
work with [Twig](https://twig.symfony.com/) and similar template languages.
9-
It should work fine with any kind of HTML 4 and 5, however XHTML is not
10-
supported.
11-
12-
This linter parses both HTML and Jinja tags and will report mismatched
13-
tags and indentation errors:
14-
15-
```html+jinja
16-
<div>
17-
{% if something %}
18-
</div>
19-
{% endif %}
20-
```
7+
curlylint is a prototype linter for your templates – whether that’s [Django’s templates](https://docs.djangoproject.com/en/1.11/ref/templates/language/), [Jinja](https://jinja.palletsprojects.com/), [Twig](https://twig.symfony.com/), or any other [“curly braces”](tests/README.md) template language.
218

22-
```html+jinja
23-
<div>
24-
<span>
25-
</div>
26-
</span>
27-
```
9+
As of now, curlylint supports:
2810

29-
```html+jinja
30-
{% if something %}
31-
<div>not indented properly</div>
32-
{% endif %}
33-
```
11+
- Linting invalid template / HTML syntax due to mismatched tags – while template errors are easy enough to spot, it’s not rare for HTML issues to make their way to live sites.
12+
- Indentation inconsistencies – Usage of tabs vs spaces, line breaks, indentation size.
3413

35-
```html+jinja
36-
{% if something %}<a href="somewhere"
37-
>{% endif %}
38-
<p>something</p>
39-
{% if not something %}</a
40-
>{% endif %}
41-
```
14+
In the future, we intend to support linting:
15+
16+
- Common accessibility issues in HTML – misuse of ARIA `role`, and making sure alternative text is used where appropriate.
17+
- Common security issues – e.g. `rel="noopener noreferrer"`, or preventing usage of HTTP URLs.
18+
- General HTML code smells – duplicate attributes, invalid attributes, etc.
19+
- More [ideas welcome](docs/README.md)!
4220

4321
## Usage
4422

curlylint/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
__name__ = "curlylint"
2-
__version__ = "0.7.0"
2+
__version__ = "0.8.0"
33
__description__ = "{{ 🎀}} Prototype linter for Jinja and Django templates, forked from jinjalint"
44
__author__ = "Thibaud Colas"
55
__author_email__ = "thibaudcolas@gmail.com"

0 commit comments

Comments
 (0)