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

Task 10337 Add doc folder #51

Merged
merged 13 commits into from
Nov 7, 2023
Merged

Task 10337 Add doc folder #51

merged 13 commits into from
Nov 7, 2023

Conversation

WilsonZiweiWang
Copy link
Collaborator

@WilsonZiweiWang WilsonZiweiWang commented Nov 3, 2023

Since we don't want to read users' bitbake folder, I added a doc folder at the project root. (Currently, the folder contains the files needed by the bitbakeDocScanner parse functions)
I passed the extension path (which points to client/ in our case) in initializationOptions so the server can receive it. The path is then used to construct the doc path in bitbakedocScanner. So after the compilation, the server still knows the correct path (since it is relative to the client folder). A default path is provided to pass the tests. (Or set the path in tests?)

Copy link
Member

@deribaucourt deribaucourt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code is great but I think we should make sure this is the approach we want.
Like task.rst, we must identify a maintainable way to update and package external documentation files.

client/src/language/languageClient.ts Show resolved Hide resolved
server/src/BitBakeDocScanner.ts Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
scripts/fetch-docs.sh Show resolved Hide resolved
scripts/fetch-docs.sh Show resolved Hide resolved
@deribaucourt
Copy link
Member

I tested that the .vsix properly showed hover documentation for variables. However it doesn't for tasks but I don't think we implemented that yet.

@WilsonZiweiWang
Copy link
Collaborator Author

I tested that the .vsix properly showed hover documentation for variables. However it doesn't for tasks but I don't think we implemented that yet.

Yes, we didn't implement it in the onHover, I prefer to do it another PR since I am planning to optimize the bitbakedocscanner which is related to it.

@deribaucourt
Copy link
Member

LGTM

@WilsonZiweiWang WilsonZiweiWang merged commit 42261f8 into staging Nov 7, 2023
1 check passed
@WilsonZiweiWang WilsonZiweiWang deleted the Task-10337-doc-folder branch November 7, 2023 16:45
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.

3 participants