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

Add JSDoc to document attributes for camel case properties #896

Closed
web-padawan opened this issue Jul 15, 2020 · 0 comments
Closed

Add JSDoc to document attributes for camel case properties #896

web-padawan opened this issue Jul 15, 2020 · 0 comments
Labels
DX Developer experience issue typescript TypeScript definitions issue

Comments

@web-padawan
Copy link
Member

Description

When using lit-analyzer for linting code that uses vaadin-combo-box, there are warnings for certain attributes.

Expected outcome

No warnings when using attributes corresponding to camel case properties.

Actual outcome

The following warnings are shown:

    Unknown attribute 'item-value-path'. Did you mean 'itemValuePath'?
    20:  item-value-path="lastName"
    no-unknown-attribute


    Unknown attribute 'item-label-path'. Did you mean 'itemLabelPath'?
    21:  item-label-path="lastName"

Steps to reproduce

  1. Clone the repo: https://github.com/web-padawan/ts-vaadin-examples
  2. Run yarn to install dependencies
  3. Run `yarn lint:lit

Suggested fix

Add the following to JSDoc annotations for corresponding properties:

* @attr {string} item-label-path
* @attr {string} item-value-path
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DX Developer experience issue typescript TypeScript definitions issue
Projects
None yet
Development

No branches or pull requests

2 participants