Add HTML formatting and linting to `pre-commit` #239

redshiftzero · 2017-04-10T06:12:25Z

Once we find a good linter for HTML, we should add it to CI.

I was using bootlint and html-linter using the --disable=optional_tag,protocol options to clean up some of the HTML in #238.

If there's something better out there please comment and let us know! ✨

The text was updated successfully, but these errors were encountered:

jrabbit · 2018-12-17T04:20:26Z

https://github.com/motet-a/jinjalint exists but doesn't seem too robust
update: it seems to run fine as does html-linter

abandoned-prototype · 2023-03-28T05:37:21Z

Now that we use pre-commit adding an html template linter should be relatively easy and pretty helpful

michplunkett · 2023-07-07T19:40:32Z

It doesn't look like jinjalint is being maintained, but djlint is: https://www.djlint.com/docs/languages/jinja/

We could likely implement this pretty easily.

michplunkett · 2023-07-11T19:24:57Z

This is gonna be split up into two PRs, one formatting and one for linting. Since the changes to the HTML, JS, and CSS will be so vast for just the formatting, no reviewer will actually be able to see the code that is changed for formatting as opposed to linting.

## Fixes issue #239 ## Description of Changes Added [`djLint`](https://www.djlint.com/docs/languages/jinja/) to the `pre-commit` process and formatted files accordingly. ## Tests and linting - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment. `pre-commit` output: ```console (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % make lint pre-commit run --all-files trim trailing whitespace.................................................Passed check docstring is first.................................................Passed check that executables have shebangs.....................................Passed check json...............................................................Passed check for case conflicts.................................................Passed check toml...........................................(no files to check)Skipped check for merge conflicts................................................Passed check xml................................................................Passed check yaml...............................................................Passed fix end of files.........................................................Passed check for broken symlinks............................(no files to check)Skipped mixed line ending........................................................Passed fix python encoding pragma...............................................Passed pretty format json.......................................................Passed fix requirements.txt.....................................................Passed check blanket noqa.......................................................Passed check for not-real mock methods..........................................Passed check for eval().........................................................Passed use logger.warning(......................................................Passed Run isort to sort imports................................................Passed Run pydocstyle...........................................................Passed Do not use shebangs in non-executable files..............................Passed flake8...................................................................Passed black....................................................................Passed djLint formatting........................................................Passed (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % ```

michplunkett · 2023-07-12T19:14:31Z

The HTML formatting part is done, but the linting is not.

## Fixes issue #239 ## Description of Changes I added `djlint` linting to the `pre-commit` script and made the corresponding changes. ## Tests and linting - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment.

lucyparsons#239 Added [`djLint`](https://www.djlint.com/docs/languages/jinja/) to the `pre-commit` process and formatted files accordingly. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment. `pre-commit` output: ```console (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % make lint pre-commit run --all-files trim trailing whitespace.................................................Passed check docstring is first.................................................Passed check that executables have shebangs.....................................Passed check json...............................................................Passed check for case conflicts.................................................Passed check toml...........................................(no files to check)Skipped check for merge conflicts................................................Passed check xml................................................................Passed check yaml...............................................................Passed fix end of files.........................................................Passed check for broken symlinks............................(no files to check)Skipped mixed line ending........................................................Passed fix python encoding pragma...............................................Passed pretty format json.......................................................Passed fix requirements.txt.....................................................Passed check blanket noqa.......................................................Passed check for not-real mock methods..........................................Passed check for eval().........................................................Passed use logger.warning(......................................................Passed Run isort to sort imports................................................Passed Run pydocstyle...........................................................Passed Do not use shebangs in non-executable files..............................Passed flake8...................................................................Passed black....................................................................Passed djLint formatting........................................................Passed (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % ```

lucyparsons#239 I added `djlint` linting to the `pre-commit` script and made the corresponding changes. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment.

lucyparsons#239 Added [`djLint`](https://www.djlint.com/docs/languages/jinja/) to the `pre-commit` process and formatted files accordingly. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment. `pre-commit` output: ```console (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % make lint pre-commit run --all-files trim trailing whitespace.................................................Passed check docstring is first.................................................Passed check that executables have shebangs.....................................Passed check json...............................................................Passed check for case conflicts.................................................Passed check toml...........................................(no files to check)Skipped check for merge conflicts................................................Passed check xml................................................................Passed check yaml...............................................................Passed fix end of files.........................................................Passed check for broken symlinks............................(no files to check)Skipped mixed line ending........................................................Passed fix python encoding pragma...............................................Passed pretty format json.......................................................Passed fix requirements.txt.....................................................Passed check blanket noqa.......................................................Passed check for not-real mock methods..........................................Passed check for eval().........................................................Passed use logger.warning(......................................................Passed Run isort to sort imports................................................Passed Run pydocstyle...........................................................Passed Do not use shebangs in non-executable files..............................Passed flake8...................................................................Passed black....................................................................Passed djLint formatting........................................................Passed (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % ```

lucyparsons#239 I added `djlint` linting to the `pre-commit` script and made the corresponding changes. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment.

