Fix typos and augment comments around language labels

This commit is contained in:
Andrew Eisenberg
2020-12-04 09:03:43 -08:00
parent 67e8c86ccc
commit 06a1fd91e4
4 changed files with 10 additions and 8 deletions

View File

@@ -125,7 +125,7 @@ export class CodeQLCliServer implements Disposable {
private static CLI_VERSION_WITH_DECOMPILE_KIND_DIL = new SemVer('2.3.0');
/**
* CLI version where --kind=DIL was introduced
* CLI version where languages are exposed during a `codeql resolve database` command.
*/
private static CLI_VERSION_WITH_LANGUAGE = new SemVer('2.4.1');
@@ -716,7 +716,7 @@ export class CodeQLCliServer implements Disposable {
return (await this.getVersion()).compare(CodeQLCliServer.CLI_VERSION_WITH_DECOMPILE_KIND_DIL) >= 0;
}
public async supportsLangaugeName() {
public async supportsLanguageName() {
return (await this.getVersion()).compare(CodeQLCliServer.CLI_VERSION_WITH_LANGUAGE) >= 0;
}

View File

@@ -831,8 +831,10 @@ export class DatabaseManager extends DisposableObject {
}
private async getPrimaryLanguage(dbPath: string) {
if (!(await this.cli.supportsLangaugeName())) {
// return undefined so that we continually recalculate until the cli version is bumped
if (!(await this.cli.supportsLanguageName())) {
// return undefined so that we recalculate on restart until the cli is at a version that
// supports this feature. This recalculation is cheap since we avoid calling into the cli
// unless we know it can return the langauges property.
return undefined;
}
const dbInfo = await this.cli.resolveDatabase(dbPath);

View File

@@ -466,12 +466,12 @@ export class CachedOperation<U> {
/**
* Note that this heuristic is only being used for backwards compatibility with
* CLI versions before the langauge name was introduced to dbInfo. Implementations
* CLI versions before the langauge name was introduced to dbInfo. Features
* that do not require backwards compatibility should call
* `cli.CodeQLCliServer.resolveDatabase` and use the first entry in the
* `languages` property.
*
* @see cli.CodeQLCliServer.supportsLangaugeName
* @see cli.CodeQLCliServer.supportsLanguageName
* @see cli.CodeQLCliServer.resolveDatabase
*/
const dbSchemeToLanguage = {
@@ -487,7 +487,7 @@ const dbSchemeToLanguage = {
* Returns the initial contents for an empty query, based on the language of the selected
* databse.
*
* First try to get the contents text based on language. if that fails, try to get based on
* First try to use the given language name. If that doesn't exist, try to infer it based on
* dbscheme. Otherwise return no import statement.
*
* @param language the database language or empty string if unknown

View File

@@ -71,7 +71,7 @@ describe('databases', () => {
supportsDatabaseRegistration: supportsDatabaseRegistrationSpy
} as unknown as QueryServerClient,
{
supportsLangaugeName: supportsLanguageNameSpy,
supportsLanguageName: supportsLanguageNameSpy,
resolveDatabase: resolveDatabaseSpy
} as unknown as CodeQLCliServer,
{} as Logger,