diff options
Diffstat (limited to 'node_modules/simple-git/src/lib/errors')
5 files changed, 94 insertions, 0 deletions
diff --git a/node_modules/simple-git/src/lib/errors/git-construct-error.d.ts b/node_modules/simple-git/src/lib/errors/git-construct-error.d.ts new file mode 100644 index 0000000..6c6f067 --- /dev/null +++ b/node_modules/simple-git/src/lib/errors/git-construct-error.d.ts @@ -0,0 +1,15 @@ +import { GitError } from './git-error'; +import { SimpleGitOptions } from '../types'; +/** + * The `GitConstructError` is thrown when an error occurs in the constructor + * of the `simple-git` instance itself. Most commonly as a result of using + * a `baseDir` option that points to a folder that either does not exist, + * or cannot be read by the user the node script is running as. + * + * Check the `.message` property for more detail including the properties + * passed to the constructor. + */ +export declare class GitConstructError extends GitError { + readonly config: SimpleGitOptions; + constructor(config: SimpleGitOptions, message: string); +} diff --git a/node_modules/simple-git/src/lib/errors/git-error.d.ts b/node_modules/simple-git/src/lib/errors/git-error.d.ts new file mode 100644 index 0000000..a0677ab --- /dev/null +++ b/node_modules/simple-git/src/lib/errors/git-error.d.ts @@ -0,0 +1,29 @@ +/** + * The `GitError` is thrown when the underlying `git` process throws a + * fatal exception (eg an `ENOENT` exception when attempting to use a + * non-writable directory as the root for your repo), and acts as the + * base class for more specific errors thrown by the parsing of the + * git response or errors in the configuration of the task about to + * be run. + * + * When an exception is thrown, pending tasks in the same instance will + * not be executed. The recommended way to run a series of tasks that + * can independently fail without needing to prevent future tasks from + * running is to catch them individually: + * + * ```typescript + import { gitP, SimpleGit, GitError, PullResult } from 'simple-git'; + + function catchTask (e: GitError) { + return e. + } + + const git = gitP(repoWorkingDir); + const pulled: PullResult | GitError = await git.pull().catch(catchTask); + const pushed: string | GitError = await git.pushTags().catch(catchTask); + ``` + */ +export declare class GitError extends Error { + task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined; + constructor(task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined, message?: string); +} diff --git a/node_modules/simple-git/src/lib/errors/git-plugin-error.d.ts b/node_modules/simple-git/src/lib/errors/git-plugin-error.d.ts new file mode 100644 index 0000000..17aed24 --- /dev/null +++ b/node_modules/simple-git/src/lib/errors/git-plugin-error.d.ts @@ -0,0 +1,6 @@ +import { GitError } from './git-error'; +export declare class GitPluginError extends GitError { + task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined; + readonly plugin?: "progress" | "timeout" | "completion" | "errors" | "spawnOptions" | "baseDir" | "binary" | "maxConcurrentProcesses" | "config" | undefined; + constructor(task?: import("../tasks/task").EmptyTask | import("../types").StringTask<any> | import("../types").BufferTask<any> | undefined, plugin?: "progress" | "timeout" | "completion" | "errors" | "spawnOptions" | "baseDir" | "binary" | "maxConcurrentProcesses" | "config" | undefined, message?: string); +} diff --git a/node_modules/simple-git/src/lib/errors/git-response-error.d.ts b/node_modules/simple-git/src/lib/errors/git-response-error.d.ts new file mode 100644 index 0000000..5d77bb0 --- /dev/null +++ b/node_modules/simple-git/src/lib/errors/git-response-error.d.ts @@ -0,0 +1,32 @@ +import { GitError } from './git-error'; +/** + * The `GitResponseError` is the wrapper for a parsed response that is treated as + * a fatal error, for example attempting a `merge` can leave the repo in a corrupted + * state when there are conflicts so the task will reject rather than resolve. + * + * For example, catching the merge conflict exception: + * + * ```typescript + import { gitP, SimpleGit, GitResponseError, MergeSummary } from 'simple-git'; + + const git = gitP(repoRoot); + const mergeOptions: string[] = ['--no-ff', 'other-branch']; + const mergeSummary: MergeSummary = await git.merge(mergeOptions) + .catch((e: GitResponseError<MergeSummary>) => e.git); + + if (mergeSummary.failed) { + // deal with the error + } + ``` + */ +export declare class GitResponseError<T = any> extends GitError { + /** + * `.git` access the parsed response that is treated as being an error + */ + readonly git: T; + constructor( + /** + * `.git` access the parsed response that is treated as being an error + */ + git: T, message?: string); +} diff --git a/node_modules/simple-git/src/lib/errors/task-configuration-error.d.ts b/node_modules/simple-git/src/lib/errors/task-configuration-error.d.ts new file mode 100644 index 0000000..9f8a957 --- /dev/null +++ b/node_modules/simple-git/src/lib/errors/task-configuration-error.d.ts @@ -0,0 +1,12 @@ +import { GitError } from './git-error'; +/** + * The `TaskConfigurationError` is thrown when a command was incorrectly + * configured. An error of this kind means that no attempt was made to + * run your command through the underlying `git` binary. + * + * Check the `.message` property for more detail on why your configuration + * resulted in an error. + */ +export declare class TaskConfigurationError extends GitError { + constructor(message?: string); +} |