mirror of
https://github.com/godotengine/godot-csharp-vscode.git
synced 2025-12-31 21:48:32 +03:00
253cbf9522
Separates the extension.ts code in multiple files and adds an asset generator code to provide the `tasks.json` and `launch.json` files (can be triggered manually with a command). - The build task generated uses the Godot CLI to build the solution (as described in #18), I think this is the cleanest solution since we let Godot handle the building of the project, but the user must configure the path to the Godot executable. - The Launch debug configuration is now created with the build `preLaunchTask` automatically so users won't have to set it up manually (fixes #18). - Adds snippets to `tasks.json` to add debug configuration easily after the file has been created. - Adds a command to generate the `tasks.json` and `launch.json` manually for convenience (asks the user if they want to override their current configuration first).
354 lines
10 KiB
TypeScript
354 lines
10 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
// Copied from http://code.visualstudio.com/docs/editor/tasks_appendix
|
|
|
|
declare module "vscode-tasks" {
|
|
export interface TaskConfiguration extends BaseTaskConfiguration {
|
|
|
|
/**
|
|
* The configuration's version number
|
|
*/
|
|
version: string;
|
|
|
|
/**
|
|
* Windows specific task configuration
|
|
*/
|
|
windows?: BaseTaskConfiguration;
|
|
|
|
/**
|
|
* Mac specific task configuration
|
|
*/
|
|
osx?: BaseTaskConfiguration;
|
|
|
|
/**
|
|
* Linux specific task configuration
|
|
*/
|
|
linux?: BaseTaskConfiguration;
|
|
}
|
|
|
|
export interface BaseTaskConfiguration {
|
|
|
|
/**
|
|
* The type of a custom task. Tasks of type "shell" are executed
|
|
* inside a shell (e.g. bash, cmd, powershell, ...)
|
|
*/
|
|
type?: "shell" | "process";
|
|
|
|
/**
|
|
* The command to be executed. Can be an external program or a shell
|
|
* command.
|
|
*/
|
|
command?: string;
|
|
|
|
/**
|
|
* Specifies whether a global command is a background task.
|
|
*/
|
|
isBackground?: boolean;
|
|
|
|
/**
|
|
* The command options used when the command is executed. Can be omitted.
|
|
*/
|
|
options?: CommandOptions;
|
|
|
|
/**
|
|
* The arguments passed to the command. Can be omitted.
|
|
*/
|
|
args?: string[];
|
|
|
|
/**
|
|
* The presentation options.
|
|
*/
|
|
presentation?: PresentationOptions;
|
|
|
|
/**
|
|
* The problem matcher to be used if a global command is executed (e.g. no tasks
|
|
* are defined). A tasks.json file can either contain a global problemMatcher
|
|
* property or a tasks property but not both.
|
|
*/
|
|
problemMatcher?: string | ProblemMatcher | (string | ProblemMatcher)[];
|
|
|
|
/**
|
|
* The configuration of the available tasks. A tasks.json file can either
|
|
* contain a global problemMatcher property or a tasks property but not both.
|
|
*/
|
|
tasks?: TaskDescription[];
|
|
}
|
|
|
|
|
|
/**
|
|
* Options to be passed to the external program or shell
|
|
*/
|
|
export interface CommandOptions {
|
|
|
|
/**
|
|
* The current working directory of the executed program or shell.
|
|
* If omitted Ticino's current workspace root is used.
|
|
*/
|
|
cwd?: string;
|
|
|
|
/**
|
|
* The environment of the executed program or shell. If omitted
|
|
* the parent process' environment is used.
|
|
*/
|
|
env?: { [key: string]: string; };
|
|
|
|
/**
|
|
* Configuration of the shell when task type is `shell`
|
|
*/
|
|
shell: {
|
|
|
|
/**
|
|
* The shell to use.
|
|
*/
|
|
executable: string;
|
|
|
|
/**
|
|
* The arguments to be passed to the shell executable to run in command mode
|
|
* (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).
|
|
*/
|
|
args?: string[];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* The description of a task.
|
|
*/
|
|
export interface TaskDescription {
|
|
|
|
/**
|
|
* The task's name
|
|
*/
|
|
label: string;
|
|
|
|
/**
|
|
* The type of a custom task. Tasks of type "shell" are executed
|
|
* inside a shell (e.g. bash, cmd, powershell, ...)
|
|
*/
|
|
type: "shell" | "process";
|
|
|
|
/**
|
|
* The command to execute. If the type is "shell" it should be the full
|
|
* command line including any additional arguments passed to the command.
|
|
*/
|
|
command: string;
|
|
|
|
/**
|
|
* Whether the executed command is kept alive and runs in the background.
|
|
*/
|
|
isBackground?: boolean;
|
|
|
|
/**
|
|
* Additional arguments passed to the command. Should be used if type
|
|
* is "process".
|
|
*/
|
|
args?: string[];
|
|
|
|
/**
|
|
* Tasks V1 isBuildCommand is used to detect if the tasks is in a build group.
|
|
*/
|
|
isBuildCommand?: boolean;
|
|
|
|
/**
|
|
* Defines the group to which this tasks belongs
|
|
*/
|
|
group?: "build" | "string";
|
|
|
|
/**
|
|
* The presentation options.
|
|
*/
|
|
presentation?: PresentationOptions;
|
|
|
|
/**
|
|
* The problem matcher(s) to use to capture problems in the tasks
|
|
* output.
|
|
*/
|
|
problemMatcher?: string | ProblemMatcher | (string | ProblemMatcher)[];
|
|
}
|
|
|
|
export interface PresentationOptions {
|
|
|
|
/**
|
|
* Controls whether the task output is reveal in the user interface.
|
|
* Defaults to `always`.
|
|
*/
|
|
reveal?: "never" | "silent" | "always";
|
|
|
|
/**
|
|
* Controls whether the command associated with the task is echoed
|
|
* in the user interface.
|
|
*/
|
|
echo?: boolean;
|
|
|
|
/**
|
|
* Controls whether the panel showing the task output is taking focus.
|
|
*/
|
|
focus?: boolean;
|
|
|
|
/**
|
|
* Controls if the task panel is used for this task only (dedicated),
|
|
* shared between tasks (shared) or if a new panel is created on
|
|
* every task execution (new). Defaults to `shared`
|
|
*/
|
|
panel?: "shared" | "dedicated" | "new";
|
|
}
|
|
|
|
/**
|
|
* A description of a problem matcher that detects problems
|
|
* in build output.
|
|
*/
|
|
export interface ProblemMatcher {
|
|
|
|
/**
|
|
* The name of a base problem matcher to use. If specified the
|
|
* base problem matcher will be used as a template and properties
|
|
* specified here will replace properties of the base problem
|
|
* matcher
|
|
*/
|
|
base?: string;
|
|
|
|
/**
|
|
* The owner of the produced VS Code problem. This is typically
|
|
* the identifier of a VS Code language service if the problems are
|
|
* to be merged with the one produced by the language service
|
|
* or 'external'. Defaults to 'external' if omitted.
|
|
*/
|
|
owner?: string;
|
|
|
|
/**
|
|
* The severity of the VS Code problem produced by this problem matcher.
|
|
*
|
|
* Valid values are:
|
|
* "error": to produce errors.
|
|
* "warning": to produce warnings.
|
|
* "info": to produce infos.
|
|
*
|
|
* The value is used if a pattern doesn't specify a severity match group.
|
|
* Defaults to "error" if omitted.
|
|
*/
|
|
severity?: string;
|
|
|
|
/**
|
|
* Defines how filename reported in a problem pattern
|
|
* should be read. Valid values are:
|
|
* - "absolute": the filename is always treated absolute.
|
|
* - "relative": the filename is always treated relative to
|
|
* the current working directory. This is the default.
|
|
* - ["relative", "path value"]: the filename is always
|
|
* treated relative to the given path value.
|
|
*/
|
|
fileLocation?: string | string[];
|
|
|
|
/**
|
|
* The name of a predefined problem pattern, the inline definition
|
|
* of a problem pattern or an array of problem patterns to match
|
|
* problems spread over multiple lines.
|
|
*/
|
|
pattern?: string | ProblemPattern | ProblemPattern[];
|
|
|
|
/**
|
|
* Additional information used to detect when a background task (like a watching task in Gulp)
|
|
* is active.
|
|
*/
|
|
background?: BackgroundMatcher;
|
|
}
|
|
|
|
/**
|
|
* A description to track the start and end of a background task.
|
|
*/
|
|
export interface BackgroundMatcher {
|
|
|
|
/**
|
|
* If set to true the watcher is in active mode when the task
|
|
* starts. This is equals of issuing a line that matches the
|
|
* beginPattern.
|
|
*/
|
|
activeOnStart?: boolean;
|
|
|
|
/**
|
|
* If matched in the output the start of a background task is signaled.
|
|
*/
|
|
beginsPattern?: string;
|
|
|
|
/**
|
|
* If matched in the output the end of a background task is signaled.
|
|
*/
|
|
endsPattern?: string;
|
|
}
|
|
|
|
export interface ProblemPattern {
|
|
|
|
/**
|
|
* The regular expression to find a problem in the console output of an
|
|
* executed task.
|
|
*/
|
|
regexp: string;
|
|
|
|
/**
|
|
* The match group index of the filename.
|
|
*/
|
|
file: number;
|
|
|
|
/**
|
|
* The match group index of the problems's location. Valid location
|
|
* patterns are: (line), (line,column) and (startLine,startColumn,endLine,endColumn).
|
|
* If omitted the line and column properties are used.
|
|
*/
|
|
location?: number;
|
|
|
|
/**
|
|
* The match group index of the problem's line in the source file.
|
|
* Can only be omitted if location is specified.
|
|
*/
|
|
line?: number;
|
|
|
|
/**
|
|
* The match group index of the problem's column in the source file.
|
|
*/
|
|
column?: number;
|
|
|
|
/**
|
|
* The match group index of the problem's end line in the source file.
|
|
*
|
|
* Defaults to undefined. No end line is captured.
|
|
*/
|
|
endLine?: number;
|
|
|
|
/**
|
|
* The match group index of the problem's end column in the source file.
|
|
*
|
|
* Defaults to undefined. No end column is captured.
|
|
*/
|
|
endColumn?: number;
|
|
|
|
/**
|
|
* The match group index of the problem's severity.
|
|
*
|
|
* Defaults to undefined. In this case the problem matcher's severity
|
|
* is used.
|
|
*/
|
|
severity?: number;
|
|
|
|
/**
|
|
* The match group index of the problem's code.
|
|
*
|
|
* Defaults to undefined. No code is captured.
|
|
*/
|
|
code?: number;
|
|
|
|
/**
|
|
* The match group index of the message. Defaults to 0.
|
|
*/
|
|
message: number;
|
|
|
|
/**
|
|
* Specifies if the last pattern in a multi line problem matcher should
|
|
* loop as long as it does match a line consequently. Only valid on the
|
|
* last problem pattern in a multi line problem matcher.
|
|
*/
|
|
loop?: boolean;
|
|
}
|
|
}
|