@idlebox/errors 0.1.17 → 0.1.19

package/src/error-types/dependency.ts

@@ -0,0 +1,51 @@
+import type { ChildProcess, SignalsType } from '../common/type-shim.js';
+import type { IErrorOptions } from '../common/type.js';
+import { ProgramError } from './development.js';
+
+export class DependencyError extends ProgramError {}
+
+interface IChildProcessErrorOptions extends IErrorOptions {
+	readonly commandline?: readonly string[];
+	readonly pid?: number;
+	readonly workingDirectory?: string;
+	readonly exitCode?: number;
+	readonly signal?: SignalsType;
+	readonly process?: ChildProcess;
+}
+
+export class ChildProcessExitError extends DependencyError {
+	public pid?: number;
+	public commandline?: readonly string[];
+	public workingDirectory?: string;
+	public exitCode?: number;
+	public signal?: SignalsType;
+	public process?: ChildProcess;
+
+	constructor({ pid, commandline, workingDirectory, exitCode, signal, process, ...opts }: IChildProcessErrorOptions) {
+		let message = '';
+		message += pid ? `子进程 ${pid} ` : '未知子进程';
+		message += '非预期退出, ';
+		if (exitCode) {
+			message += `返回 ${exitCode}`;
+		} else if (signal) {
+			message += `信号 ${signal}`;
+		} else {
+			message += '可能未正常启动';
+		}
+		if (commandline) {
+			message += `\n  命令行: ${commandline.join(' ')}`;
+		}
+		if (workingDirectory) {
+			message += `\n  工作目录: ${workingDirectory}`;
+		}
+
+		super(message, opts);
+
+		this.pid = pid;
+		this.commandline = commandline;
+		this.workingDirectory = workingDirectory;
+		this.exitCode = exitCode;
+		this.signal = signal;
+		this.process = process;
+	}
+}

package/src/error-types/development.ts

@@ -0,0 +1,61 @@
+import { ExitCode } from '../codes/wellknown-exit-codes.js';
+import { ErrorWithCode } from '../common/base.js';
+import type { IErrorOptions } from '../common/type.js';
+
+/**
+ * 由于程序出现bug导致的各类异常
+ */
+export abstract class ProgramError extends ErrorWithCode {
+	constructor(message: string, opts?: IErrorOptions) {
+		super(message, ExitCode.PROGRAM, opts);
+	}
+}
+
+export class NotImplementedError extends ProgramError {
+	constructor(message: string = '此功能未实现', opts?: IErrorOptions) {
+		super(message, opts);
+	}
+}
+
+export class SoftwareDefectError extends ProgramError {}
+
+export class Assertion extends SoftwareDefectError {
+	static ok(value: unknown, message: string = '断言失败', opts?: IErrorOptions): asserts value {
+		if (!value) {
+			if (!opts?.boundary) {
+				if (!opts) opts = {};
+				opts.boundary = Assertion.ok;
+			}
+			throw new SoftwareDefectError(`${message}: 应为真值, 实际为${typeof value}类型的 "${value}"`, opts);
+		}
+	}
+}
+
+interface IVariableTypeErrorOptions extends IErrorOptions {
+	Expected?: Function;
+	variableName?: string;
+}
+
+export class VariableTypeError extends ProgramError {
+	public readonly ExpectedClass?: Function;
+
+	constructor(
+		public readonly object: any,
+		{ Expected, variableName = '变量', ...opts }: IVariableTypeErrorOptions = {},
+	) {
+		let message = '';
+		if (Expected) {
+			message += `应是 ${Expected.name}`;
+		}
+
+		const Actual = object.constructor;
+		if (message) {
+			message += ', 实际是 ';
+		} else {
+			message += '不能是 ';
+		}
+		message += Actual.name;
+
+		super(`${object}的类型${message}`, opts);
+	}
+}

package/src/{common/unhandled-errors.ts → error-types/nodejs.unhandled.ts}

