fix(templates): replace HTML comments with HBS ones #4681
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
vladitasev
approved these changes
Feb 15, 2022
ilhan007
added a commit
that referenced
this pull request
Mar 18, 2022
Replaces the HTML comments inside the HBS templates with HBS comments as suggested in the related issue and following the [official docs](https://handlebarsjs.com/examples/comments.html). The HBS comments are stripped from the output and are available only to developers at DEV time, while the HTML ones are part of the output and could be observed in the browser. After this change only the lit-html comments can be seen. Previously (the comment is part of the lit template) ```js const block0 = (context, tags, suffix) => html`<div class="ui5-panel-root"><!-- header: either header or h1 with header text --><div @click="${context._headerClick}" ``` After (the comment is removed) ```js const block0 = (context, tags, suffix) => html`<div class="ui5-panel-root"><div @click="${context._headerClick}" ``` As the related issue suggests, I went trough the list of tasks: - [ ] investigate the hbs2lit script's handling of comments - we can look at this more closely, so far haven't found anything specific to comments, the following [line] somehow seems relevant at least it has "comment" in the name (https://github.com/SAP/ui5-webcomponents/blob/master/packages/tools/lib/hbs2lit/src/partialsVisitor.js#L95) ```js CommentStatement: function(/* comment */) {}, ``` - [X] add support for hbs comments, if necessary - have not found issues so far, HBS comments work as expected - [x] use hbs comments everywhere (fix all current templates) - done with the change Related to: #2802
Closed
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.
Replaces the HTML comments inside the HBS templates with HBS comments as suggested in the related issue and following the official docs. The HBS comments are stripped from the output and are available only to developers at DEV time, while the HTML ones are part of the output and could be observed in the browser. After this change only the lit-html comments can be seen.
Previously (the comment is part of the lit template)
After (the comment is removed)
As the related issue suggests, I went trough the list of tasks:
Related to: #2802