@idlebox/errors 0.1.11 → 0.1.13

package/lib/autoindex.d.ts

@@ -13,6 +13,9 @@ export { ExitCode } from "./codes/wellknown-exit-codes.js";
 export { Exit } from "./common/application.js";
 export { InterruptError } from "./common/application.js";
 export { UsageError } from "./common/application.js";
+export { humanReadable } from "./common/base.js";
+export type { IHumanReadable } from "./common/base.js";
+export { isHumanReadableError } from "./common/base.js";
 export { NotError } from "./common/base.js";
 export { ErrorWithCode } from "./common/base.js";
 export { CanceledError } from "./common/base.js";

package/lib/autoindex.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"autoindex.d.ts","sourceRoot":"","sources":["../src/autoindex.ts"],"names":[],"mappings":"AAAA;;;;;;;gFAOgF;AAS/E,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAG9D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAG/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAG3D,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGpD,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"autoindex.d.ts","sourceRoot":"","sources":["../src/autoindex.ts"],"names":[],"mappings":"AAAA;;;;;;;gFAOgF;AAS/E,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAG9D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAG/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAG3D,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGpD,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC"}

package/lib/autoindex.js

@@ -28,6 +28,8 @@ export { InterruptError } from "./common/application.js";
 export { UsageError } from "./common/application.js";
 /* common/base.ts */
 // Identifiers
+export { humanReadable } from "./common/base.js";
+export { isHumanReadableError } from "./common/base.js";
 export { NotError } from "./common/base.js";
 export { ErrorWithCode } from "./common/base.js";
 export { CanceledError } from "./common/base.js";

package/lib/autoindex.js.map

