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

Fix custom-elements.json #10024

Closed
2 tasks done
jogibear9988 opened this issue Feb 5, 2023 · 8 comments
Closed
2 tasks done

Fix custom-elements.json #10024

jogibear9988 opened this issue Feb 5, 2023 · 8 comments
Assignees
Labels
bug Something isn't working dev Needs some dev work package: carbon web components package: web components Work necessary for the IBM.com Library web components package severity 3 Affects minor functionality, has a workaround

Comments

@jogibear9988
Copy link

Description

The custom-elements.json seems to be an old version, and the path in the manifest links to the .ts files, but according to the spec it should link to the .js files (it also only makes sense, cause the .js files are the ones that get used).

I need the correct spec for the components to work in my designer: https://node-projects.github.io/web-component-designer-demo/index.html

Component(s) impacted

all

Browser

Chrome

Carbon for IBM.com version

current

Severity

Severity 1 = The design is broken in a critical way that blocks users from completing tasks or damages the brand. Affects major functionality, no workaround.

Application/website

a designer

Package

@carbon/web-components

CodeSandbox example

no sample

Steps to reproduce the issue (if applicable)

No response

Release date (if applicable)

No response

Code of Conduct

@jogibear9988 jogibear9988 added bug Something isn't working dev Needs some dev work labels Feb 5, 2023
@kennylam kennylam added severity 3 Affects minor functionality, has a workaround package: web components Work necessary for the IBM.com Library web components package package: carbon web components labels Feb 6, 2023
@emyarod
Copy link
Member

emyarod commented Feb 23, 2023

Can you explain more about what you mean by the spec needing to link to .js files? For reference, the playground examples for web-component-analyzer also link to .ts files

but just as a heads up, web-component-analyzer emits this message on every use, so it may be brittle to depend on:

!!!!!!!!!!!!!  WARNING !!!!!!!!!!!!!
The custom-elements.json format is for experimental purposes. You can expect changes to this format.
Please follow and contribute to the discussion at:
  - https://github.com/webcomponents/custom-elements-json
  - https://github.com/w3c/webcomponents/issues/776
!!!!!!!!!!!!!  WARNING !!!!!!!!!!!!!

@jogibear9988
Copy link
Author

This was wrong, see:
webcomponents/custom-elements-manifest#96 (comment)

For example, my designer uses the manifest to load the components, but a browser could not load .ts files

@emyarod
Copy link
Member

emyarod commented Feb 23, 2023

I only see a discussion in your link but I'm not finding the resolution. Either we would have to migrate off of web-component-analyzer or there needs to be an issue opened on that repo instead to correct the analyzer's behavior, is that right?

@justinfagnani
Copy link

The module paths need to link to where users and tools can actually import the element from. For TypeScript projects that is _not_the source file. web-components-analyzer is indeed incorrect here. The Lit team is working on a new analyzer that outputs the correct paths (most of the time, if you don't have a different build step after TypeScript). It should be ready enough to generate manifests soon: https://github.com/lit/lit/tree/main/packages/labs/analyzer

@emyarod
Copy link
Member

emyarod commented Feb 24, 2023

thank you for the clarification! So it looks like the next steps here would be to open an issue against web-components-analyzer, and in the meantime we will also keep an eye on the Lit team's analyzer for a possible migration

@stale
Copy link

stale bot commented May 26, 2023

We've marked this issue as stale because there hasn't been any activity for 60 days. If there's no further activity on this issue in the next three days then we'll close it. You can keep the conversation going with just a short comment. Thanks for your contributions.

@jogibear9988
Copy link
Author

do not close...

@stale stale bot removed the inactive label May 30, 2023
@oliviaflory oliviaflory moved this to Backlog in Carbon for IBM.com May 30, 2023
@jogibear9988 jogibear9988 changed the title Fix custom-elements.jsoin Fix custom-elements.json Aug 18, 2023
@abdonrd
Copy link
Contributor

abdonrd commented Aug 18, 2023

@jeffchew @kennylam looks like the v2 version has the same problem.

Could you review it? Thank you!

@andy-blum andy-blum closed this as not planned Won't fix, can't repro, duplicate, stale Dec 11, 2024
@github-project-automation github-project-automation bot moved this from Doing to Done in Carbon for IBM.com Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dev Needs some dev work package: carbon web components package: web components Work necessary for the IBM.com Library web components package severity 3 Affects minor functionality, has a workaround
Projects
Status: Done
Development

No branches or pull requests