@@ -1,7 +1,4 @@
-/**
- *
- */
-class ProxiedError extends Error {
+export abstract class ProxiedError extends Error {
 	declare cause: any;
 
 	constructor(prefix: string, original: unknown) {

package/src/error-types/tools.ts

@@ -0,0 +1,48 @@
+import { ExitCode } from '../codes/wellknown-exit-codes.js';
+import { ErrorWithCode } from '../common/base.js';
+import { humanReadable, type IHumanReadable } from '../common/human-readable.js';
+import type { IErrorOptions } from '../common/type.js';
+
+/**
+ * 发生本程序主动发起的取消行为时
+ * @public
+ */
+export class CanceledError extends ErrorWithCode implements IHumanReadable {
+	constructor(opts?: IErrorOptions) {
+		super('Canceled', ExitCode.INTERRUPT, opts);
+	}
+
+	static is(e: unknown): e is CanceledError {
+		return e instanceof CanceledError;
+	}
+
+	override [humanReadable]() {
+		return '操作已应要求而取消';
+	}
+}
+
+/**
+ * 某种操作超时
+ *
+ * @public
+ */
+export class TimeoutError extends ErrorWithCode implements IHumanReadable {
+	private readonly what?: string;
+
+	constructor(
+		private readonly ms: number,
+		private readonly why = 'no response',
+		opts?: IErrorOptions & { what?: string },
+	) {
+		super(`Timeout: ${why} in ${ms}ms${opts?.what ? ` (when ${opts.what})` : ''}`, ExitCode.TIMEOUT, opts);
+		this.what = opts?.what;
+	}
+
+	static is(error: unknown): error is TimeoutError {
+		return error instanceof TimeoutError;
+	}
+
+	override [humanReadable]() {
+		return `操作超时: ${this.what ? this.what : '操作没有说明'}\n  - 时长: ${this.ms}ms\n  - 原因: ${this.why}`;
+	}
+}

package/lib/common/application.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/common/application.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAE7E;;;GAGG;AACH,qBAAa,IAAK,SAAQ,aAAa;gBAC1B,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa;CAG9C;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,aAAa;aAE/B,MAAM,EAAE,MAAM,CAAC,OAAO;gBAAtB,MAAM,EAAE,MAAM,CAAC,OAAO,EACtC,IAAI,CAAC,EAAE,aAAa;IAKZ,CAAC,aAAa,CAAC;CAGxB;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,aAAa;gBAChC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa;IAIxC,CAAC,aAAa,CAAC;CAGxB"}

package/lib/common/application.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"application.js","sourceRoot":"","sources":["../../src/common/application.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,aAAa,EAAsB,MAAM,WAAW,CAAC;AAE7E;;;GAGG;AACH,MAAM,OAAO,IAAK,SAAQ,aAAa;IACtC,YAAY,IAAY,EAAE,IAAoB;QAC7C,KAAK,CAAC,0BAA0B,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,aAAa;IAE/B;IADjB,YACiB,MAAsB,EACtC,IAAoB;QAEpB,KAAK,CAAC,uBAAuB,MAAM,EAAE,EAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAHjD,WAAM,GAAN,MAAM,CAAgB;IAIvC,CAAC;IAEQ,CAAC,aAAa,CAAC;QACvB,OAAO,SAAS,IAAI,CAAC,MAAM,OAAO,CAAC;IACpC,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,aAAa;IAC5C,YAAY,OAAe,EAAE,IAAoB;QAChD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAEQ,CAAC,aAAa,CAAC;QACvB,OAAO,SAAS,IAAI,CAAC,OAAO,+BAA+B,CAAC;IAC7D,CAAC;CACD"}

package/lib/common/development.d.ts

@@ -1,12 +0,0 @@
-import { ErrorWithCode, type IErrorOptions } from './base.js';
-export declare abstract class ProgramError extends ErrorWithCode {
-    constructor(message: string, opts?: IErrorOptions);
-}
-export declare class NotImplementedError extends ProgramError {
-}
-export declare class SoftwareDefectError extends ProgramError {
-}
-export declare class Assertion extends SoftwareDefectError {
-    static ok(value: unknown, message?: string, opts?: IErrorOptions): asserts value;
-}
-//# sourceMappingURL=development.d.ts.map

package/lib/common/development.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"development.d.ts","sourceRoot":"","sources":["../../src/common/development.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAE9D,8BAAsB,YAAa,SAAQ,aAAa;gBAC3C,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,aAAa;CAGjD;AAED,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AAExD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AAExD,qBAAa,SAAU,SAAQ,mBAAmB;IACjD,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,GAAE,MAA2B,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK;CASpG"}

package/lib/common/development.js

@@ -1,24 +0,0 @@
-import { ExitCode } from '../codes/wellknown-exit-codes.js';
-import { ErrorWithCode } from './base.js';
-export class ProgramError extends ErrorWithCode {
-    constructor(message, opts) {
-        super(message, ExitCode.PROGRAM, opts);
-    }
-}
-export class NotImplementedError extends ProgramError {
-}
-export class SoftwareDefectError extends ProgramError {
-}
-export class Assertion extends SoftwareDefectError {
-    static ok(value, message = 'Assertion failed', opts) {
-        if (!value) {
-            if (!opts?.boundary) {
-                if (!opts)
-                    opts = {};
-                opts.boundary = Assertion.ok;
-            }
-            throw new SoftwareDefectError(`${message}: value should be truthy, got ${typeof value} (${value})`, opts);
-        }
-    }
-}
-//# sourceMappingURL=development.js.map

package/lib/common/development.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"development.js","sourceRoot":"","sources":["../../src/common/development.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAsB,MAAM,WAAW,CAAC;AAE9D,MAAM,OAAgB,YAAa,SAAQ,aAAa;IACvD,YAAY,OAAe,EAAE,IAAoB;QAChD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;CACD;AAED,MAAM,OAAO,mBAAoB,SAAQ,YAAY;CAAG;AAExD,MAAM,OAAO,mBAAoB,SAAQ,YAAY;CAAG;AAExD,MAAM,OAAO,SAAU,SAAQ,mBAAmB;IACjD,MAAM,CAAC,EAAE,CAAC,KAAc,EAAE,UAAkB,kBAAkB,EAAE,IAAoB;QACnF,IAAI,CAAC,KAAK,EAAE,CAAC;YACZ,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;gBACrB,IAAI,CAAC,IAAI;oBAAE,IAAI,GAAG,EAAE,CAAC;gBACrB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,EAAE,CAAC;YAC9B,CAAC;YACD,MAAM,IAAI,mBAAmB,CAAC,GAAG,OAAO,iCAAiC,OAAO,KAAK,KAAK,KAAK,GAAG,EAAE,IAAI,CAAC,CAAC;QAC3G,CAAC;IACF,CAAC;CACD"}

package/lib/common/nodejs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodejs.d.ts","sourceRoot":"","sources":["../../src/common/nodejs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAE/D,KAAK,aAAa,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,IAAgC;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC;AAErF,MAAM,WAAW,gBAAiB,SAAQ,KAAK;IAC9C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,OAAO,GAAG,EAAE,IAAI,aAAa,CAAC,aAAa,CAAC,gBAAgB,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAE7I;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,MAAM,CAAC,CAEtF;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,MAAM,CAAC,CAEnF;AAED,uCAAuC;AACvC,eAAO,MAAM,WAAW,wBAAkB,CAAC;AAE3C;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAE9G;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,aAAa,CAE1D"}

package/lib/common/nodejs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"nodejs.js","sourceRoot":"","sources":["../../src/common/nodejs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAW/D;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,EAAW;IAClD,OAAO,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,aAAa,CAAC,gBAAgB,IAAI,EAAE,CAAC,IAAI,KAAK,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAC1H,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,CAAU;IAC1C,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,MAAM,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,CAAU;IACvC,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,MAAM,CAAC;AAC3D,CAAC;AAED,uCAAuC;AACvC,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,CAAU;IACzC,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO,CAAC,CAAC;AAClG,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,CAAU;IACrC,OAAO,CAAC,YAAY,KAAK,IAAI,OAAQ,CAAS,CAAC,IAAI,KAAK,QAAQ,CAAC;AAClE,CAAC"}

package/lib/common/unhandled-errors.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"unhandled-errors.d.ts","sourceRoot":"","sources":["../../src/common/unhandled-errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAM,YAAa,SAAQ,KAAK;IACvB,KAAK,EAAE,GAAG,CAAC;gBAEP,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO;IAK7C,IAAa,KAAK,IAAI,MAAM,CAS3B;CACD;AAED,qBAAa,kBAAmB,SAAQ,YAAY;aAGlC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;gBADzC,MAAM,EAAE,OAAO,EACC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;CAI1C;AAED,qBAAa,iBAAkB,SAAQ,YAAY;aACtB,KAAK,EAAE,KAAK;gBAAZ,KAAK,EAAE,KAAK;CAGxC"}

package/src/common/development.ts

@@ -1,24 +0,0 @@
-import { ExitCode } from '../codes/wellknown-exit-codes.js';
-import { ErrorWithCode, type IErrorOptions } from './base.js';
-
-export abstract class ProgramError extends ErrorWithCode {
-	constructor(message: string, opts?: IErrorOptions) {
-		super(message, ExitCode.PROGRAM, opts);
-	}
-}
-
-export class NotImplementedError extends ProgramError {}
-
-export class SoftwareDefectError extends ProgramError {}
-
-export class Assertion extends SoftwareDefectError {
-	static ok(value: unknown, message: string = 'Assertion failed', opts?: IErrorOptions): asserts value {
-		if (!value) {
-			if (!opts?.boundary) {
-				if (!opts) opts = {};
-				opts.boundary = Assertion.ok;
-			}
-			throw new SoftwareDefectError(`${message}: value should be truthy, got ${typeof value} (${value})`, opts);
-		}
-	}
-}