@@ -1 +1 @@
-{"version":3,"file":"autoindex.js","sourceRoot":"","sources":["../src/autoindex.ts"],"names":[],"mappings":"AAAA;;;;;;;gFAOgF;AAChF,8BAA8B;AAC9B,wCAAwC;AACxC,0CAA0C;AAC1C,oBAAoB;AACpB,aAAa;AAEb,gCAAgC;AAC/B,cAAc;AACd,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC/D,+BAA+B;AAC9B,cAAc;AACd,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAChE,mCAAmC;AAClC,cAAc;AACd,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC5D,2BAA2B;AAC1B,cAAc;AACd,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACtD,oBAAoB;AACnB,cAAc;AACd,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACjD,2BAA2B;AAC1B,cAAc;AACd,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAClD,gCAAgC;AAC/B,cAAc;AACd,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"autoindex.js","sourceRoot":"","sources":["../src/autoindex.ts"],"names":[],"mappings":"AAAA;;;;;;;gFAOgF;AAChF,8BAA8B;AAC9B,wCAAwC;AACxC,0CAA0C;AAC1C,oBAAoB;AACpB,aAAa;AAEb,gCAAgC;AAC/B,cAAc;AACd,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC/D,+BAA+B;AAC9B,cAAc;AACd,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAChE,mCAAmC;AAClC,cAAc;AACd,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC5D,2BAA2B;AAC1B,cAAc;AACd,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACtD,oBAAoB;AACnB,cAAc;AACd,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACjD,2BAA2B;AAC1B,cAAc;AACd,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAClD,gCAAgC;AAC/B,cAAc;AACd,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC"}

package/lib/common/application.d.ts

@@ -1,4 +1,4 @@
-import { ErrorWithCode } from './base.js';
+import { ErrorWithCode, humanReadable } from './base.js';
 /**
  * 程序因为正常运行结束而退出
  * catch到此错误时应直接重新抛出，不应做其他处理
@@ -13,11 +13,13 @@ export declare class Exit extends ErrorWithCode {
 export declare class InterruptError extends ErrorWithCode {
     readonly signal: NodeJS.Signals;
     constructor(signal: NodeJS.Signals, boundary?: CallableFunction);
+    [humanReadable](): string;
 }
 /**
  * 由于错误的参数、配置导致错误
  */
 export declare class UsageError extends ErrorWithCode {
     constructor(message: string, boundary?: CallableFunction);
+    [humanReadable](): string;
 }
 //# sourceMappingURL=application.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/common/application.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C;;;GAGG;AACH,qBAAa,IAAK,SAAQ,aAAa;gBAC1B,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB;CAGrD;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,aAAa;aAE/B,MAAM,EAAE,MAAM,CAAC,OAAO;gBAAtB,MAAM,EAAE,MAAM,CAAC,OAAO,EACtC,QAAQ,CAAC,EAAE,gBAAgB;CAI5B;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,aAAa;gBAChC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB;CAGxD"}
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/common/application.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEzD;;;GAGG;AACH,qBAAa,IAAK,SAAQ,aAAa;gBAC1B,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB;CAGrD;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,aAAa;aAE/B,MAAM,EAAE,MAAM,CAAC,OAAO;gBAAtB,MAAM,EAAE,MAAM,CAAC,OAAO,EACtC,QAAQ,CAAC,EAAE,gBAAgB;IAKnB,CAAC,aAAa,CAAC;CAGxB;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,aAAa;gBAChC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB;IAI/C,CAAC,aAAa,CAAC;CAGxB"}

package/lib/common/application.js

@@ -1,5 +1,5 @@
 import { ExitCode } from '../codes/wellknown-exit-codes.js';
-import { ErrorWithCode } from './base.js';
+import { ErrorWithCode, humanReadable } from './base.js';
 /**
  * 程序因为正常运行结束而退出
  * catch到此错误时应直接重新抛出，不应做其他处理
@@ -19,6 +19,9 @@ export class InterruptError extends ErrorWithCode {
         super(`interrupt by signal ${signal}`, ExitCode.INTERRUPT, boundary);
         this.signal = signal;
     }
+    [humanReadable]() {
+        return `程序被信号 ${this.signal} 异常中断`;
+    }
 }
 /**
  * 由于错误的参数、配置导致错误
@@ -27,5 +30,8 @@ export class UsageError extends ErrorWithCode {
     constructor(message, boundary) {
         super(message, ExitCode.USAGE, boundary);
     }
+    [humanReadable]() {
+        return `参数错误: ${this.message}\n  - 此为非程序性错误，使用 --help 查看帮助`;
+    }
 }
 //# sourceMappingURL=application.js.map

package/lib/common/application.js.map

@@ -1 +1 @@
-{"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,MAAM,WAAW,CAAC;AAE1C;;;GAGG;AACH,MAAM,OAAO,IAAK,SAAQ,aAAa;IACtC,YAAY,IAAY,EAAE,QAA2B;QACpD,KAAK,CAAC,0BAA0B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,aAAa;IAE/B;IADjB,YACiB,MAAsB,EACtC,QAA2B;QAE3B,KAAK,CAAC,uBAAuB,MAAM,EAAE,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAHrD,WAAM,GAAN,MAAM,CAAgB;IAIvC,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,aAAa;IAC5C,YAAY,OAAe,EAAE,QAA2B;QACvD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACD"}
+{"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,EAAE,MAAM,WAAW,CAAC;AAEzD;;;GAGG;AACH,MAAM,OAAO,IAAK,SAAQ,aAAa;IACtC,YAAY,IAAY,EAAE,QAA2B;QACpD,KAAK,CAAC,0BAA0B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,aAAa;IAE/B;IADjB,YACiB,MAAsB,EACtC,QAA2B;QAE3B,KAAK,CAAC,uBAAuB,MAAM,EAAE,EAAE,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAHrD,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,QAA2B;QACvD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAEQ,CAAC,aAAa,CAAC;QACvB,OAAO,SAAS,IAAI,CAAC,OAAO,+BAA+B,CAAC;IAC7D,CAAC;CACD"}

package/lib/common/base.d.ts

@@ -1,30 +1,42 @@
-export declare class NotError extends Error {
+export declare const humanReadable: unique symbol;
+export interface IHumanReadable {
+    [humanReadable](): string;
+}
+export declare function isHumanReadableError(error: unknown): error is IHumanReadable;
+export declare class NotError extends Error implements IHumanReadable {
     constructor(extra_message?: string);
     get stack(): string;
+    [humanReadable](): string;
 }
 /**
  * 应用程序退出
  * 此错误通常不需要输出到日志
  * @abstract
  */
-export declare class ErrorWithCode extends Error {
+export declare class ErrorWithCode extends Error implements IHumanReadable {
     readonly code: number;
     constructor(message: string, code: number, boundary?: CallableFunction);
+    [humanReadable](): string;
 }
 /**
  * Error when something.cancel() is called
  * @public
  */
-export declare class CanceledError extends Error {
+export declare class CanceledError extends Error implements IHumanReadable {
     constructor();
     static is(e: unknown): e is CanceledError;
+    [humanReadable](): string;
 }
 /**
  * Error when something timeout
  * @public
  */
-export declare class TimeoutError extends Error {
-    constructor(ms: number, what?: string);
+export declare class TimeoutError extends Error implements IHumanReadable {
+    private readonly ms;
+    private readonly why;
+    private readonly what?;
+    constructor(ms: number, why?: string, what?: string | undefined);
     static is(error: unknown): error is TimeoutError;
+    [humanReadable](): string;
 }
 //# sourceMappingURL=base.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/common/base.ts"],"names":[],"mappings":"AAIA,qBAAa,QAAS,SAAQ,KAAK;gBACtB,aAAa,GAAE,MAAW;IAGtC,IAAa,KAAK,WAEjB;CACD;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,KAAK;aAGtB,IAAI,EAAE,MAAM;gBAD5B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM,EAC5B,QAAQ,CAAC,EAAE,gBAAgB;CAW5B;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;;IAKvC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,aAAa;CAGzC;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,KAAK;gBAC1B,EAAE,EAAE,MAAM,EAAE,IAAI,SAAgB;IAI5C,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY;CAGhD"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/common/base.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,eAA0B,CAAC;AACrD,MAAM,WAAW,cAAc;IAC9B,CAAC,aAAa,CAAC,IAAI,MAAM,CAAC;CAC1B;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAE5E;AAED,qBAAa,QAAS,SAAQ,KAAM,YAAW,cAAc;gBAChD,aAAa,GAAE,MAAW;IAGtC,IAAa,KAAK,WAEjB;IAED,CAAC,aAAa,CAAC;CAGf;AAED;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,KAAM,YAAW,cAAc;aAGhD,IAAI,EAAE,MAAM;gBAD5B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM,EAC5B,QAAQ,CAAC,EAAE,gBAAgB;IAY5B,CAAC,aAAa,CAAC;CASf;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAM,YAAW,cAAc;;IAKjE,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,aAAa;IAIzC,CAAC,aAAa,CAAC;CAGf;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,KAAM,YAAW,cAAc;IAE/D,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAFL,EAAE,EAAE,MAAM,EACV,GAAG,SAAgB,EACnB,IAAI,CAAC,EAAE,MAAM,YAAA;IAK/B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY;IAIhD,CAAC,aAAa,CAAC;CAGf"}

package/lib/common/base.js

@@ -1,5 +1,9 @@
 function noop() { }
 const replaceStackTrace = Error.captureStackTrace ?? noop;
+export const humanReadable = Symbol('humanReadable');
+export function isHumanReadableError(error) {
+    return error instanceof Object && humanReadable in error;
+}
 export class NotError extends Error {
     constructor(extra_message = '') {
         super(`你不应该看到此消息: ${extra_message}`);
@@ -7,6 +11,9 @@ export class NotError extends Error {
     get stack() {
         return this.message;
     }
+    [humanReadable]() {
+        return '你不应该看到此消息。你无需尝试处理该错误，请联系开发者。';
+    }
 }
 /**
  * 应用程序退出
@@ -24,6 +31,16 @@ export class ErrorWithCode extends Error {
         this.name = this.constructor.name;
         replaceStackTrace(this, boundary ?? this.constructor);
     }
+    [humanReadable]() {
+        let msg;
+        if (this.code === 0) {
+            msg = '程序正常结束';
+        }
+        else {
+            msg = `程序以非0状态正常结束，状态码：${this.code}`;
+        }
+        return `${msg}\n  - 但是你不应该看到此信息，开发者忘记处理此种情况`;
+    }
 }
 /**
  * Error when something.cancel() is called
@@ -36,17 +53,29 @@ export class CanceledError extends Error {
     static is(e) {
         return e instanceof CanceledError;
     }
+    [humanReadable]() {
+        return '操作已应用户要求而取消';
+    }
 }
 /**
  * Error when something timeout
  * @public
  */
 export class TimeoutError extends Error {
-    constructor(ms, what = 'no response') {
-        super(`Timeout: ${what} in ${ms}ms`);
+    ms;
+    why;
+    what;
+    constructor(ms, why = 'no response', what) {
+        super(`Timeout: ${why} in ${ms}ms${what ? ` (when ${what})` : ''}`);
+        this.ms = ms;
+        this.why = why;
+        this.what = what;
     }
     static is(error) {
         return error instanceof TimeoutError;
     }
+    [humanReadable]() {
+        return `操作超时: ${this.what ? this.what : '操作没有说明'}\n  - 时长: ${this.ms}ms\n  - 原因: ${this.why}`;
+    }
 }
 //# sourceMappingURL=base.js.map

package/lib/common/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/common/base.ts"],"names":[],"mappings":"AAAA,SAAS,IAAI,KAAI,CAAC;AAElB,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC;AAE1D,MAAM,OAAO,QAAS,SAAQ,KAAK;IAClC,YAAY,gBAAwB,EAAE;QACrC,KAAK,CAAC,cAAc,aAAa,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,IAAa,KAAK;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAGtB;IAFjB,YACC,OAAe,EACC,IAAY,EAC5B,QAA2B;QAE3B,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAClC,KAAK,CAAC,eAAe,GAAG,CAAC,CAAC;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;QALC,SAAI,GAAJ,IAAI,CAAQ;QAM5B,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;QAExC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAElC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACvC;QACC,KAAK,CAAC,UAAU,CAAC,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,EAAE,CAAC,CAAU;QACnB,OAAO,CAAC,YAAY,aAAa,CAAC;IACnC,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACtC,YAAY,EAAU,EAAE,IAAI,GAAG,aAAa;QAC3C,KAAK,CAAC,YAAY,IAAI,OAAO,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,EAAE,CAAC,KAAc;QACvB,OAAO,KAAK,YAAY,YAAY,CAAC;IACtC,CAAC;CACD"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/common/base.ts"],"names":[],"mappings":"AAAA,SAAS,IAAI,KAAI,CAAC;AAElB,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC;AAE1D,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;AAKrD,MAAM,UAAU,oBAAoB,CAAC,KAAc;IAClD,OAAO,KAAK,YAAY,MAAM,IAAI,aAAa,IAAI,KAAK,CAAC;AAC1D,CAAC;AAED,MAAM,OAAO,QAAS,SAAQ,KAAK;IAClC,YAAY,gBAAwB,EAAE;QACrC,KAAK,CAAC,cAAc,aAAa,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,IAAa,KAAK;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,CAAC,aAAa,CAAC;QACd,OAAO,8BAA8B,CAAC;IACvC,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAGtB;IAFjB,YACC,OAAe,EACC,IAAY,EAC5B,QAA2B;QAE3B,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;QAClC,KAAK,CAAC,eAAe,GAAG,CAAC,CAAC;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;QALC,SAAI,GAAJ,IAAI,CAAQ;QAM5B,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;QAExC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAElC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;IACvD,CAAC;IAED,CAAC,aAAa,CAAC;QACd,IAAI,GAAW,CAAC;QAChB,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACrB,GAAG,GAAG,QAAQ,CAAC;QAChB,CAAC;aAAM,CAAC;YACP,GAAG,GAAG,mBAAmB,IAAI,CAAC,IAAI,EAAE,CAAC;QACtC,CAAC;QACD,OAAO,GAAG,GAAG,+BAA+B,CAAC;IAC9C,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACvC;QACC,KAAK,CAAC,UAAU,CAAC,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,EAAE,CAAC,CAAU;QACnB,OAAO,CAAC,YAAY,aAAa,CAAC;IACnC,CAAC;IAED,CAAC,aAAa,CAAC;QACd,OAAO,aAAa,CAAC;IACtB,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IAEpB;IACA;IACA;IAHlB,YACkB,EAAU,EACV,MAAM,aAAa,EACnB,IAAa;QAE9B,KAAK,CAAC,YAAY,GAAG,OAAO,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAJnD,OAAE,GAAF,EAAE,CAAQ;QACV,QAAG,GAAH,GAAG,CAAgB;QACnB,SAAI,GAAJ,IAAI,CAAS;IAG/B,CAAC;IAED,MAAM,CAAC,EAAE,CAAC,KAAc;QACvB,OAAO,KAAK,YAAY,YAAY,CAAC;IACtC,CAAC;IAED,CAAC,aAAa,CAAC;QACd,OAAO,SAAS,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,aAAa,IAAI,CAAC,EAAE,eAAe,IAAI,CAAC,GAAG,EAAE,CAAC;IAC/F,CAAC;CACD"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@idlebox/errors",
   "description": "A collection of my errors.",
   "type": "module",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "exports": {
     ".": {
       "source": "./src/autoindex.ts",
@@ -12,11 +12,11 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@idlebox/node-error-codes": "^0.1.11"
+    "@idlebox/node-error-codes": "^0.1.13"
   },
   "devDependencies": {
-    "@build-script/single-dog-asset": "latest",
-    "@mpis/run": "^0.0.17"
+    "@mpis/run": "^0.0.17",
+    "@build-script/baseline-rig": "latest"
   },
   "license": "MIT",
   "author": "GongT <admin@gongt.me>",

package/src/autoindex.ts

@@ -29,6 +29,9 @@
 	export { UsageError } from "./common/application.js";
 /* common/base.ts */
 	// Identifiers
+	export { humanReadable } from "./common/base.js";
+	export type { IHumanReadable } from "./common/base.js";
+	export { isHumanReadableError } from "./common/base.js";
 	export { NotError } from "./common/base.js";
 	export { ErrorWithCode } from "./common/base.js";
 	export { CanceledError } from "./common/base.js";

package/src/common/application.ts

@@ -1,5 +1,5 @@
 import { ExitCode } from '../codes/wellknown-exit-codes.js';
-import { ErrorWithCode } from './base.js';
+import { ErrorWithCode, humanReadable } from './base.js';
 
 /**
  * 程序因为正常运行结束而退出
@@ -22,6 +22,10 @@ export class InterruptError extends ErrorWithCode {
 	) {
 		super(`interrupt by signal ${signal}`, ExitCode.INTERRUPT, boundary);
 	}
+
+	override [humanReadable]() {
+		return `程序被信号 ${this.signal} 异常中断`;
+	}
 }
 
 /**
@@ -31,4 +35,8 @@ export class UsageError extends ErrorWithCode {
 	constructor(message: string, boundary?: CallableFunction) {
 		super(message, ExitCode.USAGE, boundary);
 	}
+
+	override [humanReadable]() {
+		return `参数错误: ${this.message}\n  - 此为非程序性错误，使用 --help 查看帮助`;
+	}
 }

package/src/common/base.ts

@@ -2,13 +2,26 @@ function noop() {}
 
 const replaceStackTrace = Error.captureStackTrace ?? noop;
 
-export class NotError extends Error {
+export const humanReadable = Symbol('humanReadable');
+export interface IHumanReadable {
+	[humanReadable](): string;
+}
+
+export function isHumanReadableError(error: unknown): error is IHumanReadable {
+	return error instanceof Object && humanReadable in error;
+}
+
+export class NotError extends Error implements IHumanReadable {
 	constructor(extra_message: string = '') {
 		super(`你不应该看到此消息: ${extra_message}`);
 	}
 	override get stack() {
 		return this.message;
 	}
+
+	[humanReadable]() {
+		return '你不应该看到此消息。你无需尝试处理该错误，请联系开发者。';
+	}
 }
 
 /**
@@ -16,7 +29,7 @@ export class NotError extends Error {
  * 此错误通常不需要输出到日志
  * @abstract
  */
-export class ErrorWithCode extends Error {
+export class ErrorWithCode extends Error implements IHumanReadable {
 	constructor(
 		message: string,
 		public readonly code: number,
@@ -31,13 +44,23 @@ export class ErrorWithCode extends Error {
 
 		replaceStackTrace(this, boundary ?? this.constructor);
 	}
+
+	[humanReadable]() {
+		let msg: string;
+		if (this.code === 0) {
+			msg = '程序正常结束';
+		} else {
+			msg = `程序以非0状态正常结束，状态码：${this.code}`;
+		}
+		return `${msg}\n  - 但是你不应该看到此信息，开发者忘记处理此种情况`;
+	}
 }
 
 /**
  * Error when something.cancel() is called
  * @public
  */
-export class CanceledError extends Error {
+export class CanceledError extends Error implements IHumanReadable {
 	constructor() {
 		super('Canceled');
 	}
@@ -45,18 +68,30 @@ export class CanceledError extends Error {
 	static is(e: unknown): e is CanceledError {
 		return e instanceof CanceledError;
 	}
+
+	[humanReadable]() {
+		return '操作已应用户要求而取消';
+	}
 }
 
 /**
  * Error when something timeout
  * @public
  */
-export class TimeoutError extends Error {
-	constructor(ms: number, what = 'no response') {
-		super(`Timeout: ${what} in ${ms}ms`);
+export class TimeoutError extends Error implements IHumanReadable {
+	constructor(
+		private readonly ms: number,
+		private readonly why = 'no response',
+		private readonly what?: string,
+	) {
+		super(`Timeout: ${why} in ${ms}ms${what ? ` (when ${what})` : ''}`);
 	}
 
 	static is(error: unknown): error is TimeoutError {
 		return error instanceof TimeoutError;
 	}
+
+	[humanReadable]() {
+		return `操作超时: ${this.what ? this.what : '操作没有说明'}\n  - 时长: ${this.ms}ms\n  - 原因: ${this.why}`;
+	}
 }

package/src/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "@build-script/single-dog-asset/package/tsconfig.json",
+	"extends": "@build-script/baseline-rig/package/tsconfig.json",
 	"compilerOptions": {
 		"typeRoots": ["../node_modules/@types", "../node_modules"],
 		"outDir": "../lib",