lucyparsons#239 Added [`djLint`](https://www.djlint.com/docs/languages/jinja/) to the `pre-commit` process and formatted files accordingly. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment. `pre-commit` output: ```console (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % make lint pre-commit run --all-files trim trailing whitespace.................................................Passed check docstring is first.................................................Passed check that executables have shebangs.....................................Passed check json...............................................................Passed check for case conflicts.................................................Passed check toml...........................................(no files to check)Skipped check for merge conflicts................................................Passed check xml................................................................Passed check yaml...............................................................Passed fix end of files.........................................................Passed check for broken symlinks............................(no files to check)Skipped mixed line ending........................................................Passed fix python encoding pragma...............................................Passed pretty format json.......................................................Passed fix requirements.txt.....................................................Passed check blanket noqa.......................................................Passed check for not-real mock methods..........................................Passed check for eval().........................................................Passed use logger.warning(......................................................Passed Run isort to sort imports................................................Passed Run pydocstyle...........................................................Passed Do not use shebangs in non-executable files..............................Passed flake8...................................................................Passed black....................................................................Passed djLint formatting........................................................Passed (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % ```

lucyparsons#239 I added `djlint` linting to the `pre-commit` script and made the corresponding changes. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment.

lucyparsons#239 Added [`djLint`](https://www.djlint.com/docs/languages/jinja/) to the `pre-commit` process and formatted files accordingly. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment. `pre-commit` output: ```console (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % make lint pre-commit run --all-files trim trailing whitespace.................................................Passed check docstring is first.................................................Passed check that executables have shebangs.....................................Passed check json...............................................................Passed check for case conflicts.................................................Passed check toml...........................................(no files to check)Skipped check for merge conflicts................................................Passed check xml................................................................Passed check yaml...............................................................Passed fix end of files.........................................................Passed check for broken symlinks............................(no files to check)Skipped mixed line ending........................................................Passed fix python encoding pragma...............................................Passed pretty format json.......................................................Passed fix requirements.txt.....................................................Passed check blanket noqa.......................................................Passed check for not-real mock methods..........................................Passed check for eval().........................................................Passed use logger.warning(......................................................Passed Run isort to sort imports................................................Passed Run pydocstyle...........................................................Passed Do not use shebangs in non-executable files..............................Passed flake8...................................................................Passed black....................................................................Passed djLint formatting........................................................Passed (openoversight) xxxxxx@MacBook-Air-5 OpenOversight % ```

lucyparsons#239 I added `djlint` linting to the `pre-commit` script and made the corresponding changes. - [x] This branch is up-to-date with the `develop` branch. - [x] `pytest` passes on my local development environment. - [x] `pre-commit` passes on my local development environment.

redshiftzero added the hackathon label May 7, 2017

abandoned-prototype added size/S high priority and removed hackathon labels Mar 28, 2023

abandoned-prototype mentioned this issue Mar 31, 2023

Backport from Orca Collective - Step 3 #908

Merged

AetherUnbound pushed a commit that referenced this issue Apr 9, 2023

Upgrade to Python 3.11 (#239)

ad25f90

michplunkett self-assigned this Jul 7, 2023

michplunkett mentioned this issue Jul 10, 2023

Add HTML formatting to pre-commit #966

Merged

3 tasks

michplunkett linked a pull request Jul 10, 2023 that will close this issue

Add HTML formatting to pre-commit #966

Merged

3 tasks

michplunkett changed the title ~~Add HTML linting to CI~~ Add HTML formatting and linting to CI Jul 11, 2023

michplunkett removed the size/S label Jul 11, 2023

michplunkett mentioned this issue Jul 12, 2023

Add HTML linting to pre-commit #968

Merged

3 tasks

michplunkett linked a pull request Jul 12, 2023 that will close this issue

Add HTML linting to pre-commit #968

Merged

3 tasks

michplunkett changed the title ~~Add HTML formatting and linting to CI~~ Add HTML formatting and linting to pre-commit Jul 12, 2023

michplunkett closed this as completed in #966 Jul 12, 2023

michplunkett reopened this Jul 12, 2023

This was referenced Jul 12, 2023

Remove H013 from pre-commit ignore list and add alt tags to images #970

Closed

Remove H021 from pre-commit ignore list and make CSS classes/IDs #969

Closed

michplunkett closed this as completed in #968 Jul 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add HTML formatting and linting to `pre-commit` #239

Add HTML formatting and linting to `pre-commit` #239

redshiftzero commented Apr 10, 2017

jrabbit commented Dec 17, 2018 •

edited

Loading

abandoned-prototype commented Mar 28, 2023

michplunkett commented Jul 7, 2023 •

edited

Loading

michplunkett commented Jul 11, 2023

michplunkett commented Jul 12, 2023

Add HTML formatting and linting to pre-commit #239

Add HTML formatting and linting to pre-commit #239

Comments

redshiftzero commented Apr 10, 2017

jrabbit commented Dec 17, 2018 • edited Loading

abandoned-prototype commented Mar 28, 2023

michplunkett commented Jul 7, 2023 • edited Loading

michplunkett commented Jul 11, 2023

michplunkett commented Jul 12, 2023

Add HTML formatting and linting to `pre-commit` #239

Add HTML formatting and linting to `pre-commit` #239

jrabbit commented Dec 17, 2018 •

edited

Loading

michplunkett commented Jul 7, 2023 •

edited

Loading