feat: remove empty non-boolean attributes #624
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
boutell
requested changes
Jun 8, 2023
README.md
Outdated
| @@ -167,6 +212,22 @@ allowedTags: false, | |||
| allowedAttributes: false | |||
| ``` | |||
|
|
|||
| #### "What if I want to allow empty attributes?" | |||
There was a problem hiding this comment.
This implies they are not allowed by default. They are allowed, just only where it makes sense.
This could be a better heading:
"What if I want to allow empty attributes, even for cases like href that normally don't make sense?"
|
|
||
| ```js | ||
| nonBooleanAttributes: ['*'] | ||
| ``` |
There was a problem hiding this comment.
Add a note that this will break common valid cases like checked and selected so for most ordinary HTML use cases it is best to avoid making this change.
|
Thanks for feedback, updated documentation. |
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.
Summary
This causes sanitize-html to remove empty attributes that are known to be non-boolean. It provides an exhaustive list of all known attributes taken from: https://html.spec.whatwg.org/multipage/indices.html#attributes-3
options.nonBooleanAttributesnonBooleanAttributes: []nonBooleanAttributes: ['*']Closes #123
What are the specific steps to test this change?
Test with empty attributes such as:
Will not remove anything.
Will transform into the first example.
What kind of change does this PR introduce?
Make sure the PR fulfills these requirements:
If adding a new feature without an already open issue, it's best to open a feature request issue first and wait for approval before working on it.