Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bug: generated documentation does not display custom properties when included in loud comments #5623

Closed
3 tasks done
duhem-s opened this issue Apr 4, 2024 · 2 comments · Fixed by #5706
Closed
3 tasks done
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil

Comments

@duhem-s
Copy link

duhem-s commented Apr 4, 2024

Prerequisites

Stencil Version

v4.14.0

Current Behavior

When I document custom CSS properties using syntax within loud comments in my CSS files, the generated documentation does not display them.

In Sass, to preserve comments we have to set them as loud comments using the following format:

/*!
 * @prop --mg-badge-size: Badge size
 */

https://sass-lang.com/documentation/syntax/comments/#in-scss

However, these loud comments do not seem to be interpreted by the documentation generation process.

Expected Behavior

I expect the documentation to display the --mg-badge-size custom property with its associated description, indicating that it represents the badge size.

System Info

No response

Steps to Reproduce

Add loud comment in CSS like: https://github.com/duhem-s/stencil-css/blob/main/src/components/my-component/my-component.css

Run build command.

Custom properties are not displayed in readme.

Code Reproduction URL

https://github.com/duhem-s/stencil-css/tree/main

Additional Information

No response

@ionitron-bot ionitron-bot bot added the triage label Apr 4, 2024
@rwaskiewicz rwaskiewicz self-assigned this Apr 4, 2024
@rwaskiewicz
Copy link
Member

Thanks for the issue + reproduction case! I verified that Stencil can "see" comments that begin with a /*!, but it's currently not doing anything with them. I'm going to label this to get it added to our backlog.

Thanks again!

@rwaskiewicz rwaskiewicz added the Bug: Validated This PR or Issue is verified to be a bug within Stencil label Apr 4, 2024
@rwaskiewicz rwaskiewicz removed their assignment Apr 4, 2024
@ionitron-bot ionitron-bot bot removed the triage label Apr 4, 2024
github-merge-queue bot pushed a commit that referenced this issue Apr 25, 2024
)

* fix(compiler): recognize loud comments when generating style docs

Fixes: #5623

STENCIL-1254

* add test for multiple comment types
@rwaskiewicz
Copy link
Member

The fix for this issue was included in today's release of Stencil v4.17.2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants