feat(packages): ✨ Add snippets related to Error (#26)

Author: xeho91

.changeset/young-turtles-kick.md

@@ -0,0 +1,11 @@
+---
+"@terminal-nerds/snippets-error": minor
+---
+
+✨ Added a new package module group `custom` with the following snippets:
+
+-   `isError()`
+-   `RuntimeError`
+-   `isRuntimeError()`
+-   `ValidationError` - powered by [`zod` and `ZodError`](https://github.com/colinhacks/zod)
+-   `isValidationError()`

README.md

@@ -100,6 +100,7 @@ Reusable pieces of code, which can be **reused** across the projects.
 | ----------------------------- | ---------------------------------------------- |
 | [![snippets badge]][snippets] | [![snippets version badge]][snippets npm page] |
 | <!-- PACKAGES -->             | <!-- PACKAGES -->                              |
+| [![error badge]][error]       | [![error version badge]][error npm page]       |
 | [![function badge]][function] | [![function version badge]][function npm page] |
 | [![test badge]][test]         | [![test version badge]][test npm page]         |
 | [![regexp badge]][regexp]     | [![regexp version badge]][regexp npm page]     |
@@ -112,6 +113,11 @@ Reusable pieces of code, which can be **reused** across the projects.
 
 <!-- prettier-ignore-start -->
 <!-- PACKAGES LINKS -->
+[error]: ./packages/error/README.md
+[error badge]: https://img.shields.io/static/v1?label=%40terminal-nerds&message=snippets-error&style=flat-square&color=informational
+[error version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-error/latest?style=flat-square&logo=npm
+[error npm page]: https://www.npmjs.com/package/@terminal-nerds/snippets-error
+
 [function]: ./packages/function/README.md
 [function badge]: https://img.shields.io/static/v1?label=%40terminal-nerds&message=snippets-function&style=flat-square&color=informational
 [function version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-function/latest?style=flat-square&logo=npm

packages/error/.depcheckrc.json

@@ -0,0 +1,3 @@
+{
+	"ignores": ["@terminal-nerds/*-config", "tsup", "vitest"]
+}

packages/error/CHANGELOG.md

@@ -0,0 +1 @@
+# @terminal-nerds/snippets-error<!-- markdownlint-disable line-length list-marker-space no-duplicate-header ul-style ul-indent no-bare-urls -->

packages/error/LICENSE.md

@@ -0,0 +1 @@
+/home/xeho91/Nextcloud/Projects/terminal-nerds/snippets/LICENSE.md

packages/error/README.md

@@ -0,0 +1,186 @@
+# @terminal-nerds/snippets-error
+
+![package version badge]
+[![size badge]][size url]
+[![dependencies badge]][dependencies url]
+
+➡️ **This package wraps all available modules with snippets related to [Error]**
+— part of the [terminal-nerds/snippets] project.
+
+[error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
+[terminal-nerds/snippets]: https://github.com/terminal-nerds/snippets
+[package version badge]: https://img.shields.io/npm/v/@terminal-nerds/snippets-error/latest?style=for-the-badge&logo=npm
+[dependencies badge]: https://img.shields.io/librariesio/release/npm/@terminal-nerds/snippets-error?style=for-the-badge
+[dependencies url]: https://libraries.io/npm/@terminal-nerds%2snippets-error
+[size badge]: https://img.shields.io/bundlephobia/minzip/@terminal-nerds/snippets-error?style=for-the-badge&label=size
+[size url]: https://packagephobia.com/result?p=@terminal-nerds/snippets-error
+
+## Modules included
+
+<!-- prettier-sort-markdown-table -->
+
+| Name                                      | Size                                                  |
+| ----------------------------------------- | ----------------------------------------------------- |
+| [`@terminal-nerds/snippets-error/custom`] | ![custom size gzip badge] ![custom size brotli badge] |
+
+<!-- prettier-ignore-start -->
+<!-- MODULES LINKS -->
+[`@terminal-nerds/snippets-error/custom`]: https://github.com/terminal-nerds/snippets/blob/main/packages/error/source/custom/custom.ts
+[custom size gzip badge]: https://badgen.net/badgesize/gzip/file-url/unpkg.com/@terminal-nerds/snippets-error/dist/custom/custom.js?label=gzip
+[custom size brotli badge]: https://badgen.net/badgesize/brotli/file-url/unpkg.com/@terminal-nerds/snippets-error/dist/custom/custom.js?label=brotli
+
+<!-- prettier-ignore-end -->
+
+---
+
+## Prerequisites & usage
+
+### Optional
+
+[![supported typescript version badge]][typescript]
+![types badge]
+
+[typescript]: https://typescriptlang.org/
+[typescript icon]: https://api.iconify.design/logos/typescript-icon.svg
+[supported typescript version badge]: https://img.shields.io/github/package-json/dependency-version/terminal-nerds/snippets/peer/typescript?filename=packages%2Ftypescript%2Fpackage.json&logo=typescript&style=for-the-badge&label=typescript
+[types badge]: https://img.shields.io/npm/types/@terminal-nerds/snippets-error?style=for-the-badge&logo=typescript
+
+If you are using ![typescript icon] [TypeScript],
+the latest version, which supports new features _(such as `satisfies`)_, is supported.
+
+### Runtime environments
+
+This package can be used in several runtime environments.
+We aim for cross-runtime compatibility and ensure proper error messages
+if a particular snippet cannot be run in the currently running environment.
+
+#### Browsers
+
+We use [browserslist] to define the minimum browsers versions supported.\
+Take a look at our [shared browserslist configuration] for more details.
+
+[browserslist]: https://github.com/browserslist/browserslist
+[shared browserslist configuration]: https://github.com/terminal-nerds/configs/blob/main/packages/browserslist/source/browsers.ts
+
+**Usage**:
+
+```html
+<script type="module">
+	import { snippet } from "https://cdn.jsdelivr.net/npm/@terminal-nerds/snippets-error";
+</script>
+```
+
+---
+
+#### Bun
+
+We aim to support the latest version of ![bun icon] [bun].
+
+**Usage**:
+
+Firstly, install it:
+
+```sh
+bun add @terminal-nerds/snippets-error
+```
+
+And then in a particular file:
+
+```js
+import { snippet } from "@terminal-nerds/snippets-error";
+```
+
+[bun]: https://bun.sh/
+[bun icon]: https://api.iconify.design/logos/bun.svg
+
+---
+
+#### Deno
+
+We aim to support the latest version of ![deno icon] [Deno].
+
+**Usage**:
+
+```ts
+import { snippet } from "npm:@terminal-nerds/snippets-error";
+```
+
+[deno]: https://deno.land/
+[deno icon]: https://api.iconify.design/logos/deno.svg
+
+---
+
+#### Node.js
+
+[![node.js version support badge]][node.js]
+
+The latest ![node.js icon] [Node.js] LTS _(Long-Term Support)_ version is the minimum one supported.
+
+> **Warning**\
+> **This package is written in [ES Module] _(ESM)_ type.**\
+> So, if you wish to use it in a project with CommonJS (CJS) type, you need to bundle this package or a particular module(s).
+
+**Usage**:
+
+Install it first with the Node.js package manager of your choice. In our example, we use [pnpm].
+
+```sh
+pnpm add @terminal-nerds/snippets-error
+```
+
+And then in a particular file:
+
+```js
+import { snippet } from "@terminal-nerds/snippets-error";
+```
+
+[ES Module]: https://www.freecodecamp.org/news/javascript-es-modules-and-module-bundlers
+[pnpm]: https://pnpm.io
+[node.js]: https://nodejs.org/en/
+[node.js icon]: https://api.iconify.design/logos/nodejs-icon.svg
+[node.js version support badge]: https://img.shields.io/node/v-lts/@terminal-nerds/snippets?style=for-the-badge&logo=nodedotjs
+
+---
+
+## Security
+
+[![workflow security badge]][security policy]
+
+🔐 For more information, please refer to the [Security section] at the root of
+the [terminal-nerds/snippets] monorepo.
+
+[workflow security badge]: https://img.shields.io/github/actions/workflow/status/terminal-nerds/snippets/maintenance.yml?label=Security&logo=github&style=for-the-badge&branch=main
+[security section]: https://github.com/terminal-nerds/snippets#security
+[security policy]: https://github.com/terminal-nerds/snippets/security/policy
+
+---
+
+## License
+
+[![license badge]][license]
+
+⚖️ For more information, please refer to the [License section] at the root of the [terminal-nerds/snippets] monorepo.
+
+[license]: https://github.com/terminal-nerds/snippets/blob/main/LICENSE.md
+[license badge]: https://img.shields.io/github/license/terminal-nerds/snippets?style=for-the-badge
+[license section]: https://github.com/terminal-nerds/snippets#License
+
+### Contributing
+
+[![contributors badge]][contributors url]
+
+🤝 **Contributions of any kind are welcome!**
+
+Please refer to the monorepo _([terminal-nerds/snippets])_ project's [CONTRIBUTING file] for more information
+if you wish to get involved.
+
+[contributing file]: https://github.com/terminal-nerds/snippets/blob/main/.github/CONTRIBUTING.md
+[contributors badge]: https://img.shields.io/github/contributors/terminal-nerds/snippets?style=for-the-badge
+[contributors url]: https://github.com/terminal-nerds/snippets#contributors
+
+### Author
+
+🎉 The idea of this project was initiated by [xeho91]. However, it's the [contributors] who matter the most.
+
+[contributors]: https://github.com/terminal-nerds/snippets/blob/main/README.md#project-contributors
+[xeho91]: https://github.com/xeho91

packages/error/package.json

@@ -0,0 +1,67 @@
+{
+	"$schema": "https://json.schemastore.org/package",
+	"type": "module",
+	"name": "@terminal-nerds/snippets-error",
+	"version": "0.0.0",
+	"description": "@terminal-nerds reusable snippets for errors.",
+	"keywords": [
+		"snippets",
+		"typescript",
+		"error"
+	],
+	"license": "MIT",
+	"author": {
+		"name": "Mateusz Kadlubowski",
+		"email": "[email protected]",
+		"url": "https://xeho91.com"
+	},
+	"homepage": "https://github.com/terminal-nerds/snippets",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/terminal-nerds/snippets.git",
+		"directory": "packages/error"
+	},
+	"bugs": "https://github.com/terminal-nerds/snippets/issues",
+	"engines": {
+		"node": ">=18"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/main.d.ts",
+			"import": "./dist/main.js"
+		},
+		"./*": {
+			"types": "./dist/*/*.d.ts",
+			"import": "./dist/*/*.js"
+		}
+	},
+	"files": [
+		"dist/"
+	],
+	"scripts": {
+		"build": "tsup",
+		"clean": "concurrently \"pnpm:clean:*\" --group --timings",
+		"clean:build": "del \"./dist\"",
+		"clean:cache": "del \"./node_modules/.cache\"",
+		"clean:test": "del \"./coverage\"",
+		"dev:test": "vitest watch --ui",
+		"dev:pkg": "tsup --watch",
+		"fix": "concurrently \"pnpm:fix:*\" --group --timings",
+		"fix:format": "pretty-quick --branch main --pattern \"packages/error/**/*\" --verbose",
+		"fix:js": "pnpm lint:js --fix",
+		"fix:md": "pnpm lint:md --fix",
+		"fix:pkg": "syncpack format ; syncpack fix-mismatches",
+		"lint": "concurrently \"pnpm:lint:*\" --group --timings",
+		"lint:deps": "depcheck",
+		"lint:format": "pnpm fix:format --check",
+		"lint:js": "DEBUG=\"eslint:cli-engine\" eslint . --ext .cjs,.js,.ts,.json,.yml --cache --cache-location \"./node_modules/.cache/eslint\"",
+		"lint:md": "markdownlint . --config \"../../.markdownlint.json\" --dot --ignore \"./LICENSE.md\" --ignore-path \"../../.gitignore\"",
+		"lint:pkg": "syncpack list-mismatches",
+		"lint:types": "tsc --noEmit",
+		"test:unit": "vitest run --dir \"./source\""
+	},
+	"dependencies": {
+		"modern-errors": "5.5.1",
+		"zod": "3.21.0"
+	}
+}

packages/error/source/custom/custom.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it } from "vitest";
+
+import { isError, isRuntimeError, isValidationError, RuntimeError, ValidationError } from "./custom.js";
+
+describe("isError(error)", () => {
+	it(`🔙 returns a boolean 🟢 'true' - on Error`, () => {
+		expect(isError(new Error("message"))).toBe(true);
+	});
+
+	it(`🔙 returns a boolean 🔴 'false' - on random value`, () => {
+		expect(isError("")).toBe(false);
+	});
+});
+
+describe("isRuntimeError(error)", () => {
+	it(`🔙 returns a boolean 🟢 'true' - on RuntimeError`, () => {
+		expect(isRuntimeError(new RuntimeError("message"))).toBe(true);
+	});
+
+	it(`🔙 returns a boolean 🔴 'false' - on Error`, () => {
+		expect(isRuntimeError(new Error("message"))).toBe(false);
+	});
+});
+
+describe("isValidationError(error)", () => {
+	it(`🔙 returns a boolean 🟢 'true' - on ValidationError`, () => {
+		expect(isValidationError(new ValidationError([]))).toBe(true);
+	});
+
+	it(`🔙 returns a boolean 🔴 'false' - on Error`, () => {
+		expect(isValidationError(new Error("message"))).toBe(false);
+	});
+});

packages/error/source/custom/custom.ts

@@ -0,0 +1,28 @@
+/**
+ * FIXME: There's a bug with pnpm and TypeScript, this a workaround.
+ *
+ * @see {@link https://github.com/microsoft/TypeScript/issues/42873}
+ */
+import type {} from "modern-errors";
+import ModernError from "modern-errors";
+import { ZodError } from "zod";
+
+export function isError(error: unknown): error is Error {
+	return error instanceof Error;
+}
+
+export const RuntimeError: typeof ModernError = ModernError.subclass("RuntimeError", {
+	props: {
+		isRuntimeError: true,
+	},
+});
+
+export function isRuntimeError(error: unknown): error is typeof RuntimeError {
+	return error instanceof RuntimeError;
+}
+
+export const ValidationError = ZodError;
+
+export function isValidationError(error: unknown): error is typeof ValidationError {
+	return error instanceof ValidationError;
+}

packages/error/source/main.ts

@@ -0,0 +1,2 @@
+/* MODULES */
+export * from "./custom/custom.js";