@alessiofrittoli/exception 2.3.1 → 2.5.0

package/README.md

@@ -1,15 +1,22 @@
 # Exception 🚦
 
-[![NPM Latest Version][version-badge]][npm-url] [![Coverage Status][coverage-badge]][coverage-url] [![NPM Monthly Downloads][downloads-badge]][npm-url] [![Dependencies][deps-badge]][deps-url]
+[![NPM Latest Version][version-badge]][npm-url] [![Coverage Status][coverage-badge]][coverage-url] [![Socket Status][socket-badge]][socket-url] [![NPM Monthly Downloads][downloads-badge]][npm-url] [![Dependencies][deps-badge]][deps-url]
+
+[![GitHub Sponsor][sponsor-badge]][sponsor-url]
 
 [version-badge]: https://img.shields.io/npm/v/%40alessiofrittoli%2Fexception
 [npm-url]: https://npmjs.org/package/%40alessiofrittoli%2Fexception
 [coverage-badge]: https://coveralls.io/repos/github/alessiofrittoli/exception/badge.svg
 [coverage-url]: https://coveralls.io/github/alessiofrittoli/exception
+[socket-badge]: https://socket.dev/api/badge/npm/package/@alessiofrittoli/exception
+[socket-url]: https://socket.dev/npm/package/@alessiofrittoli/exception/overview
 [downloads-badge]: https://img.shields.io/npm/dm/%40alessiofrittoli%2Fexception.svg
 [deps-badge]: https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fexception
 [deps-url]: https://libraries.io/npm/%40alessiofrittoli%2Fexception
 
+[sponsor-badge]: https://img.shields.io/static/v1?label=Fund%20this%20package&message=%E2%9D%A4&logo=GitHub&color=%23DB61A2
+[sponsor-url]: https://github.com/sponsors/alessiofrittoli
+
 ## Handle errors with ease
 
 This documentation describes the `Exception` class, which provides a structured way to handle errors in TypeScript. It includes custom properties such as `code`, `name`, and `status` for more detailed error reporting and debugging.
