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

✨ Added intellisense support for component properties in VsCode #442

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GeraldAdyen
Copy link
Collaborator

📝 Description

I noticed that Lume components do not have any property intellisense in VsCode (and additional not type checking either).
In Vue you can do this by extending the GlobalComponents type which VsCode uses to for Vue components to figure out it's props.

This will greatly improve the user experience for users I think as it will save time having to look at documentation to find properties and for TS users it will add extra type checking to make sure values being set are correct.

This solution needs to be tested though but I was unable to get docker to run or was not sure if there is some testing playground app?

💥 Is this a breaking change (Yes/No):

  • No
  • Yes (please describe the impact and migration path for existing Lume users)

I checked both as for JS users there will be no impact, but for typescript users as there was not property type checking at all a feature like this could break type checkers in their application....

📝 Additional Information

  • (optional) Add additional information

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

Copy link

netlify bot commented Sep 18, 2024

Deploy Preview for adyen-lume ready!

Name Link
🔨 Latest commit 4d99381
🔍 Latest deploy log https://app.netlify.com/sites/adyen-lume/deploys/66ea85bebe0c9c0008a776dd
😎 Deploy Preview https://deploy-preview-442--adyen-lume.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@joao-m-santos
Copy link
Contributor

Thanks for the contribution @GeraldAdyen! I'll test it locally with a playground app.

@joao-m-santos
Copy link
Contributor

@GeraldAdyen locally, this code actually breaks the TS imports. I fixed it, but don't notice a difference between having GlobalComponents or not.
Can you give me an example of how it should look like with/without this extra Intellisense config?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants