Add EnvironmentContext to App

This commit is contained in:
Robert
2023-06-05 11:40:55 +01:00
parent af9af99f09
commit 1d80cbb496
7 changed files with 43 additions and 14 deletions

View File

@@ -23,6 +23,7 @@ export interface App {
readonly onDidChangeWorkspaceFolders: Event<WorkspaceFoldersChangeEvent>;
readonly credentials: Credentials;
readonly commands: AppCommandManager;
readonly environment: EnvironmentContext;
}
export enum AppMode {
@@ -30,3 +31,7 @@ export enum AppMode {
Development = 2,
Test = 3,
}
export interface EnvironmentContext {
language: string;
}

View File

@@ -1,5 +1,5 @@
import { basename, dirname, join } from "path";
import { env } from "vscode";
import { EnvironmentContext } from "./app";
/**
* A node in the tree of files. This will be either a `FileTreeDirectory` or a `FileTreeLeaf`.
@@ -35,6 +35,7 @@ export class FileTreeDirectory<T = undefined> extends FileTreeNode<T> {
constructor(
_path: string,
_name: string,
protected readonly env: EnvironmentContext,
private _children: Array<FileTreeNode<T>> = [],
) {
super(_path, _name);
@@ -66,7 +67,9 @@ export class FileTreeDirectory<T = undefined> extends FileTreeNode<T> {
this._children.filter(
(child) => child instanceof FileTreeLeaf || child.children.length > 0,
);
this._children.sort((a, b) => a.name.localeCompare(b.name, env.language));
this._children.sort((a, b) =>
a.name.localeCompare(b.name, this.env.language),
);
this._children.forEach((child, i) => {
child.finish();
if (
@@ -77,6 +80,7 @@ export class FileTreeDirectory<T = undefined> extends FileTreeNode<T> {
const replacement = new FileTreeDirectory<T>(
child.children[0].path,
`${child.name} / ${child.children[0].name}`,
this.env,
Array.from(child.children[0].children),
);
this._children[i] = replacement;
@@ -89,7 +93,11 @@ export class FileTreeDirectory<T = undefined> extends FileTreeNode<T> {
if (existingChild !== undefined) {
return existingChild as FileTreeDirectory<T>;
} else {
const newChild = new FileTreeDirectory<T>(join(this.path, name), name);
const newChild = new FileTreeDirectory<T>(
join(this.path, name),
name,
this.env,
);
this.addChild(newChild);
return newChild;
}

View File

@@ -1,7 +1,7 @@
import * as vscode from "vscode";
import { VSCodeCredentials } from "./authentication";
import { Disposable } from "../../pure/disposable-object";
import { App, AppMode } from "../app";
import { App, AppMode, EnvironmentContext } from "../app";
import { AppEventEmitter } from "../events";
import { extLogger, Logger, queryServerLogger } from "../logging";
import { Memento } from "../memento";
@@ -69,4 +69,10 @@ export class ExtensionApp implements App {
public createEventEmitter<T>(): AppEventEmitter<T> {
return new VSCodeAppEventEmitter<T>();
}
public get environment(): EnvironmentContext {
return {
language: vscode.env.language,
};
}
}

View File

@@ -1,7 +1,7 @@
import { dirname, basename, normalize, relative } from "path";
import { Discovery } from "../common/discovery";
import { CodeQLCliServer } from "../codeql-cli/cli";
import { Event, RelativePattern, Uri, WorkspaceFolder } from "vscode";
import { Event, RelativePattern, Uri, WorkspaceFolder, env } from "vscode";
import { MultiFileSystemWatcher } from "../common/vscode/multi-file-system-watcher";
import { App } from "../common/app";
import { FileTreeDirectory, FileTreeLeaf } from "../common/file-tree-nodes";
@@ -124,7 +124,7 @@ export class QueryDiscovery
return undefined;
}
const rootDirectory = new FileTreeDirectory<string>(fullPath, name);
const rootDirectory = new FileTreeDirectory<string>(fullPath, name, env);
for (const queryPath of resolvedQueries) {
const relativePath = normalize(relative(fullPath, queryPath));
const dirName = dirname(relativePath);

View File

@@ -6,6 +6,7 @@ import {
Uri,
RelativePattern,
WorkspaceFolder,
env,
} from "vscode";
import { MultiFileSystemWatcher } from "../common/vscode/multi-file-system-watcher";
import { CodeQLCliServer } from "../codeql-cli/cli";
@@ -97,7 +98,7 @@ export class QLTestDiscovery extends Discovery<QLTestDiscoveryResults> {
private async discoverTests(): Promise<FileTreeDirectory> {
const fullPath = this.workspaceFolder.uri.fsPath;
const name = this.workspaceFolder.name;
const rootDirectory = new FileTreeDirectory(fullPath, name);
const rootDirectory = new FileTreeDirectory(fullPath, name, env);
// Don't try discovery on workspace folders that don't exist on the filesystem
if (await pathExists(fullPath)) {

View File

@@ -1,4 +1,4 @@
import { App, AppMode } from "../../src/common/app";
import { App, AppMode, EnvironmentContext } from "../../src/common/app";
import { AppEvent, AppEventEmitter } from "../../src/common/events";
import { Memento } from "../../src/common/memento";
import { Disposable } from "../../src/pure/disposable-object";
@@ -24,6 +24,7 @@ export function createMockApp({
onDidChangeWorkspaceFolders = jest.fn(),
credentials = testCredentialsWithStub(),
commands = createMockCommandManager(),
environment = createMockEnvironmentContext(),
}: {
extensionPath?: string;
workspaceStoragePath?: string;
@@ -34,6 +35,7 @@ export function createMockApp({
onDidChangeWorkspaceFolders?: Event<WorkspaceFoldersChangeEvent>;
credentials?: Credentials;
commands?: AppCommandManager;
environment?: EnvironmentContext;
}): App {
return {
mode: AppMode.Test,
@@ -48,6 +50,7 @@ export function createMockApp({
createEventEmitter,
credentials,
commands,
environment,
};
}
@@ -68,3 +71,9 @@ export class MockAppEventEmitter<T> implements AppEventEmitter<T> {
// no-op
}
}
export function createMockEnvironmentContext(): EnvironmentContext {
return {
language: "en-US",
};
}

View File

@@ -1,4 +1,4 @@
import { EventEmitter } from "vscode";
import { EventEmitter, env } from "vscode";
import {
FileTreeDirectory,
FileTreeLeaf,
@@ -31,8 +31,8 @@ describe("QueryTreeDataProvider", () => {
it("converts FileTreeNode to QueryTreeViewItem", async () => {
const dataProvider = new QueryTreeDataProvider({
queries: [
new FileTreeDirectory<string>("dir1", "dir1", [
new FileTreeDirectory<string>("dir1/dir2", "dir2", [
new FileTreeDirectory<string>("dir1", "dir1", env, [
new FileTreeDirectory<string>("dir1/dir2", "dir2", env, [
new FileTreeLeaf<string>(
"dir1/dir2/file1",
"file1",
@@ -45,7 +45,7 @@ describe("QueryTreeDataProvider", () => {
),
]),
]),
new FileTreeDirectory<string>("dir3", "dir3", [
new FileTreeDirectory<string>("dir3", "dir3", env, [
new FileTreeLeaf<string>("dir3/file3", "file3", "javascript"),
]),
],
@@ -78,7 +78,7 @@ describe("QueryTreeDataProvider", () => {
const onDidChangeQueriesEmitter = new EventEmitter<void>();
const queryDiscoverer: QueryDiscoverer = {
queries: [
new FileTreeDirectory<string>("dir1", "dir1", [
new FileTreeDirectory<string>("dir1", "dir1", env, [
new FileTreeLeaf<string>("dir1/file1", "file1", "javascript"),
]),
],
@@ -89,7 +89,7 @@ describe("QueryTreeDataProvider", () => {
expect(dataProvider.getChildren().length).toEqual(1);
queryDiscoverer.queries?.push(
new FileTreeDirectory<string>("dir2", "dir2", [
new FileTreeDirectory<string>("dir2", "dir2", env, [
new FileTreeLeaf<string>("dir2/file2", "file2", "javascript"),
]),
);