@@ -22,6 +29,8 @@ This documentation describes the `Exception` class, which provides a structured
   - [Exception Class](#exception-class)
   - [Usage Scenarios](#usage-scenarios)
 - [Development](#development)
+  - [Install depenendencies](#install-depenendencies)
+  - [Build the source code](#build-the-source-code)
   - [ESLint](#eslint)
   - [Jest](#jest)
 - [Contributing](#contributing)
@@ -273,9 +282,9 @@ or using `pnpm`
 pnpm i
 ```
 
-#### Build your source code
+#### Build the source code
 
-Run the following command to build code for distribution.
+Run the following command to test and build code for distribution.
 
 ```bash
 pnpm build
@@ -295,24 +304,13 @@ Run all the defined test suites by running the following:
 
 ```bash
 # Run tests and watch file changes.
-pnpm test
-
-# Run tests and watch file changes with jest-environment-jsdom.
-pnpm test:jsdom
+pnpm test:watch
 
 # Run tests in a CI environment.
 pnpm test:ci
-
-# Run tests in a CI environment with jest-environment-jsdom.
-pnpm test:ci:jsdom
 ```
 
-You can eventually run specific suits like so:
-
-```bash
-pnpm test:jest
-pnpm test:jest:jsdom
-```
+- See [`package.json`](./package.json) file scripts for more info.
 
 Run tests with coverage.
 
@@ -321,16 +319,21 @@ An HTTP server is then started to serve coverage files from `./coverage` folder.
 ⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.
 
 ```bash
-pnpm test:coverage
+test:coverage:serve
 ```
 
 ---
 
 ### Contributing
 
-Contributions are truly welcome!\
+Contributions are truly welcome!
+
 Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.
 
+Help keep this project up to date with [GitHub Sponsor][sponsor-url].
+
+[![GitHub Sponsor][sponsor-badge]][sponsor-url]
+
 ---
 
 ### Security

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@alessiofrittoli/exception",
-	"version": "2.3.1",
+	"version": "2.5.0",
 	"description": "Handle errors with ease",
 	"author": {
 		"name": "Alessio Frittoli",
@@ -8,6 +8,12 @@
 		"url": "https://alessiofrittoli.it"
 	},
 	"license": "MIT",
+	"funding": [
+		{
+			"type": "github",
+			"url": "https://github.com/sponsors/alessiofrittoli"
+		}
+	],
 	"keywords": [
 		"exceptions",
 		"errors"
@@ -41,43 +47,49 @@
 	},
 	"sideEffects": false,
 	"scripts": {
+		"//1a": "*********************************************************************",
+		"//1b": "*********************** BUILD - LINT - RELEASE **********************",
+		"//1c": "*********************************************************************",
 		"build": "pnpm lint && pnpm test:ci && tsup",
 		"build:watch": "tsup --watch",
 		"lint": "eslint",
 		"release": "node scripts/publish.js --verbose --npm",
+		"//2a": "*********************************************************************",
+		"//2b": "***************************** UNIT TESTS ****************************",
+		"//2c": "*********************************************************************",
 		"test": "jest --verbose",
 		"test:watch": "jest --watchAll --verbose",
-		"test:jsdom": "JSDOM=true pnpm test:watch",
 		"test:ci": "jest --ci --verbose",
-		"test:ci:jsdom": "JSDOM=true pnpm test:ci",
+		"//3a": "*********************************************************************",
+		"//3b": "************************ UNIT TESTS COVERAGE ************************",
+		"//3c": "*********************************************************************",
 		"test:coverage": "pnpm test:watch --coverage",
 		"test:ci:coverage": "pnpm test:ci --coverage",
 		"test:serve-coverage": "http-server ./coverage/lcov-report --gzip true -p 0 -o --silent",
-		"test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\"",
-		"test:coverage:jsdom": "JSDOM=true pnpm test:coverage",
-		"test:coverage:jsdom:serve": "JSDOM=true pnpm test:coverage:serve",
-		"test:jest": "pnpm test:watch jest.test.ts",
-		"test:jest:jsdom": "JSDOM=true pnpm test:jest",
-		"test:exception": "pnpm test:watch exception.test.ts"
+		"test:coverage:serve": "concurrently --prefix none --kill-others \"pnpm test:coverage\" \"pnpm test:serve-coverage\""
 	},
 	"devDependencies": {
-		"@alessiofrittoli/node-scripts": "^2.2.1",
-		"@eslint/js": "^9.20.0",
+		"@alessiofrittoli/node-scripts": "^2.4.0",
+		"@eslint/js": "^9.22.0",
 		"@jest/globals": "^29.7.0",
 		"@types/jest": "^29.5.14",
-		"@types/node": "^22.13.2",
+		"@types/node": "^22.13.11",
 		"concurrently": "^9.1.2",
 		"dotenv": "^16.4.7",
-		"esbuild": "0.25.0",
-		"eslint": "^9.20.1",
-		"globals": "^15.15.0",
+		"esbuild": "0.25.1",
+		"eslint": "^9.22.0",
+		"globals": "^16.0.0",
 		"http-server": "^14.1.1",
 		"jest": "^29.7.0",
-		"jest-environment-jsdom": "^29.7.0",
-		"ts-jest": "^29.2.5",
+		"ts-jest": "^29.2.6",
 		"ts-node": "^10.9.2",
-		"tsup": "^8.3.6",
-		"typescript": "^5.7.3",
-		"typescript-eslint": "^8.24.0"
+		"tsup": "^8.4.0",
+		"typescript": "^5.8.2",
+		"typescript-eslint": "^8.27.0"
+	},
+	"pnpm": {
+		"onlyBuiltDependencies": [
+			"esbuild"
+		]
 	}
 }