https://github.com/thibaudcolas/curlylint

Experimental HTML templates linting for Jinja, Nunjucks, Django templates, Twig, Liquid
https://github.com/thibaudcolas/curlylint

django django-templates html jinja jinja2 linter linting liquid nunjucks twig

Last synced: about 1 month ago
JSON representation

Experimental HTML templates linting for Jinja, Nunjucks, Django templates, Twig, Liquid

• Host: GitHub
• URL: https://github.com/thibaudcolas/curlylint
• Owner: thibaudcolas
• License: mit
• Created: 2020-01-29T11:18:14.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-01-28T07:42:30.000Z (10 months ago)
• Last Synced: 2024-09-26T20:45:55.604Z (about 2 months ago)
• Topics: django, django-templates, html, jinja, jinja2, linter, linting, liquid, nunjucks, twig
• Language: HTML
• Homepage: https://www.curlylint.org/
• Size: 1.8 MB
• Stars: 239
• Watchers: 4
• Forks: 25
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md
  • Security: docs/SECURITY.md
  • Support: docs/SUPPORT.md

Awesome Lists containing this project

README

        
# [curlylint](https://www.curlylint.org/) [](https://www.curlylint.org/)

[![PyPI](https://img.shields.io/pypi/v/curlylint.svg)](https://pypi.org/project/curlylint/) [![PyPI downloads](https://img.shields.io/pypi/dm/curlylint.svg)](https://pypi.org/project/curlylint/) [![Build status](https://github.com/thibaudcolas/curlylint/workflows/CI/badge.svg)](https://github.com/thibaudcolas/curlylint/actions) [![Coverage Status](https://coveralls.io/repos/github/thibaudcolas/curlylint/badge.svg?branch=main)](https://coveralls.io/github/thibaudcolas/curlylint?branch=main) [![Total alerts](https://img.shields.io/lgtm/alerts/g/thibaudcolas/curlylint.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/thibaudcolas/curlylint/alerts/)

> **{{ 🎀}}** Experimental HTML templates linting for [Jinja](https://jinja.palletsprojects.com/), [Nunjucks](https://mozilla.github.io/nunjucks/), [Django templates](https://docs.djangoproject.com/en/dev/topics/templates/), [Twig](https://twig.symfony.com/), [Liquid](https://shopify.github.io/liquid/).

> Forked from [jinjalint](https://github.com/motet-a/jinjalint).

## Features

[Curlylint](https://www.curlylint.org/) is an HTML linter for [“curly braces”](https://www.curlylint.org/docs/template-languages) templates, and their HTML. It focuses on [rules](https://www.curlylint.org/docs/rules/all) to check for common accessibility issues.

![Screenshot of the curlylint CLI, with an example invocation raising a parsing issue and a rule error](.github/curlylint-screenshot.png)

On the roadmap:

- More checks for common accessibility issues in HTML.

- Checks for common security issues – for example `rel="noopener noreferrer"`, or known sources of XSS vulnerabilities.

- More [ideas welcome](https://www.curlylint.org/docs/reference/ideas)!

## Usage

Curlylint is available on [PyPI](<(https://pypi.org/project/curlylint/)>), grab it and you can start linting:

```bash

# Assuming you’re using Python 3.6+,

pip install curlylint

# Now time to lint those templates!

curlylint template-directory/

```

Have a look at our [documentation](https://www.curlylint.org/docs/) to make the most of it:

- [Getting Started](https://www.curlylint.org/)

- [Command Line Usage](https://www.curlylint.org/docs/command-line-usage)

- [Configuration](https://www.curlylint.org/docs/configuration)

- [Template Languages](https://www.curlylint.org/docs/template-languages)

- [Rules](https://www.curlylint.org/docs/rules/all)

## Contributing

See anything you like in here? Anything missing? We welcome all support, whether on bug reports, feature requests, code, design, reviews, tests, documentation, and more. Please have a look at our [contribution guidelines](CONTRIBUTING.md).

If you just want to set up the project on your own computer, the contribution guidelines also contain all of the setup commands.

## Credits

This project started as a fork of [jinjalint](https://github.com/motet-a/jinjalint). Image credit: [FxEmojis](https://github.com/mozilla/fxemoji). [Test templates](tests/README.md) extracted from third-party projects. Website hosted by [Netlify](https://www.netlify.com/).

View the full list of [contributors](https://github.com/thibaudcolas/curlylint/graphs/contributors). [MIT](LICENSE) licensed. Website content available as [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/).