Add comments to the initalization options
This commit is contained in:
@@ -2,17 +2,42 @@ import {LogLevel} from "@github/actions-languageservice/log";
|
|||||||
export {LogLevel} from "@github/actions-languageservice/log";
|
export {LogLevel} from "@github/actions-languageservice/log";
|
||||||
|
|
||||||
export interface InitializationOptions {
|
export interface InitializationOptions {
|
||||||
|
/**
|
||||||
|
* GitHub token that will be used to retrieve additional information from github.com
|
||||||
|
*
|
||||||
|
* Requires the `repo` and `workflow` scopes
|
||||||
|
*/
|
||||||
sessionToken?: string;
|
sessionToken?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of repositories that the language server should be aware of
|
||||||
|
*/
|
||||||
repos?: RepositoryContext[];
|
repos?: RepositoryContext[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Desired log level
|
||||||
|
*/
|
||||||
logLevel?: LogLevel;
|
logLevel?: LogLevel;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RepositoryContext {
|
export interface RepositoryContext {
|
||||||
|
/**
|
||||||
|
* Repository ID
|
||||||
|
*/
|
||||||
id: number;
|
id: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Repository owner
|
||||||
|
*/
|
||||||
owner: string;
|
owner: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Repository name
|
||||||
|
*/
|
||||||
name: string;
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Local workspace uri
|
||||||
|
*/
|
||||||
workspaceUri: string;
|
workspaceUri: string;
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user