diff options
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | 2024-03-12 23:07:32 +0000 |
---|---|---|
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | 2024-03-12 23:07:32 +0000 |
commit | 47562fa92998f8f4289ae9a8048349067754d52e (patch) | |
tree | c1643be8ab17fc607cea748a8bb1d621a5964873 /pw_ide/ts/pigweed-vscode/src/config.ts | |
parent | eeec55b65fe2c3c7647bb70ea44b3c839eb1267c (diff) | |
parent | 646563934a3e2ee26f50171f94d95173a1662e2c (diff) | |
download | pigweed-47562fa92998f8f4289ae9a8048349067754d52e.tar.gz |
Snap for 11566117 from 646563934a3e2ee26f50171f94d95173a1662e2c to sdk-releaseplatform-tools-35.0.1
Change-Id: Iec629b181a2c6905754a4c340e334884e13fd3b4
Diffstat (limited to 'pw_ide/ts/pigweed-vscode/src/config.ts')
-rw-r--r-- | pw_ide/ts/pigweed-vscode/src/config.ts | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/pw_ide/ts/pigweed-vscode/src/config.ts b/pw_ide/ts/pigweed-vscode/src/config.ts new file mode 100644 index 000000000..c4879fba6 --- /dev/null +++ b/pw_ide/ts/pigweed-vscode/src/config.ts @@ -0,0 +1,94 @@ +// Copyright 2023 The Pigweed Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); you may not +// use this file except in compliance with the License. You may obtain a copy of +// the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +// License for the specific language governing permissions and limitations under +// the License. + +import * as hjson from 'hjson'; +import * as vscode from 'vscode'; + +/** + * Schema for extensions.json + */ +export interface ExtensionsJson { + recommendations?: string[]; + unwantedRecommendations?: string[]; +} + +/** + * Partial schema for the workspace config file + */ +interface WorkspaceConfig { + extensions?: ExtensionsJson; +} + +// When the project is opened directly (i.e., by opening the repo directory), +// we have direct access to extensions.json. But if the project is part of a +// workspace (https://code.visualstudio.com/docs/editor/workspaces), we'll get +// a combined config that includes the equivalent of extensions.json associated +// with the "extensions" key. This is taken into consideration only for the sake +// of completeness; Pigweed doesn't currently support the use of workspaces. +type LoadableConfig = ExtensionsJson & WorkspaceConfig; + +/** + * Load a config file that contains extensions.json data. This could be + * extensions.json itself, or a workspace file that contains the equivalent. + * @param uri - A file path to load + * @returns - The extensions.json file data + */ +export async function loadExtensionsJson( + uri: vscode.Uri, +): Promise<ExtensionsJson> { + const buffer = await vscode.workspace.fs.readFile(uri); + const config: LoadableConfig = hjson.parse(buffer.toString()); + + if (config.extensions) { + return config.extensions; + } + + return config as ExtensionsJson; +} + +/** + * Find and return the extensions.json data for the project. + * @param includeWorkspace - Also search workspace files + * @returns The extensions.json file data + */ +export async function getExtensionsJson( + includeWorkspace = false, +): Promise<ExtensionsJson> { + const files = await vscode.workspace.findFiles( + '.vscode/extensions.json', + '**/node_modules/**', + ); + + if (includeWorkspace) { + const workspaceFile = vscode.workspace.workspaceFile; + + if (workspaceFile) { + files.push(workspaceFile); + } + } + + if (files.length == 0) { + // TODO(chadnorvell): Improve this + vscode.window.showErrorMessage('extensions.json is missing!'); + throw new Error('extensions.json is missing!'); + } else { + if (files.length > 1) { + vscode.window.showWarningMessage( + 'Found multiple extensions.json! Will only use the first.', + ); + } + + return await loadExtensionsJson(files[0]); + } +} |