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.

Sign up for GitHub

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

Jump to bottom

Missing @summary annotation on new generated components #978

Closed
CrookedGrin opened this issue Oct 25, 2022 · 1 comment · Fixed by #979
Closed

Missing @summary annotation on new generated components #978

CrookedGrin opened this issue Oct 25, 2022 · 1 comment · Fixed by #979
Assignees
@claviska
Labels
bug Things that aren't working right in the library.

Comments

@CrookedGrin
Copy link
Contributor

Describe the bug

Generating a new component scaffold via npm run create sl-[something] currently throws an error in the console and fails to render. This is due to a missing @summary annotation in the generated component code.

To Reproduce

Steps to reproduce the behavior:

  1. Install a fresh copy of the repo (npm i, etc.)
  2. Run npm run create sl-[somecomponent]
  3. Start the dev server
  4. Navigate to the component page, observe that content pane doesn't refresh
  5. Refresh, observe blank pane and error in console

Screenshots

image
image

Browser / OS

  • OS: Mac
  • Browser: Chrome
  • Browser version: Latest

Additional information

Will make a PR with the suggested fix (just adding @summary to component.hbs)
@CrookedGrin CrookedGrin added the bug Things that aren't working right in the library. label Oct 25, 2022
CrookedGrin added a commit to CrookedGrin/shoelace that referenced this issue Oct 25, 2022
@CrookedGrin
Fix: Issue 978 - Missing @summary annotation
64e2eb7 
Fixes shoelace-style#978
@CrookedGrin CrookedGrin mentioned this issue Oct 25, 2022
Merged
@CrookedGrin
Copy link
Contributor Author

PR at #979

claviska pushed a commit that referenced this issue Oct 27, 2022
@CrookedGrin
Fix: Issue 978 - Missing @summary annotation (#979)
4db0aec 
Fixes #978
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@claviska claviska

Labels
bug Things that aren't working right in the library.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix: Issue 978 - Missing @summary annotation CrookedGrin/shoelace
2 participants
@claviska @CrookedGrin