Code guide: Use short encoding declaration and avoid /> #2069

zcorpan · 2021-10-25T23:36:34Z

<meta charset="UTF-8"> https://github.com/w3c/aria-practices/wiki/Code-Guide#character-encoding
"Don't include a trailing slash in self-closing elements—the HTML standard says they're optional." https://github.com/w3c/aria-practices/wiki/Code-Guide#syntax

I looked into adding a lint for /> with htmlhint, but it seems to not be implemented: htmlhint/HTMLHint#337 (comment)

Preview | Diff

zcorpan · 2021-10-26T19:55:47Z

I looked into adding a lint for /> with htmlhint, but it seems to not be implemented: htmlhint/HTMLHint#337 (comment)

PR for htmlhint to lint for "disallow /> syntax on HTML void elements": htmlhint/HTMLHint#696

zcorpan · 2021-10-29T13:49:24Z

The PR for htmlhint was merged. I've updated htmlhint and used the new rule here, so /> syntax is now linted.

package.json

nschonni · 2021-11-02T20:29:31Z

examples/index.html

-<head>
-  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<html lang="en-US"><head>
+  <meta charset="UTF-8">


I think in the other files the lowercase "utf-8" is used, but that it doesn't make a functional difference

Right. I don't care about casing here...

nschonni · 2021-11-02T23:20:20Z

examples/landmarks/form.html

@@ -143,26 +143,26 @@ <h3>Source Code</h3>
                  <div class="code">


Should this be an actual code block instead of escaped HTML in a div?

Not in this PR. 🙂 Feel free to file an issue, though I guess the landmark pages need an overhaul and this would be fixed as part of that when we get to it.

nschonni · 2021-11-02T23:24:36Z

package-lock.json

