Skip to content

Do not output type property for CSS properties doc blocks #148

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
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Do not output type property for CSS properties doc blocks #148

wants to merge 1 commit into from

Conversation

@peschee
Copy link
Contributor

@peschee peschee commented Nov 7, 2021 •
edited
Loading

This

import { LitElement } from 'lit-element';

/**
 * @cssprop {color} [--var-test=red] Test css custom prop
 */
export class MyElement extends LitElement {}

would output

{
  "cssProperties": [
    {
      "type": {
        "text": "color"
      },
      "description": "Test css custom prop",
      "name": "--var-test",
      "default": "red"
    }
  ]
}

While the CssCustomProperty has no type in the schema: https://github.com/webcomponents/custom-elements-manifest/blob/a07ec8fd1aa921532bba0e8af21ee993f3bda2a5/schema.d.ts#L322-L354

@netlify
Copy link

netlify bot commented Nov 7, 2021 •
edited
Loading

✔️ Deploy Preview for custom-elements-manifest-analyzer ready!

🔨 Explore the source changes: d3c9258

🔍 Inspect the deploy log: https://app.netlify.com/sites/custom-elements-manifest-analyzer/deploys/6187eb532f0b5d00074060d6

😎 Browse the preview: https://deploy-preview-148--custom-elements-manifest-analyzer.netlify.app

@peschee peschee changed the title Do not output type property for CSS properties. Do not output type property for CSS properties doc blocks Nov 7, 2021
@break-stuff
Copy link
Collaborator

My plugin relies on this type being set in the manifest

@peschee
Copy link
Contributor Author

peschee commented Dec 5, 2022

@break-stuff It is not defined in the schema though. However, is maybe the syntax something you could work with?

https://github.com/webcomponents/custom-elements-manifest/blob/main/schema.d.ts#L394

@break-stuff
Copy link
Collaborator

I think that should work for me.

@break-stuff
Copy link
Collaborator

@peschee are you able to update this to set that value to the syntax property?

@break-stuff
Copy link
Collaborator

This would probably constitute a breaking change. I wonder if there is a way to add both for now and mark the type is deprecated until the next major release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@peschee @break-stuff