@poppinss/utils 6.1.0-0 → 6.2.0

package/README.md

@@ -33,8 +33,8 @@ Even though I do not care much about the package size (most of work is consumed
 
 |                   |                 |
 | ----------------- | --------------- |
-| Source code size  | `272K` (approx) |
-| Dependencies size | `432K` (approx) |
+| Source code size  | `436K` (approx) |
+| Dependencies size | `496K` (approx) |
 
 ## Installation
 
@@ -771,19 +771,18 @@ class ResourceNotFound extends Exception {
 throw new ResourceNotFound()
 ```
 
-Following is an example of creating a dynamic message with interpolation.
+#### Anonymous error classes
+You can also create an anonymous exception class using the `createError` method. The return value is a class
+constructor that accepts an array of values to use for interpolation.
 
-```ts
-import { Exception } from '@poppinss/utils'
-import string from '@poppinss/utils/string'
+The interpolation of error message is performed using the `util.format` message.
 
-class ResourceNotFound extends Exception {
-  static code = 'E_RESOURCE_NOT_FOUND'
-  static status = 404
-  static message = 'Unable to find resource with id {{ id }}'
-}
+```ts
+import { createError } from '@poppinss/utils'
+const E_RESOURCE_NOT_FOUND = createError('Unable to find resource with id %d', 'E_RESOURCE_NOT_FOUND')
 
-throw new ResourceNotFound(interpolate(ResourceNotFound.message, { id: 1 }))
+const id = 1
+throw new E_RESOURCE_NOT_FOUND([id])
 ```
 
 #### flatten
@@ -1074,7 +1073,7 @@ const dirname = getDirname(import.meta.url)
 const filename = getFilename(import.meta.url)
 ```
 
-[gh-workflow-image]: https://img.shields.io/github/workflow/status/poppinss/utils/test?style=for-the-badge
+[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/poppinss/utils/test.yml?style=for-the-badge
 [gh-workflow-url]: https://github.com/poppinss/utils/actions/workflows/test.yml 'Github action'
 [typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
 [typescript-url]: "typescript"

package/build/index.d.ts

@@ -2,7 +2,7 @@
 export { base64 } from './src/base64.js';
 export { compose } from './src/compose.js';
 export { defineStaticProperty } from './src/define_static_property.js';
-export { Exception } from './src/exception.js';
+export { Exception, createError } from './src/exception.js';
 export { flatten } from './src/flatten.js';
 export { fsImportAll } from './src/fs_import_all.js';
 export { fsReadAll } from './src/fs_read_all.js';
@@ -12,6 +12,6 @@ export { naturalSort } from './src/natural_sort.js';
 export { ObjectBuilder } from './src/object_builder.js';
 export { safeEqual } from './src/safe_equal.js';
 export { slash } from './src/slash.js';
-export { RuntimeException } from './src/exceptions/runtime_exception.js';
+export { RuntimeException, InvalidArgumentExceptiom } from './src/exceptions/runtime_exception.js';
 export declare function getDirname(url: string | URL): string;
 export declare function getFilename(url: string | URL): string;

package/build/index.js

@@ -3,7 +3,7 @@ import { dirname as pathDirname } from 'node:path';
 export { base64 } from './src/base64.js';
 export { compose } from './src/compose.js';
 export { defineStaticProperty } from './src/define_static_property.js';
-export { Exception } from './src/exception.js';
+export { Exception, createError } from './src/exception.js';
 export { flatten } from './src/flatten.js';
 export { fsImportAll } from './src/fs_import_all.js';
 export { fsReadAll } from './src/fs_read_all.js';
@@ -13,7 +13,7 @@ export { naturalSort } from './src/natural_sort.js';
 export { ObjectBuilder } from './src/object_builder.js';
 export { safeEqual } from './src/safe_equal.js';
 export { slash } from './src/slash.js';
-export { RuntimeException } from './src/exceptions/runtime_exception.js';
+export { RuntimeException, InvalidArgumentExceptiom } from './src/exceptions/runtime_exception.js';
 export function getDirname(url) {
     return pathDirname(getFilename(url));
 }

package/build/src/exception.d.ts

@@ -14,3 +14,8 @@ export declare class Exception extends Error {
     get [Symbol.toStringTag](): string;
     toString(): string;
 }
+export declare function createError<T extends any[] = never>(message: string, code: string, status?: number): typeof Exception & T extends never ? {
+    new (args?: any, options?: ErrorOptions): Exception;
+} : {
+    new (args: T, options?: ErrorOptions): Exception;
+};

package/build/src/exception.js

@@ -1,3 +1,4 @@
+import { format } from 'node:util';
 export class Exception extends Error {
     name;
     status;
@@ -27,3 +28,13 @@ export class Exception extends Error {
         return `${this.name}: ${this.message}`;
     }
 }
+export function createError(message, code, status) {
+    return class extends Exception {
+        static message = message;
+        static code = code;
+        static status = status;
+        constructor(args, options) {
+            super(format(message, ...(args || [])), options);
+        }
+    };
+}

package/build/src/exceptions/runtime_exception.d.ts

@@ -3,3 +3,7 @@ export declare class RuntimeException extends Exception {
     static code: string;
     static status: number;
 }
+export declare class InvalidArgumentExceptiom extends Exception {
+    static code: string;
+    static status: number;
+}

package/build/src/exceptions/runtime_exception.js

@@ -3,3 +3,7 @@ export class RuntimeException extends Exception {
     static code = 'E_RUNTIME_EXCEPTION';
     static status = 500;
 }
+export class InvalidArgumentExceptiom extends Exception {
+    static code = 'E_INVALID_ARGUMENTS_EXCEPTION';
+    static status = 500;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poppinss/utils",
-  "version": "6.1.0-0",
+  "version": "6.2.0",
   "description": "Handy utilities for repetitive work",
   "main": "build/index.js",
   "type": "module",
@@ -60,25 +60,25 @@
     "@japa/run-failed-tests": "^1.1.0",
     "@japa/runner": "^2.2.2",
     "@japa/spec-reporter": "^1.3.2",
-    "@swc/core": "^1.3.20",
+    "@swc/core": "^1.3.24",
     "@types/fs-extra": "^9.0.13",
-    "@types/node": "^18.11.7",
+    "@types/node": "^18.11.18",
     "c8": "^7.12.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.28.0",
+    "eslint": "^8.30.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^3.0.3",
     "eslint-plugin-prettier": "^4.2.1",
-    "fs-extra": "^11.0.0",
+    "fs-extra": "^11.1.0",
     "github-label-sync": "^2.2.0",
     "husky": "^8.0.1",
     "lodash": "^4.17.21",
     "lodash-cli": "^4.17.5",
     "move-file-cli": "^3.0.0",
-    "np": "^7.6.2",
-    "prettier": "^2.8.0",
+    "np": "^7.6.3",
+    "prettier": "^2.8.1",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.4"
   },
   "dependencies": {
     "@lukeed/ms": "^2.0.0",
@@ -88,8 +88,8 @@
     "case-anything": "^2.1.10",
     "flattie": "^1.1.0",
     "pluralize": "^8.0.0",
-    "safe-stable-stringify": "^2.4.1",
-    "secure-json-parse": "^2.5.0",
+    "safe-stable-stringify": "^2.4.2",
+    "secure-json-parse": "^2.6.0",
     "slash": "^5.0.0",
     "slugify": "^1.6.5",
     "truncatise": "^0.0.8"