Add experimental support for Jump-to-def and Find-references #337
Conversation
| * the default CLI search path is used. | ||
| * @returns A list of query files found | ||
| */ | ||
| resolveQueriesInSuite(suite: string, additionalPacks: string[], searchPath?: string[]): Promise<string[]> { |
There was a problem hiding this comment.
Missing the suite param in the tsdoc
| args.push('--search-path', path.join(...searchPath)); | ||
| } | ||
| args.push(suite); | ||
| return this.runJsonCodeQlCliCommand<string[]>( |
There was a problem hiding this comment.
Should you mark this function as async?
There was a problem hiding this comment.
It's a fair question, and one which applies to a bunch of other Promise-returning functions in this file, but I think that I like the existing convention that we mark a function as async if it needs to be, i.e., actually uses await, and otherwise let its return type being Promise being a sufficient signal that what it returns isn't immediately a value but a future.
| * "codeQl.experimentalFeatures" directly in their vscode settings | ||
| * json file. | ||
| */ | ||
| export const EXPERIMENTAL_FEATURES_SETTING = new Setting('experimentalFeatures', ROOT_SETTING); |
There was a problem hiding this comment.
nice. I like Easter eggs. :)
| const SELECT_QUERY_NAME = "#select"; | ||
|
|
||
| enum KeyType { | ||
| DefinitionQuery, ReferenceQuery |
There was a problem hiding this comment.
For easier debugging, I like to do:
DefinitionQuery = 'DefinitionQuery',
ReferenceQuery = 'ReferenceQuery'
There was a problem hiding this comment.
Sure, can do. Iirc with ts enums, you do have maps in both directions (e.g. KeyType.ReferenceQuery = 1 and KeyType[1] = "ReferenceQuery") but I can understand not wanting to have the extra step.
This adds the ability to use vscode command palette commands
Go To DefinitionandGo To Referencesin source archive files for which there are appropriately tagged queries in the appropriate qlpack. The qlpack is inferred from the metadata of the database the source archive came from, in more or less the same way that quick query does.This ability is gated for the time being by a hidden feature flag in the user's vscode settings. Internal users can add
to their settings json file.
An example of "appropriately tagged queries" for C++ is added by github/codeql#3308.
Checklist
@github/product-docs-dspnow is a great time to test-drive this, but it can be shipped as-is without documentation, because users won't be able to accidentally stumble on it undocumented.