File layout and formatting - a proposal for a tweak

[jmb]

I wonder if a small tweak to the file layout might be worthwhile. Currently we use:

<svg xmlns="http://www.w3.org/2000/svg"
aria-label="..." role="img"
viewBox="0 0 512 512"><path
d="m0 0H512V512H0"
fill="#fff"/> ... </svg>

I'm thinking the following might make more sense:

<svg xmlns="http://www.w3.org/2000/svg" aria-label="..." role="img" viewBox="0 0 512 512">
<path d="m0 0H512V512H0" fill="#fff"/>
...
</svg>

This would make it two lines shorter than now, but I think adds to the readability.

Possibly breaking the first line before aria-label is useful as now as that puts the name of the icon at the beginning of the line - perhaps the original intent. Or moving aria-label to be the first attribute.

Any thoughts?

[edent]

Let me have a think on it.

The original reason was to make the diffs easier to see - and the validity easier to parse. It also acts as a good Shibboleth to see who has read the guide before sending a PR.

[jmb]

Makes sense for sure!

[Eiim]

I do think the proposed format is more readable. I can see the point of it being less effective as a shibboleth, but I think most people would either have it on one line or each element on its own line by default (which admittedly is the same if you have a single <path>, which is a number of SVGs). Perhaps something like this strikes a better balance:

<svg xmlns="http://www.w3.org/2000/svg"
aria-label="..." role="img" viewBox="0 0 512 512">
<path d="m0 0H512V512H0" fill="#fff"/>
...
</svg>

[Eiim]

And/or, keep the closing tag on the same line as the icon elements, which I don't think really hinders readability.

[edent]

One of the reasons to keep the various elements on the same line is that \n takes up 1 byte. So >< results in a smaller filesize than >\n<