Distinguish between classes and elements in pphtml #1242
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When checking for unused/undefined CSS, classes and elements were stored in the same array, which was OK for most things. However, if a classname was also an element name (e.g. `br`) it would be incorrectly reported or ignored. This commit prepends a period to stored class names to match the class name in the CSS. It also treats anything like `<string` as a potential element name. This is safer than trying to maintain a list of all valid element names, and if the user has an invalid element name, the validator will tell them, so pphtml doesn't need to do that.
srjfoo
approved these changes
Aug 31, 2023
cpeel
approved these changes
Sep 3, 2023
src/lib/ppvchecks/pphtml.pl
Outdated
| my $help = 0; # set true if help requested | ||
| my $srctext = "book.html"; # default source file | ||
| my $outfile = "xxx"; | ||
| my $validchar = "[-_[:alnum:]]"; # Valid characters for classnames, etc. |
There was a problem hiding this comment.
Not sure how precise you care to be here, but valid elements must start with an alpha character, then 0 or more [:alnum:], -, or _:
[:alpha:][-_[:alnum:]]*
rather than
[-_[:alnum:]]+
There was a problem hiding this comment.
I wasn't too worried, as it's not really checking valid HTML - just the class use. However, it's probably better to do as you suggest, so it doesn't confuse PPers or future developers, so I'll rustle up another commit - thanks!
There was a problem hiding this comment.
@cpeel - thanks - I've done that now. At least in Perl regex, [:alpha:] can only be used inside a character class, so the regex needed to be [[:alpha:]][-_[:alnum:]]*
Class names have to start with alphabetic character, not number, hyphen or underscore.
cpeel
approved these changes
Sep 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When checking for unused/undefined CSS, classes and elements were stored in the same array, which was OK for most things. However, if a classname was also an element name (e.g.
br) it would be incorrectly reported or ignored.This commit prepends a period to stored class names to match the class name in the CSS. It also treats anything like
<stringas a potential element name. This is safer than trying to maintain a list of all valid element names, and if the user has an invalid element name, the validator will tell them, so pphtml doesn't need to do that.