@@ -1,8 +1,10288 @@
 {
  "name": "aria-practices",
  "version": "0.0.0",
-  "lockfileVersion": 1,
+  "lockfileVersion": 2,


Upgrading the lockfile might make sense, but probably better to do it separately

That is now merged, so this needs a rebase. cc @howard-e

zcorpan

🎉

nschonni · 2021-11-23T00:46:05Z

package.json

@@ -49,7 +49,7 @@
    "eslint-plugin-prettier": "^4.0.0",
    "geckodriver": "^1.22.1",
    "glob": "^7.1.6",
-    "htmlhint": "^0.14.2",
+    "htmlhint": "^0.16.0",


This and the package-lock.json changes can be rebased out now

Yep. Think we can land this afterwards

This rule checks that HTML void elements do not use '/>' syntax.

Co-authored-by: Michael "Z" Goddard <mzgoddard@gmail.com>

nschonni · 2021-11-23T00:54:39Z

package-lock.json

-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.0.1.tgz",
-      "integrity": "sha512-it1vE95zF6dTT9lBsYbxvqh0Soy4SPowchj0UBGj/V6cTPnXXtQOPUbhZ6CmGzAD/rW22LQK6E96pcdJXk4A4w==",
+      "version": "2.0.0",


Looked like it reverted some of your latest landed PRs

Odd, will take another look at that

I think you just need to rebase off the last commit

This should be good now. It seems running npm install currently will revert some references of nth-check and trim-newlines. An npm audit fix should correct the lockfile

Opened PR #2158 for that @nschonni

nschonni · 2021-11-23T00:57:24Z

@howard-e you seem comfortable with rebase, so this git alias might be handy for you https://github.com/nschonni/dotfiles/blob/0095dfa25aabf67d3682a792670e042abba2ec62/.gitconfig#L26. It works on repos, no mater what the default branch name is 😉

howard-e · 2021-11-23T00:59:44Z

@howard-e you seem comfortable with rebase, so this git alias might be handy for you https://github.com/nschonni/dotfiles/blob/0095dfa25aabf67d3682a792670e042abba2ec62/.gitconfig#L26. It works on repos, no mater what the default branch name is 😉

Appreciate that!

* Use short encoding declaration and avoid />. Don't include a trailing slash in self-closing elements—the HTML standard says they're optional. * Use htmlhint 'empty-tag-not-self-closed' rule. This rule checks that HTML void elements do not use '/>' syntax. Co-authored-by: Michael "Z" Goddard <mzgoddard@gmail.com> Co-authored-by: Howard Edwards <howarde.edwards@gmail.com>

zcorpan added the Code Quality Non-functional code changes to satisfy APG code style guidelines and linters label Oct 27, 2021

zcorpan requested a review from howard-e October 29, 2021 13:50

mcking65 added this to Prioritized in Infrastructure and Management Oct 31, 2021

zcorpan force-pushed the bocoup/code-guide-html branch from 9584c55 to 4977db4 Compare November 1, 2021 14:53

mzgoddard reviewed Nov 2, 2021

View reviewed changes

package.json Outdated Show resolved Hide resolved

zcorpan mentioned this pull request Nov 2, 2021

Infrastructure: Bump htmlhint from 0.14.2 to 0.16.0 #2104

Closed

nschonni reviewed Nov 2, 2021

View reviewed changes

zcorpan mentioned this pull request Nov 3, 2021

Update the Code Guide documentation and lint everything #2110

Open

zcorpan mentioned this pull request Nov 10, 2021

Infrastructure: remove npm-merge-driver and update to lockfileVersion: 2 #2108

Merged

zcorpan mentioned this pull request Nov 18, 2021

Infrastructure: Bump htmlhint from 0.14.2 to 0.16.1 #2133

Merged

howard-e force-pushed the bocoup/code-guide-html branch from 3e5258f to 868d6a6 Compare November 19, 2021 12:25

howard-e approved these changes Nov 19, 2021

View reviewed changes

zcorpan commented Nov 22, 2021

View reviewed changes

Code guide: Use short encoding declaration and avoid />

e207379

nschonni reviewed Nov 23, 2021

View reviewed changes

zcorpan and others added 6 commits November 22, 2021 19:46

Update htmlhint to 0.16.0 and use 'empty-tag-not-self-closed' rule

74c50a8

This rule checks that HTML void elements do not use '/>' syntax.

Fix code style in .template files

1051b4d

Regenerate examples/index.html

0ea7d41

Update package.json

2d9ac20

Co-authored-by: Michael "Z" Goddard <mzgoddard@gmail.com>

Fix more />s

80a2b54

fix />s

edccb22

howard-e force-pushed the bocoup/code-guide-html branch from c464807 to bc8f78b Compare November 23, 2021 00:47

nschonni reviewed Nov 23, 2021

View reviewed changes

howard-e force-pushed the bocoup/code-guide-html branch from bc8f78b to edccb22 Compare November 23, 2021 01:05

howard-e mentioned this pull request Nov 23, 2021

Infrastructure: Chore: Post-dependabot merge cleanup #2158

Closed

2 tasks

howard-e merged commit 858e6ab into main Nov 23, 2021

howard-e deleted the bocoup/code-guide-html branch November 23, 2021 17:57

alflennik mentioned this pull request May 10, 2022

Launch fixes w3c/wai-aria-practices#62

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code guide: Use short encoding declaration and avoid /> #2069

Code guide: Use short encoding declaration and avoid /> #2069

zcorpan commented Oct 25, 2021 •

edited by pr-preview bot

Loading

zcorpan commented Oct 26, 2021

zcorpan commented Oct 29, 2021

nschonni Nov 2, 2021

zcorpan Nov 2, 2021

nschonni Nov 2, 2021

zcorpan Nov 3, 2021

nschonni Nov 2, 2021

zcorpan Nov 3, 2021

zcorpan Nov 18, 2021

howard-e Nov 19, 2021

zcorpan left a comment

nschonni Nov 23, 2021

howard-e Nov 23, 2021

nschonni Nov 23, 2021

howard-e Nov 23, 2021

nschonni Nov 23, 2021

howard-e Nov 23, 2021 •

edited

Loading

howard-e Nov 23, 2021

nschonni commented Nov 23, 2021

howard-e commented Nov 23, 2021

		@@ -143,26 +143,26 @@ <h3>Source Code</h3>
		<div class="code">

Code guide: Use short encoding declaration and avoid /> #2069

Code guide: Use short encoding declaration and avoid /> #2069

Conversation

zcorpan commented Oct 25, 2021 • edited by pr-preview bot Loading

zcorpan commented Oct 26, 2021

zcorpan commented Oct 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zcorpan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

howard-e Nov 23, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nschonni commented Nov 23, 2021

howard-e commented Nov 23, 2021

zcorpan commented Oct 25, 2021 •

edited by pr-preview bot

Loading

howard-e Nov 23, 2021 •

edited

Loading