Skip to content

Commit 07def7e

Browse files
committed
docs: add docblocks to the ExtensionMetaData interface.
1 parent 6534893 commit 07def7e

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,56 @@
1+
/**
2+
* Extension metadata for a VSCode extension
3+
*/
14
export interface ExtensionMetaData {
5+
/**
6+
* The unique ID in the form of `publisher.name`.
7+
*/
28
id: string;
9+
10+
/**
11+
* The name.
12+
* Directly from package.json "name" key.
13+
*/
314
name: string;
15+
16+
/**
17+
* The namespace for this extension's configuration settings,
18+
* which is a slightly shorter version of the name.
19+
*/
420
namespace?: string;
21+
22+
/**
23+
* The display name.
24+
* Directly from package.json "displayName" key.
25+
*/
526
displayName: string;
27+
28+
/**
29+
* The version.
30+
* Directly from package.json "version" key.
31+
*/
632
version: string;
33+
/**
34+
* The path to the user extensions.
35+
*/
736
userExtensionsPath: string;
37+
38+
/**
39+
* The path to the built-in extensions.
40+
*/
841
builtInExtensionsPath: string;
942

1043
/**
44+
* The Windows path to the user extensions when running in WSL.
45+
*
1146
* Only set when running in WSL.
1247
*/
13-
1448
WindowsUserExtensionsPathFromWsl?: string;
49+
50+
/**
51+
* The Windows path to the built-in extensions when running in WSL.
52+
*
53+
* Only set when running in WSL.
54+
*/
1555
WindowsBuiltInExtensionsPathFromWsl?: string;
1656
}

0 commit comments

Comments
 (0)