feat(internal): formatMessage

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

.cspell.json

@@ -31,13 +31,17 @@
     "patches/",
     "yarn.lock"
   ],
-  "ignoreRegExpList": ["/from\\s+(['\"]).*\\1/"],
+  "ignoreRegExpList": [
+    "/@flex-development\\/.*/",
+    "/from\\s+(['\"]).*\\1/",
+    "import\\(.*\\)"
+  ],
   "ignoreWords": [],
   "language": "en-US",
   "patterns": [],
   "readonly": true,
   "useGitignore": true,
   "usePnP": false,
   "version": "0.2",
-  "words": ["fldv", "create-node-error"]
+  "words": ["Odfijos", "fldv"]
 }

.eslintrc.base.cjs

@@ -1032,6 +1032,7 @@ const config = {
         'promise/prefer-await-to-callbacks': 0,
         'promise/valid-params': 0,
         'unicorn/consistent-destructuring': 0,
+        'unicorn/error-message': 0,
         'unicorn/explicit-length-check': 0,
         'unicorn/no-array-for-each': 0,
         'unicorn/prefer-at': 0,

.eslintrc.cjs

@@ -11,7 +11,15 @@
 const config = {
   root: true,
   extends: ['./.eslintrc.base.cjs'],
-  overrides: [...require('./.eslintrc.base.cjs').overrides]
+  overrides: [
+    ...require('./.eslintrc.base.cjs').overrides,
+    {
+      files: ['src/internal/format-message.ts'],
+      rules: {
+        'unicorn/error-message': 0
+      }
+    }
+  ]
 }
 
 module.exports = config

src/internal/__tests__/format-message.spec.ts

@@ -0,0 +1,69 @@
+/**
+ * @file Unit Tests - formatMessage
+ * @module create-error-node/internal/tests/unit/formatMessage
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { MessageFn } from '#src/types'
+import { format } from 'node-inspect-extracted'
+import { resolve } from 'node:path'
+import { pathToFileURL } from 'node:url'
+import testSubject from '../format-message'
+
+describe('unit:internal/formatMessage', () => {
+  it('should return formatted messsage if msg is MessageFn', () => {
+    // Arrange
+    const code: ErrorCode = ErrorCode.ERR_MODULE_NOT_FOUND
+    const path: string = resolve('src/utils.ts')
+    const base: string = resolve('src/index.ts')
+    const msg: MessageFn<[string, string, string?]> = (
+      path: string,
+      base: string,
+      type: string = 'module'
+    ) => `Cannot find ${type} '${path}' imported from ${base}`
+
+    // Act
+    const result = testSubject(code, msg, [path, base], new TypeError())
+
+    // Expect
+    expect(result).to.equal(msg(path, base))
+  })
+
+  it('should return formatted messsage if msg is string', () => {
+    // Arrange
+    const code: ErrorCode = ErrorCode.ERR_IMPORT_ASSERTION_TYPE_MISSING
+    const msg: string = 'Module "%s" needs an import assertion of type "%s"'
+    const s1: string = pathToFileURL(resolve('./package.json')).href
+    const s2: string = 'json'
+
+    // Act
+    const result = testSubject(code, msg, [s1, s2], new TypeError())
+
+    // Expect
+    expect(result).to.equal(format(msg, s1, s2))
+  })
+
+  it('should throw if args length is invalid', () => {
+    // Arrange
+    const cases: Parameters<typeof testSubject>[] = [
+      [
+        ErrorCode.ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED,
+        'Import assertion type "%s" is unsupported'
+      ],
+      [
+        ErrorCode.ERR_UNKNOWN_FILE_EXTENSION,
+        (ext: string, path: string) => {
+          return `Unknown file extension "${ext}" for ${path}`
+        }
+      ]
+    ]
+
+    // Act + Expect
+    cases.forEach(([code, msg, args = [], self]) => {
+      const fn: typeof testSubject = testSubject.bind({}, code, msg, args, self)
+      const pattern: string = `^${code}; The arguments length \\(${args.length}\\) provided to \`(?:msg|util\\.format)\` does not match the required length \\(\\d\\)\\.$`
+
+      expect(fn).to.throw(new RegExp(pattern))
+    })
+  })
+})

src/internal/format-message.ts

@@ -0,0 +1,78 @@
+/**
+ * @file Internal - formatMessage
+ * @module create-node-error/internal/formatMessage
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L440-L467
+ */
+
+import type { ErrorCode } from '#src/enums'
+import type { MessageFn } from '#src/types'
+import { format } from 'node-inspect-extracted'
+
+/**
+ * Formats an error message.
+ *
+ * @see https://nodejs.org/api/util.html#utilformatformat-args
+ *
+ * @param {ErrorCode} code - Node.js error code
+ * @param {MessageFn | string} msg - Error message or message function
+ * @param {any[]} [args=[]] - `util.format` arguments if `msg` is a string, or
+ * `msg` parameters if `msg` is a function
+ * @param {Error} [self=new Error()] - Error used as `this` argument in `msg`
+ * @return {string} Formatted error message
+ * @throws {Error} If `args` length is invalid
+ */
+function formatMessage(
+  code: ErrorCode,
+  msg: MessageFn | string,
+  args: any[] = [],
+  self: Error = new Error()
+): string {
+  /**
+   * Invalid {@linkcode args} length error message.
+   *
+   * @var {string} error
+   */
+  let error: string = `${code};` + ' '
+
+  /**
+   * Expected message length.
+   *
+   * @var {number} length
+   */
+  let length: number = 0
+
+  // try returning error message from function
+  if (typeof msg === 'function') {
+    // set expected message length to total number of function parameters
+    length = msg.length
+
+    // ensure expected message length. default parameters do not count
+    if (!(length <= args.length)) {
+      error += `The arguments length (${args.length}) provided to \`msg\` does not match the required length (${length}).`
+      throw new Error(error)
+    }
+
+    // return result from message function
+    return Reflect.apply(msg, self, args)
+  }
+
+  /**
+   * {@linkcode format} specifiers regex.
+   *
+   * @const {RegExp} regex
+   */
+  const regex: RegExp = /%[Odfijos]/g
+
+  // get expected message length
+  while (regex.exec(msg) !== null) length++
+
+  // ensure expected message length
+  if (length !== args.length) {
+    error += `The arguments length (${args.length}) provided to \`util.format\` does not match the required length (${length}).`
+    throw new Error(error)
+  }
+
+  return Reflect.apply(format, null, [msg, ...args])
+}
+
+export default formatMessage