-
Notifications
You must be signed in to change notification settings - Fork 1.9k
VS Code extension docs: Changes to database downloads #14668
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,20 +18,26 @@ CodeQL for Visual Studio Code contains an AST viewer. The viewer consists of a g | |
| Viewing the abstract syntax tree of a source file | ||
| -------------------------------------------------- | ||
|
|
||
| 1. Open a source file from a CodeQL database. For example, you can navigate to a source file in the File Explorer. | ||
| 1. Open the CodeQL Databases view and right-click the database that you want to explore. Click **Add Database Source to Workspace**. | ||
|
|
||
| .. image:: ../images/codeql-for-visual-studio-code/add-database-source-to-workspace.png | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've stuck with a dark mode screenshot, for consistency with the rest of this doc. |
||
| :width: 350 | ||
| :alt: Add database source to workspace | ||
|
|
||
| 2. Navigate to a CodeQL database's source file in the File Explorer. | ||
|
|
||
| .. image:: ../images/codeql-for-visual-studio-code/open-source-file.png | ||
| :width: 350 | ||
| :alt: Open a source file | ||
|
|
||
| 2. Run **CodeQL: View AST** from the Command Palette. This runs a CodeQL query (usually called ``printAST.ql``) over the active file, which may take a few seconds. | ||
| 3. Run **CodeQL: View AST** from the Command Palette. This runs a CodeQL query (usually called ``printAST.ql``) over the active file, which may take a few seconds. | ||
|
|
||
| .. pull-quote:: Note | ||
|
|
||
| If you don't have an appropriate ``printAST.ql`` query in your workspace, the **CodeQL: View AST** command won't work. To fix this, you can update your copy of the `CodeQL <https://github.com/github/codeql>`__ repository from ``main``. If you do this, you may need to upgrade your databases. Also, query caches may be discarded and your next query runs could be slower. | ||
|
|
||
| 3. Once the query has run, the AST viewer displays the structure of the source file. | ||
| 4. To see the nested structure, click the arrows and expand the nodes. | ||
| 4. Once the query has run, the AST viewer displays the structure of the source file. | ||
| 5. To see the nested structure, click the arrows and expand the nodes. | ||
|
|
||
| .. image:: ../images/codeql-for-visual-studio-code/explore-ast.png | ||
| :alt: Explore the AST | ||
|
|
||
Binary file added
BIN
+72.8 KB
...odeql/images/codeql-for-visual-studio-code/add-database-source-to-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-1.73 KB
(98%)
docs/codeql/images/codeql-for-visual-studio-code/open-source-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated change: I just spotted that this was out of date.