Added article for working with codeQL packs in VS Code#6473
Conversation
|
@AlonaHlobina and @adityasharad - this pull request adds an article for working with (beta) CodeQL packs in Visual Studio Code. It is fairly short right now, just there to show that CodeQL packs works with various VS Code features related to code editing, but could be added to later if something else came up. Whenever you get a chance, if you don't mind taking a look and letting me know if anything is wrong or looks to be missing - thank you! 😄 |
adityasharad
left a comment
There was a problem hiding this comment.
Thanks! @aeisenberg anything you'd like to add?
| If you want to understand a query in a CodeQL pack better, you can open the query file and view the code, using the IntelliSense code editing features of Visual Studio Code. For example, if you hover over an object from a library depended on by the pack, Visual Studio Code will resolve it so you can see documentation about the object. | ||
|
|
||
| To view the full definition of an object from a library, you can right-click and choose **Go to Definition**. This will take you to the object definition in the library in your package cache, the shared location where downloaded dependencies are stored, which is in your home directory by default. No newline at end of file |
There was a problem hiding this comment.
We tend not to use "object" -- I suggest something like "element of a query" or "entity".
Library pack dependencies may also be found in the current workspace (we will look there first, before looking in the package cache). So I suggest something like "If the library pack is present within the same VS Code workspace, this will take you to the definition within the workspace. Otherwise it will take you to the definition of the library within your package cache ..."
The description of the package cache itself is very good :)
There was a problem hiding this comment.
Thank you so much for this clarification, this makes sense! I will update the wording as you suggested :)
ethanpalm
left a comment
There was a problem hiding this comment.
This looks great. I left a few comments and one question, but nothing should be blocking. I'll try to keep an eye on this PR if my review gets dismissed by any changes ⚡
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Show resolved
Hide resolved
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
aeisenberg
left a comment
There was a problem hiding this comment.
Looks great. Just a small suggestion and a comment that doesn't require any change on your part.
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Outdated
Show resolved
Hide resolved
docs/codeql/codeql-for-visual-studio-code/working-with-codeql-packs-in-visual-studio-code.rst
Show resolved
Hide resolved
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Andrew Eisenberg <aeisenberg@github.com>
|
Sorry that all the approvals got dismissed, I had to fix a typo! Should be all set now :) |
…scode Added article for working with codeQL packs in VS Code
This PR adds an article about working with codeQL packs in VS Code. It mainly covers that codeQL packs (in beta currently) can be viewed in VS Code, and the qlpack.yml file as well as queries, can be edited. It also mentions that VS Code code editing features such as autocomplete, hovering to get documentation, and right-clicking to see the definition, work.
Changes in this PR