effect-errors 1.2.0 → 1.2.2

package/README.md

@@ -41,9 +41,15 @@ import { prettyPrint } from 'effect-errors';
 Signature is the following:
 
 ```typescript
-const prettyPrint: <E>(cause: Cause<E>) => string;
+const prettyPrint: <E>(cause: Cause<E>, options?: PrettyPrintOptions) => string;
 ```
 
+`PrettyPrintOptions` allows you to tweak the following:
+
+#### `stripCwd` - Whether spans and stacktrace should contain absolute or relative paths
+
+> default: `false` (absolute paths)
+
 ## ⚡ How should I raise errors?
 
 The best way is to use either `SchemaError` or `TaggedError`.
@@ -97,7 +103,7 @@ Effect.fail(new UserNotFoundError({ cause: "User does not exist" }));
 
 ### 🔶 Plain object
 
-Alternativly, you _can_ use a plain object with a `_tag` and `message` attribute:
+Alternatively, you _can_ use a plain object with a `_tag` and `message` attribute, but you won't get any stacktrace if you use this method:
 
 ```typescript
 Effect.fail({ _tag: 'SucksToBeMe', message: 'Yeah...' });

package/index.d.ts

@@ -1,3 +1,4 @@
 export * from './pretty-print';
 export * from './runners/run-promise';
 export * from './runners/run-sync';
+export * from './types/pretty-print-options.type';

package/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./pretty-print"), exports);
 __exportStar(require("./runners/run-promise"), exports);
 __exportStar(require("./runners/run-sync"), exports);
+__exportStar(require("./types/pretty-print-options.type"), exports);

package/logic/errors/capture-errors-from-cause.d.ts

@@ -0,0 +1,3 @@
+import { Cause } from 'effect/Cause';
+import { PrettyError } from '../../types/pretty-error.type';
+export declare const captureErrorsFrom: <E>(cause: Cause<E>) => readonly PrettyError[];

package/logic/{pretty-errors.js → errors/capture-errors-from-cause.js}

@@ -25,17 +25,17 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prettyErrors = void 0;
+exports.captureErrorsFrom = void 0;
 var Cause_1 = require("effect/Cause");
-var default_render_error_1 = require("./default-render-error");
-var prettyErrors = function (cause) {
+var parse_error_1 = require("./parse-error");
+var captureErrorsFrom = function (cause) {
     return (0, Cause_1.reduceWithContext)(cause, void 0, {
         emptyCase: function () { return []; },
-        dieCase: function (_, unknownError) { return [(0, default_render_error_1.defaultRenderError)(unknownError)]; },
-        failCase: function (_, error) { return [(0, default_render_error_1.defaultRenderError)(error)]; },
+        dieCase: function (_, unknownError) { return [(0, parse_error_1.parseError)(unknownError)]; },
+        failCase: function (_, error) { return [(0, parse_error_1.parseError)(error)]; },
         interruptCase: function () { return []; },
         parallelCase: function (_, l, r) { return __spreadArray(__spreadArray([], __read(l), false), __read(r), false); },
         sequentialCase: function (_, l, r) { return __spreadArray(__spreadArray([], __read(l), false), __read(r), false); },
     });
 };
-exports.prettyErrors = prettyErrors;
+exports.captureErrorsFrom = captureErrorsFrom;

package/logic/errors/parse-error.d.ts

@@ -0,0 +1,2 @@
+import { PrettyError } from '../../types/pretty-error.type';
+export declare const parseError: (error: unknown) => PrettyError;

package/logic/{default-render-error.js → errors/parse-error.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultRenderError = void 0;
+exports.parseError = void 0;
 var Predicate_1 = require("effect/Predicate");
-var pretty_error_type_1 = require("../types/pretty-error.type");
+var pretty_error_type_1 = require("../../types/pretty-error.type");
 var pretty_error_message_1 = require("./pretty-error-message");
 var spanSymbol = Symbol.for('effect/SpanAnnotation');
-var defaultRenderError = function (error) {
+var parseError = function (error) {
     var _a;
     var span = ((0, Predicate_1.hasProperty)(error, spanSymbol) && error[spanSymbol]);
     if (error instanceof Error) {
@@ -13,4 +13,4 @@ var defaultRenderError = function (error) {
     }
     return new pretty_error_type_1.PrettyError((0, pretty_error_message_1.prettyErrorMessage)(error), void 0, span);
 };
-exports.defaultRenderError = defaultRenderError;
+exports.parseError = parseError;

package/logic/{pretty-error-message.js → errors/pretty-error-message.js}

@@ -39,6 +39,7 @@ var prettyErrorMessage = function (u) {
     if ((0, Predicate_1.hasProperty)(u, '_tag') && (0, Predicate_1.hasProperty)(u, 'message')) {
         return "".concat(chalk_1.default.bgRed(" ".concat(u._tag, " ")), " ").concat(chalk_1.default.bold.whiteBright("\u2022 ".concat(u.message)), "\r\n");
     }
+    // Plain objects with toString impl
     if ((0, Predicate_1.hasProperty)(u, 'toString') &&
         (0, Function_1.isFunction)(u['toString']) &&
         u['toString'] !== Object.prototype.toString &&

package/logic/{get-span-attributes.js → spans/get-span-attributes.js}

@@ -25,11 +25,12 @@ var getSpanAttributes = function (attributes, isLastEntry) {
     if (attributes.size === 0) {
         return '';
     }
-    return "".concat("\r\n".concat(Array.from(attributes.entries())
+    var formattedAttributes = Array.from(attributes.entries())
         .map(function (_a) {
         var _b = __read(_a, 2), key = _b[0], value = _b[1];
         return "".concat(isLastEntry ? ' ' : chalk_1.default.gray('│'), "     ").concat(chalk_1.default.blue(key)).concat(chalk_1.default.gray(':'), " ").concat(value);
     })
-        .join('\r\n')));
+        .join('\r\n');
+    return "".concat("\r\n".concat(formattedAttributes));
 };
 exports.getSpanAttributes = getSpanAttributes;

package/logic/stack/filter-stack.d.ts

@@ -0,0 +1 @@
+export declare const filterStack: (stack: string, stripCwd: boolean) => string;

package/logic/{filter-stack.js → stack/filter-stack.js}

@@ -12,7 +12,8 @@ var __values = (this && this.__values) || function(o) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.filterStack = void 0;
-var filterStack = function (stack) {
+var strip_cwd_path_1 = require("../strip-cwd-path");
+var filterStack = function (stack, stripCwd) {
     var e_1, _a;
     var lines = stack.split('\n');
     var out = [];
@@ -32,6 +33,7 @@ var filterStack = function (stack) {
         }
         finally { if (e_1) throw e_1.error; }
     }
-    return out.join('\n');
+    var final = out.join('\n').replace(/ {4}at /g, '🭳 at ');
+    return stripCwd ? (0, strip_cwd_path_1.stripCwdPath)(final) : final;
 };
 exports.filterStack = filterStack;

package/logic/strip-cwd-path.d.ts

@@ -0,0 +1 @@
+export declare const stripCwdPath: (path: string) => string;

package/logic/strip-cwd-path.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripCwdPath = void 0;
+var cwdRegex = new RegExp(process.cwd(), 'g');
+var stripCwdPath = function (path) { return path.replace(cwdRegex, '.'); };
+exports.stripCwdPath = stripCwdPath;

package/package.json

@@ -2,7 +2,7 @@
   "repository": "https://github.com/jpb06/effect-errors.git",
   "main": "dist/index.js",
   "name": "effect-errors",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "author": "jpb06 <jp.bois.06@outlook.fr>",
   "description": "A POC for errors reporting in Effect",
   "keywords": [],

package/pretty-print.d.ts

@@ -1,2 +1,3 @@
 import { Cause } from 'effect/Cause';
-export declare const prettyPrint: <E>(cause: Cause<E>) => string;
+import { PrettyPrintOptions } from './types/pretty-print-options.type';
+export declare const prettyPrint: <E>(cause: Cause<E>, { stripCwd }?: PrettyPrintOptions) => string;

package/pretty-print.js

@@ -7,16 +7,19 @@ exports.prettyPrint = void 0;
 var chalk_1 = __importDefault(require("chalk"));
 var effect_1 = require("effect");
 var Cause_1 = require("effect/Cause");
-var filter_stack_1 = require("./logic/filter-stack");
-var get_span_attributes_1 = require("./logic/get-span-attributes");
-var get_span_duration_1 = require("./logic/get-span-duration");
-var pretty_errors_1 = require("./logic/pretty-errors");
-var spans_stack_trailing_char_1 = require("./logic/spans-stack-trailing-char");
-var prettyPrint = function (cause) {
+var capture_errors_from_cause_1 = require("./logic/errors/capture-errors-from-cause");
+var get_span_attributes_1 = require("./logic/spans/get-span-attributes");
+var get_span_duration_1 = require("./logic/spans/get-span-duration");
+var spans_stack_trailing_char_1 = require("./logic/spans/spans-stack-trailing-char");
+var filter_stack_1 = require("./logic/stack/filter-stack");
+var strip_cwd_path_1 = require("./logic/strip-cwd-path");
+var pretty_print_options_type_1 = require("./types/pretty-print-options.type");
+var prettyPrint = function (cause, _a) {
+    var _b = _a === void 0 ? pretty_print_options_type_1.prettyPrintOptionsDefault : _a, stripCwd = _b.stripCwd;
     if ((0, Cause_1.isInterruptedOnly)(cause)) {
         return 'All fibers interrupted without errors.';
     }
-    var failures = (0, pretty_errors_1.prettyErrors)(cause);
+    var failures = (0, capture_errors_from_cause_1.captureErrorsFrom)(cause);
     console.error("\r\n\uD83E\uDEE0  ".concat(chalk_1.default.bold.yellowBright.underline("".concat(failures.length, " error").concat(failures.length > 1 ? 's' : '', " occurred\n"))));
     return failures
         .map(function (_a, failuresIndex) {
@@ -35,11 +38,12 @@ var prettyPrint = function (cause) {
                         : '') +
                     message +
                     spans_1
+                        .reverse()
                         .map(function (_a, index) {
                         var name = _a.name, attributes = _a.attributes, status = _a.status;
                         var isFirstEntry = index === 0;
                         var isLastEntry = index === spans_1.length - 1;
-                        var filePath = " at ".concat(name.replace(new RegExp(process.cwd()), '.'));
+                        var filePath = " at ".concat(stripCwd ? (0, strip_cwd_path_1.stripCwdPath)(name) : name);
                         return chalk_1.default.whiteBright((isFirstEntry ? "\r\n".concat(chalk_1.default.gray('◯')) : '') +
                             '\r\n' +
                             (0, spans_stack_trailing_char_1.spanStackTrailingChar)(isLastEntry) +
@@ -51,7 +55,7 @@ var prettyPrint = function (cause) {
                         .join('');
         }
         if (stack) {
-            message += "\r\n".concat(span ? '\r\n' : '', "\uD83D\uDEA8 Stacktrace\r\n").concat(chalk_1.default.red((0, filter_stack_1.filterStack)(stack).replace(/ {4}at /g, '🭳 at ')));
+            message += "\r\n".concat(span ? '\r\n' : '', "\uD83D\uDEA8 Stacktrace\r\n").concat(chalk_1.default.red((0, filter_stack_1.filterStack)(stack, stripCwd)));
         }
         return message + '\r\n';
     })

package/runners/run-promise.d.ts

@@ -1,2 +1,3 @@
 import { Effect } from 'effect';
-export declare const runPromise: <A, E>(effect: Effect.Effect<A, E>) => Promise<A>;
+import { PrettyPrintOptions } from '../types/pretty-print-options.type';
+export declare const runPromise: <A, E>(effect: Effect.Effect<A, E>, options?: PrettyPrintOptions) => Promise<A>;

package/runners/run-promise.js

@@ -4,10 +4,12 @@ exports.runPromise = void 0;
 var effect_1 = require("effect");
 var __1 = require("..");
 var pretty_print_enabled_1 = require("../config/pretty-print-enabled");
-var runPromise = function (effect) {
+var pretty_print_options_type_1 = require("../types/pretty-print-options.type");
+var runPromise = function (effect, options) {
+    if (options === void 0) { options = pretty_print_options_type_1.prettyPrintOptionsDefault; }
     return effect_1.Effect.runPromise((0, effect_1.pipe)(effect, effect_1.Effect.sandbox, effect_1.Effect.catchAll(function (e) {
         if (pretty_print_enabled_1.prettyPrintEnabled) {
-            console.error((0, __1.prettyPrint)(e));
+            console.error((0, __1.prettyPrint)(e, options));
             return effect_1.Effect.fail('❌ runPromise failure');
         }
         return effect_1.Effect.fail(e);

package/runners/run-sync.d.ts

@@ -1,2 +1,3 @@
 import { Effect } from 'effect';
-export declare const runSync: <A, E>(effect: Effect.Effect<A, E>) => A;
+import { PrettyPrintOptions } from '../types/pretty-print-options.type';
+export declare const runSync: <A, E>(effect: Effect.Effect<A, E>, options?: PrettyPrintOptions) => A;

package/runners/run-sync.js

@@ -4,10 +4,12 @@ exports.runSync = void 0;
 var effect_1 = require("effect");
 var __1 = require("..");
 var pretty_print_enabled_1 = require("../config/pretty-print-enabled");
-var runSync = function (effect) {
+var pretty_print_options_type_1 = require("../types/pretty-print-options.type");
+var runSync = function (effect, options) {
+    if (options === void 0) { options = pretty_print_options_type_1.prettyPrintOptionsDefault; }
     return effect_1.Effect.runSync((0, effect_1.pipe)(effect, effect_1.Effect.sandbox, effect_1.Effect.catchAll(function (e) {
         if (pretty_print_enabled_1.prettyPrintEnabled) {
-            console.error((0, __1.prettyPrint)(e));
+            console.error((0, __1.prettyPrint)(e, options));
             return effect_1.Effect.fail('❌ runSync failure');
         }
         return effect_1.Effect.fail(e);

package/types/pretty-print-options.type.d.ts

@@ -0,0 +1,4 @@
+export interface PrettyPrintOptions {
+    stripCwd: boolean;
+}
+export declare const prettyPrintOptionsDefault: PrettyPrintOptions;

package/types/pretty-print-options.type.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettyPrintOptionsDefault = void 0;
+exports.prettyPrintOptionsDefault = {
+    stripCwd: false,
+};

package/logic/default-render-error.d.ts

@@ -1,2 +0,0 @@
-import { PrettyError } from '../types/pretty-error.type';
-export declare const defaultRenderError: (error: unknown) => PrettyError;

package/logic/filter-stack.d.ts

@@ -1 +0,0 @@
-export declare const filterStack: (stack: string) => string;

package/logic/pretty-errors.d.ts

@@ -1,3 +0,0 @@
-import { Cause } from 'effect/Cause';
-import { PrettyError } from '../types/pretty-error.type';
-export declare const prettyErrors: <E>(cause: Cause<E>) => readonly PrettyError[];