effect-errors 1.0.8 → 1.1.0

package/README.md

@@ -44,6 +44,65 @@ Signature is the following:
 const prettyPrint: <E>(cause: Cause<E>) => string;
 ```
 
+## ⚡ How should I raise errors?
+
+The best way is to use either `SchemaError` or `TaggedError`.
+
+### 🔶 `SchemaError`
+
+Declaring the error could look like this:
+
+```typescript
+import * as Schema from '@effect/schema/Schema';
+
+export class FileNotFoundError extends Schema.TaggedError<SchemaError>()(
+  'FileNotFound',
+  {
+    cause: Schema.optional(Schema.unknown),
+  },
+) {}
+```
+
+You would then raise a `FileNotFoundError` to the error channel like this:
+
+```typescript
+Effect.tryPromise({
+  try: () => ...,
+  catch: (e) => new FileNotFoundError({ cause: e }),
+});
+
+// or raising directly
+Effect.fail(new FileNotFoundError({ cause: "Oh no!" }));
+```
+
+### 🔶 `TaggedError`
+
+```typescript
+export class UserNotFoundError extends TaggedError('UserNotFound')<{
+  cause?: unknown;
+}> {}
+```
+
+You would then raise a `UserNotFoundError` to the error channel like this:
+
+```typescript
+Effect.tryPromise({
+  try: () => ...,
+  catch: (e) => new UserNotFoundError({ cause: e }),
+});
+
+// or raising directly
+Effect.fail(new UserNotFoundError({ cause: "User does not exist" }));
+```
+
+### 🔶 Plain object
+
+Alternativly, you _can_ use a plain object with a `_tag` and `message` attribute:
+
+```typescript
+Effect.fail({ _tag: 'SucksToBeMe', message: 'Yeah...' });
+```
+
 ## ⚡ examples
 
 I wrote some examples for fun and giggles. You can run them using:

package/logic/pretty-error-message.js

@@ -23,18 +23,21 @@ exports.prettyErrorMessage = void 0;
 var chalk_1 = __importDefault(require("chalk"));
 var Function_1 = require("effect/Function");
 var Predicate_1 = require("effect/Predicate");
-var cwdRegex = new RegExp("".concat(process.cwd()), 'g');
 var prettyErrorMessage = function (u) {
     if (typeof u === 'string') {
-        return "\uD83D\uDCA5 ".concat(u);
+        return "\uD83D\uDCA5 ".concat(u, "\r\n\r\n\u2139\uFE0F ").concat(chalk_1.default.gray('You used a plain string to represent a failure in the error channel (E). You should consider using tagged objects (with the _tag) field, or yieldable errors such as Data.TaggedError and Schema.TaggedError for better handling experience.'));
+    }
+    // TaggedError with cause
+    if (u instanceof Error && (0, Predicate_1.hasProperty)(u, 'cause') && (0, Predicate_1.hasProperty)(u, '_tag')) {
+        return "\uD83D\uDCA5 ".concat(chalk_1.default.bgRed(" ".concat(u._tag, " ")), " ").concat(chalk_1.default.bold.whiteBright("\u2022 ".concat(u.cause)), "\r\n");
     }
     // TaggedError with error ctor
     if (u instanceof Error && (0, Predicate_1.hasProperty)(u, 'error')) {
         return "\uD83D\uDCA5 ".concat(chalk_1.default.bgRed(" ".concat(u.name, " ")), " ").concat(chalk_1.default.bold.whiteBright("\u2022 ".concat(u.error)), "\r\n");
     }
-    // TaggedError with cause
-    if (u instanceof Error && (0, Predicate_1.hasProperty)(u, 'cause')) {
-        return "\uD83D\uDCA5 ".concat(chalk_1.default.bgRed(" ".concat(u.name, " ")), " ").concat(chalk_1.default.bold.whiteBright("\u2022 ".concat(u.cause)), "\r\n");
+    // Plain objects with tag attribute
+    if ((0, Predicate_1.hasProperty)(u, '_tag') && (0, Predicate_1.hasProperty)(u, 'message')) {
+        return "\uD83D\uDCA5 ".concat(chalk_1.default.bgRed(" ".concat(u._tag, " ")), " ").concat(chalk_1.default.bold.whiteBright("\u2022 ".concat(u.message)), "\r\n");
     }
     if ((0, Predicate_1.hasProperty)(u, 'toString') &&
         (0, Function_1.isFunction)(u['toString']) &&
@@ -48,14 +51,6 @@ var prettyErrorMessage = function (u) {
         }
         return "\uD83D\uDCA5 ".concat(message);
     }
-    if ((0, Predicate_1.hasProperty)(u, '_tag') && (0, Predicate_1.hasProperty)(u, 'message')) {
-        var message = u.message
-            ? chalk_1.default
-                .hex('#c25c30')(u.message)
-                .replace(cwdRegex, '.')
-            : undefined;
-        return "\uD83D\uDCA5 ".concat(chalk_1.default.bgRed(" ".concat(u._tag, " ")), " ").concat(message ? chalk_1.default.bold.whiteBright("\u2022 ".concat(message)) : '', "\r\n");
-    }
     return "Error: ".concat(JSON.stringify(u));
 };
 exports.prettyErrorMessage = prettyErrorMessage;

package/package.json

@@ -2,7 +2,7 @@
   "repository": "https://github.com/jpb06/effect-errors.git",
   "main": "dist/index.js",
   "name": "effect-errors",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "author": "jpb06 <jp.bois.06@outlook.fr>",
   "description": "A POC for errors reporting in Effect",
   "keywords": [],
@@ -31,7 +31,7 @@
     "@stylistic/eslint-plugin": "^1.6.3",
     "@types/eslint": "^8.56.5",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.24",
+    "@types/node": "^20.11.25",
     "@typescript-eslint/eslint-plugin": "^7.1.1",
     "@typescript-eslint/parser": "^7.1.1",
     "copyfiles": "^2.4.1",
@@ -45,6 +45,6 @@
     "fs-extra": "^11.2.0",
     "prettier": "^3.2.5",
     "readme-package-icons": "^1.1.14",
-    "typescript": "^5.0.0"
+    "typescript": "^5.4.2"
   }
 }

package/runners/run-promise.d.ts

@@ -1,2 +1,2 @@
 import { Effect } from 'effect';
-export declare const runPromise: <A, E>(effect: Effect.Effect<A, E, never>) => Promise<A>;
+export declare const runPromise: <A, E>(effect: Effect.Effect<A, E>) => Promise<A>;

package/runners/run-sync.d.ts

@@ -1,2 +1,2 @@
 import { Effect } from 'effect';
-export declare const runSync: <A, E>(effect: Effect.Effect<A, E, never>) => A;
+export declare const runSync: <A, E>(effect: Effect.Effect<A, E>) => A;