docs: use Stylelint for HTML files #16468

nschonni · 2022-10-29T19:55:53Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:

What changes did you make? (Give an overview)

Add the Stylelint parsing and rules for the inline CSS in the docs templates. Alternately this could be skipped if the code is moved to the other SCSS files

Is there anything you'd like reviewers to focus on?

netlify · 2022-10-29T19:56:00Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`2acca68`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/635fc6c4c6311b000945fdaf

mdjermanovic · 2022-10-30T09:55:22Z

docs/src/user-guide/formatters/html-formatter-example.html

+                font-weight: normal;
+                margin: 0;
+                padding: 0;
+                color: #333;


This file is autogenerated, so it should be excluded from linting.

Good point! I went back and updated the generator so it outputs the formatted code instead

I still think this file should be excluded. This file is not actually documentation, but the output of running eslint with -f html on the command line.

I also feel we should ignore this file.

Linting the generated file does highlight "issues" (so far just formatting) that wouldn't be caught otherwise because it is a string embedded in an EJS file. The annoyance though, is there is now way to say "you really need to fix this other file"

lib/cli-engine/formatters/html.js

Co-authored-by: Strek <ssharishkumar@gmail.com>

nzakas

LGTM. Thanks.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.26.0` -> `8.27.0`](https://renovatebot.com/diffs/npm/eslint/8.26.0/8.27.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.27.0`](https://github.com/eslint/eslint/releases/tag/v8.27.0) [Compare Source](eslint/eslint@v8.26.0...v8.27.0) #### Features - [`f14587c`](eslint/eslint@f14587c) feat: new `no-new-native-nonconstructor` rule ([#16368](eslint/eslint#16368)) (Sosuke Suzuki) - [`978799b`](eslint/eslint@978799b) feat: add new rule `no-empty-static-block` ([#16325](eslint/eslint#16325)) (Sosuke Suzuki) - [`69216ee`](eslint/eslint@69216ee) feat: no-empty suggest to add comment in empty BlockStatement ([#16470](eslint/eslint#16470)) (Nitin Kumar) - [`319f0a5`](eslint/eslint@319f0a5) feat: use `context.languageOptions.ecmaVersion` in core rules ([#16458](eslint/eslint#16458)) (Milos Djermanovic) #### Bug Fixes - [`c3ce521`](eslint/eslint@c3ce521) fix: Ensure unmatched glob patterns throw an error ([#16462](eslint/eslint#16462)) (Nicholas C. Zakas) - [`886a038`](eslint/eslint@886a038) fix: handle files with unspecified path in `getRulesMetaForResults` ([#16437](eslint/eslint#16437)) (Francesco Trotta) #### Documentation - [`ce93b42`](eslint/eslint@ce93b42) docs: Stylelint property-no-unknown ([#16497](eslint/eslint#16497)) (Nick Schonning) - [`d2cecb4`](eslint/eslint@d2cecb4) docs: Stylelint declaration-block-no-shorthand-property-overrides ([#16498](eslint/eslint#16498)) (Nick Schonning) - [`0a92805`](eslint/eslint@0a92805) docs: stylelint color-hex-case ([#16496](eslint/eslint#16496)) (Nick Schonning) - [`74a5af4`](eslint/eslint@74a5af4) docs: fix stylelint error ([#16491](eslint/eslint#16491)) (Milos Djermanovic) - [`324db1a`](eslint/eslint@324db1a) docs: explicit stylelint color related rules ([#16465](eslint/eslint#16465)) (Nick Schonning) - [`94dc4f1`](eslint/eslint@94dc4f1) docs: use Stylelint for HTML files ([#16468](eslint/eslint#16468)) (Nick Schonning) - [`cc6128d`](eslint/eslint@cc6128d) docs: enable stylelint declaration-block-no-duplicate-properties ([#16466](eslint/eslint#16466)) (Nick Schonning) - [`d03a8bf`](eslint/eslint@d03a8bf) docs: Add heading to justification explanation ([#16430](eslint/eslint#16430)) (Maritaria) - [`8a15968`](eslint/eslint@8a15968) docs: add Stylelint configuration and cleanup ([#16379](eslint/eslint#16379)) (Nick Schonning) - [`9b0a469`](eslint/eslint@9b0a469) docs: note commit messages don't support scope ([#16435](eslint/eslint#16435)) (Andy Edwards) - [`1581405`](eslint/eslint@1581405) docs: improve context.getScope() docs ([#16417](eslint/eslint#16417)) (Ben Perlmutter) - [`b797149`](eslint/eslint@b797149) docs: update formatters template ([#16454](eslint/eslint#16454)) (Milos Djermanovic) - [`5ac4de9`](eslint/eslint@5ac4de9) docs: fix link to formatters on the Core Concepts page ([#16455](eslint/eslint#16455)) (Vladislav) - [`33313ef`](eslint/eslint@33313ef) docs: core-concepts: fix link to semi rule ([#16453](eslint/eslint#16453)) (coderaiser) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1628 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

chore: use Stylelint for HTML files

ada04bd

eslint-github-bot bot added triage An ESLint team member will look at this issue soon chore This change is not user-facing labels Oct 29, 2022

bmish approved these changes Oct 29, 2022

View reviewed changes

mdjermanovic reviewed Oct 30, 2022

View reviewed changes

chore: update HTML fomatter to match Stylelint

4680758

eslint-github-bot bot added the documentation Relates to ESLint's documentation label Oct 30, 2022

harish-sethuraman reviewed Oct 31, 2022

View reviewed changes

lib/cli-engine/formatters/html.js Outdated Show resolved Hide resolved

Update lib/cli-engine/formatters/html.js

2acca68

Co-authored-by: Strek <ssharishkumar@gmail.com>

snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Nov 1, 2022

nzakas approved these changes Nov 2, 2022

View reviewed changes

nzakas merged commit 94dc4f1 into eslint:main Nov 2, 2022

nschonni deleted the stylelint-html branch November 2, 2022 19:41

mdjermanovic mentioned this pull request Nov 2, 2022

docs: fix stylelint error #16491

Merged

1 task

eslint-github-bot bot locked and limited conversation to collaborators May 2, 2023

eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label May 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: use Stylelint for HTML files #16468

docs: use Stylelint for HTML files #16468

nschonni commented Oct 29, 2022

netlify bot commented Oct 29, 2022 •

edited

mdjermanovic Oct 30, 2022

nschonni Oct 30, 2022

mdjermanovic Oct 31, 2022

snitin315 Nov 1, 2022

nschonni Nov 2, 2022

nzakas left a comment

docs: use Stylelint for HTML files #16468

docs: use Stylelint for HTML files #16468

Conversation

nschonni commented Oct 29, 2022

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

netlify bot commented Oct 29, 2022 • edited

✅ Deploy Preview for docs-eslint canceled.

mdjermanovic Oct 30, 2022

Choose a reason for hiding this comment

nschonni Oct 30, 2022

Choose a reason for hiding this comment

mdjermanovic Oct 31, 2022

Choose a reason for hiding this comment

snitin315 Nov 1, 2022

Choose a reason for hiding this comment

nschonni Nov 2, 2022

Choose a reason for hiding this comment

nzakas left a comment

Choose a reason for hiding this comment

netlify bot commented Oct 29, 2022 •

edited