fix(compiler): prevent underscore attr name camelcasing #1385
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
Benchmark resultsBase commit: lwc-engine-benchmark
|
caridy
reviewed
Jun 29, 2019
|
|
||
| it('attribute name separated by underscore and immediate hyphen', () => { | ||
| const { root } = parseTemplate(`<template> | ||
| <x-button under_-hyphen="bar"></x-button> |
There was a problem hiding this comment.
this one should probably be invalid... but hey! IMO it should throw.
caridy
reviewed
Jun 29, 2019
|
|
||
| it('attribute name with leading underscore and hyphen', () => { | ||
| const { root } = parseTemplate(`<template> | ||
| <x-button _leading-underscore="bar"></x-button> |
There was a problem hiding this comment.
same here, leading underscore should not be allowed in LWC. IMO
caridy
reviewed
Jun 29, 2019
|
|
||
| it('attribute name with trailing underscore and hyphen', () => { | ||
| const { root } = parseTemplate(`<template> | ||
| <x-button trailing-underscore_="bar"></x-button> |
There was a problem hiding this comment.
same here... should throw...
caridy
reviewed
Jun 29, 2019
| const attrToSplit = ATTRS_PROPS_TRANFORMS[propName] || propName; | ||
| propName = attrToSplit | ||
| .split('_') | ||
| .map(part => camelcase(part)) |
There was a problem hiding this comment.
this line is equivalent to: .map(camelcase)
caridy
suggested changes
Jun 29, 2019
Benchmark resultsBase commit: lwc-engine-benchmark
|
caridy
reviewed
Jul 3, 2019
| // disallow attr name with an underscore combined with non alphabetic characters | ||
| if (name.match(/_[^a-zA-Z]|[^a-zA-Z]_/)) { | ||
| const node = element.__original as parse5.AST.Default.Element; | ||
| warnAt(ParserDiagnostics.ATTRIBUTE_NAME_CANNOT_CONTAIN_UNDERSCORE_WITH_HYPHEN, [ |
There was a problem hiding this comment.
the message name doesn't reflect the actual error... it is not longer about -_
caridy
reviewed
Jul 3, 2019
| } | ||
|
|
||
| // disallow attr name with an underscore combined with non alphabetic characters | ||
| if (name.match(/_[^a-zA-Z]|[^a-zA-Z]_/)) { |
There was a problem hiding this comment.
since attributes are parsed to lowercase by parse5, you only need to match a-z here
Benchmark resultsBase commit: lwc-engine-benchmark
|
|
fix the tests, and let's move on. |
ekashida
reviewed
Jul 4, 2019
| } | ||
|
|
||
| // disallow attr name with an underscore combined with non alphabetic characters | ||
| if (name.match(/_[^a-z]|[^a-z]_/)) { |
There was a problem hiding this comment.
Are we excluding numbers on purpose?
There was a problem hiding this comment.
that's a good catch, it should support numbers as well... e.g.: foo_1
There was a problem hiding this comment.
Loosened up the restriction to allow trailing numbers; but not leading.
Benchmark resultsBase commit: lwc-engine-benchmark
|
caridy
reviewed
Jul 6, 2019
| code: 1124, | ||
| message: | ||
| '{0} is not valid attribute for {1}. Attribute name cannot start or end with an underscore.', | ||
| '{0} is not valid attribute for {1}. Attribute name cannot start with non alphabetic character.', |
There was a problem hiding this comment.
probably avoid negation on this messag,e something like: Attribute name must start with alphabetic character. instead
caridy
reviewed
Jul 6, 2019
| code: 1125, | ||
| message: | ||
| '{0} is not valid attribute for {1}. Attribute name cannot contain combination of underscore and hyphen characters.', | ||
| '{0} is not valid attribute for {1}. Attribute name cannot start or end with non alpha-numeric character.', |
caridy
approved these changes
Jul 6, 2019
Benchmark resultsBase commit: lwc-engine-benchmark
|
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.
Details
Fixes #1369 - prevent camel-casing of the attribute names with underscore.
Rules:
Does this PR introduce breaking changes?
No, it does not introduce breaking changes.