feat(internal): isFile

- requires `node>=14.17.0`
- https://nodejs.org/api/fs.html#fsstatsyncpath-options

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

package.json

@@ -187,7 +187,7 @@
     "vitepress@npm:1.0.0-alpha.34": "patch:vitepress@npm%3A1.0.0-alpha.34#patches/vitepress+1.0.0-alpha.34.dev.patch"
   },
   "engines": {
-    "node": ">=14.16",
+    "node": ">=14.17.0",
     "yarn": "4.0.0-rc.34"
   },
   "packageManager": "yarn@4.0.0-rc.34",

src/internal/__tests__/is-file.spec.ts

@@ -0,0 +1,27 @@
+/**
+ * @file Unit Tests - isFile
+ * @module mlly/internal/tests/unit/isFile
+ */
+
+import testSubject from '../is-file'
+
+describe('unit:internal/isFile', () => {
+  it('should return false if id is not path to module', () => {
+    // Arrange
+    const cases: Parameters<typeof testSubject>[] = [
+      ['file.txt'],
+      ['node_modules/@flex-development/mkbuild/dist/index.mjs/package.json']
+    ]
+
+    // Act + Expect
+    cases.forEach(([id]) => expect(testSubject(id)).to.be.false)
+  })
+
+  it('should return false if id is path to directory', () => {
+    expect(testSubject('src')).to.be.false
+  })
+
+  it('should return true if id is path to file', () => {
+    expect(testSubject('src/index.ts')).to.be.true
+  })
+})

src/internal/is-file.ts

@@ -0,0 +1,23 @@
+/**
+ * @file Internal - isFile
+ * @module mlly/internal/isFile
+ */
+
+import fs from 'node:fs'
+import type { URL } from 'node:url'
+
+/**
+ * Checks if a file exists at `id`.
+ *
+ * @param {URL | string} id - Module id to evaluate
+ * @return {boolean} `true` if file exists at `id`
+ */
+const isFile = (id: URL | string): boolean => {
+  try {
+    return fs.statSync(id, { throwIfNoEntry: false })?.isFile() ?? false
+  } catch {
+    return false
+  }
+}
+
+export default isFile

src/utils/read-package-json.ts

@@ -3,6 +3,7 @@
  * @module mlly/utils/readPackageJson
  */
 
+import isFile from '#src/internal/is-file'
 import validateString from '#src/internal/validate-string'
 import validateURLString from '#src/internal/validate-url-string'
 import {
@@ -57,7 +58,7 @@ const readPackageJson = (
   const path: string = pathe.toNamespacedPath(pathe.join(dir, 'package.json'))
 
   // return null if package.json file does not exist
-  if (!fs.existsSync(path)) return null
+  if (!isFile(path)) return null
 
   /**
    * Possible `package.json` object.