Files
languageservices/languageserver/src/initializationOptions.ts
T

66 lines
1.3 KiB
TypeScript
Raw Permalink Normal View History

import {ExperimentalFeatures} from "@actions/expressions";
2023-02-24 08:53:51 -08:00
import {LogLevel} from "@actions/languageservice/log";
export {LogLevel} from "@actions/languageservice/log";
2022-12-05 10:05:41 -08:00
2022-11-08 17:00:59 -08:00
export interface InitializationOptions {
2023-01-24 17:39:24 -08:00
/**
* GitHub token that will be used to retrieve additional information from github.com
*
* Requires the `repo` and `workflow` scopes
*/
2022-11-08 17:00:59 -08:00
sessionToken?: string;
2022-12-05 10:05:41 -08:00
2023-01-30 17:05:32 -08:00
/**
* Optional user agent to use when making calls to github.com
*/
userAgent?: string;
2023-01-24 17:39:24 -08:00
/**
* List of repositories that the language server should be aware of
*/
2022-11-08 17:00:59 -08:00
repos?: RepositoryContext[];
2022-12-05 10:05:41 -08:00
2023-01-24 17:39:24 -08:00
/**
* Desired log level
*/
2022-12-05 10:05:41 -08:00
logLevel?: LogLevel;
2023-05-08 17:00:05 +02:00
/**
* If a GitHub Enterprise Server should be used, the URL of the API endpoint, eg "https://ghe.my-company.com/api/v3"
*/
2023-05-25 00:57:30 +02:00
gitHubApiUrl?: string;
/**
* Experimental features that are opt-in.
* Features listed here may change or be removed without notice.
*/
experimentalFeatures?: ExperimentalFeatures;
2022-11-08 17:00:59 -08:00
}
export interface RepositoryContext {
2023-01-24 17:39:24 -08:00
/**
* Repository ID
*/
2022-11-08 17:00:59 -08:00
id: number;
2023-01-24 17:39:24 -08:00
/**
* Repository owner
*/
2022-11-08 17:00:59 -08:00
owner: string;
2023-01-24 17:39:24 -08:00
2023-01-30 17:57:07 -05:00
/**
* Indicates if the repository is owned by an organization
*/
organizationOwned: boolean;
2023-01-24 17:39:24 -08:00
/**
* Repository name
*/
2022-11-08 17:00:59 -08:00
name: string;
2023-01-24 17:39:24 -08:00
/**
* Local workspace uri
*/
2022-11-08 17:00:59 -08:00
workspaceUri: string;
}