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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃悰 Bug Report: JSDocstrings for functions not appearing in VSCode Intellisense thingy when using Web SDK #84

Open
2 tasks done
RyanBaig opened this issue Dec 25, 2023 · 1 comment
Assignees
Labels
bug Something isn't working question Further information is requested

Comments

@RyanBaig
Copy link

馃憻 Reproduction steps

  1. Open HTML file.
  2. Add Web SDK CDN.
  3. Initialize Appwrite Client using:
const client = new Appwrite.Client()
  1. Set Projects, Endpoint:
client.setProject("myProject");
client.setEndpoint("https://cloud.appwrite.io/v1")
  1. Hover over client.setProject("myProject"); or client.setEndpoint("https://cloud.appwrite.io/v1") and see no JSDocstring.

馃憤 Expected behavior

When I hover over the client.setProject("myProject"); or client.setEndpoint("https://cloud.appwrite.io/v1") part, it should show the JSDoc using this Docstring provided in your source code:

/**
     * Set Endpoint
     *
     * Your project endpoint
     *
     * @param {string} endpoint
     *
     * @returns {this}
*/

or

/**
     * Set Project
     *
     * Your project ID
     *
     * @param value string
     *
     * @return {this}
*/

馃憥 Actual Behavior

They actually don't. I am not sure if this is a problem by the IDE or not.

馃幉 Appwrite version

Version 0.10.x

馃捇 Operating system

Windows

馃П Your Environment

Vercel for hosting. VSCode 1.70.3 as IDE, Windows 7 for OS, HP Probook 4520s for Machine

馃憖 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

馃彚 Have you read the Code of Conduct?

@RyanBaig RyanBaig added the bug Something isn't working label Dec 25, 2023
@stnguyen90
Copy link
Contributor

@RyanBaig, thanks for raising this issue! 馃檹馃徏 Does this work with any other package from CDN? Do you have a code sample of it working with another CDN? I tried with lodash and didn't get any typing info:

image

From my experience, your IDE knows about packages when you have a package.json and install the package so it's in your node_modules. When you add a script tag for a package, the IDE has no idea about the types and whatnot about the package.

@stnguyen90 stnguyen90 self-assigned this May 3, 2024
@stnguyen90 stnguyen90 added the question Further information is requested label May 3, 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 question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants