feat(utils): readPackageJson

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

Author: unicornware

.dictionary.txt

@@ -22,6 +22,7 @@ iife
 keyid
 larsgw
 lcov
+lintstagedrc
 micnncim
 mkbuild
 nocheck

.eslintrc.base.cjs

@@ -619,7 +619,7 @@ const config = {
     'unicorn/prefer-default-parameters': 2,
     'unicorn/prefer-export-from': [2, { ignoreUsedVariables: true }],
     'unicorn/prefer-includes': 2,
-    'unicorn/prefer-json-parse-buffer': 2,
+    'unicorn/prefer-json-parse-buffer': 0,
     'unicorn/prefer-math-trunc': 2,
     'unicorn/prefer-module': 2,
     'unicorn/prefer-negative-index': 2,
@@ -1058,7 +1058,6 @@ const config = {
         'unicorn/no-useless-undefined': 0,
         'unicorn/prefer-at': 0,
         'unicorn/prefer-dom-node-append': 0,
-        'unicorn/prefer-json-parse-buffer': 0,
         'unicorn/string-content': 0
       }
     },

.gitignore

@@ -48,6 +48,7 @@ codecov
 coverage/
 tsconfig.temp.json
 vitest.config.*.timestamp-*.mjs
+!__fixtures__/node_modules/
 
 # ESLint
 # ------------------------------------------------------------------------------

.husky/pre-commit

@@ -9,4 +9,4 @@
 
 yarn typecheck --changed HEAD^
 yarn check:types:build
-lint-staged
+lint-staged --config=.lintstagedrc.json

__fixtures__/node_modules/package-invalid-json/package.json

@@ -79,6 +79,7 @@
     "@flex-development/import-regex": "2.0.1",
     "@flex-development/is-builtin": "1.0.1",
     "@flex-development/pathe": "1.0.3",
+    "@flex-development/pkg-types": "2.0.0",
     "@flex-development/tsconfig-types": "2.0.1",
     "@flex-development/tutils": "6.0.0-alpha.7",
     "import-meta-resolve": "2.2.0",

package.json

@@ -0,0 +1,65 @@
+/**
+ * @file Unit Tests - readPackageJson
+ * @module mlly/utils/tests/unit/readPackageJson
+ */
+
+import { ErrorCode, NodeError } from '@flex-development/errnode'
+import pathe from '@flex-development/pathe'
+import type { PackageJson } from '@flex-development/pkg-types'
+import fs from 'node:fs'
+import { pathToFileURL } from 'node:url'
+import testSubject from '../read-package-json'
+
+describe('unit:utils/readPackageJson', () => {
+  it('should return PackageJson object', () => {
+    // Arrange
+    const pkg: PackageJson = JSON.parse(fs.readFileSync('package.json', 'utf8'))
+    const cases: Parameters<typeof testSubject>[0][] = [
+      pathToFileURL(process.cwd()),
+      pathToFileURL(process.cwd()).href,
+      process.cwd(),
+      undefined
+    ]
+
+    // Act + Expect
+    cases.forEach(dir => expect(testSubject(dir)).deep.equal(pkg))
+  })
+
+  it('should return null if package.json file does not exist', () => {
+    expect(testSubject(pathe.resolve('dist'))).to.be.null
+  })
+
+  it('should throw if package.json file is not valid json', () => {
+    // Arrange
+    const code: ErrorCode = ErrorCode.ERR_INVALID_PACKAGE_CONFIG
+    const dir: string = '__fixtures__/node_modules/package-invalid-json'
+    const err: string = `Invalid package config ${dir}/package.json`
+    const parent: string = import.meta.url
+    const specifier: string = 'package-invalid-json'
+    const cases: [...Parameters<typeof testSubject>, string][] = [
+      [dir, undefined, undefined, err],
+      [dir, specifier, undefined, `${err} while importing '${specifier}'`],
+      [
+        dir,
+        specifier,
+        parent,
+        `${err} while importing '${specifier}' from ${parent}`
+      ]
+    ]
+
+    // Act + Expect
+    cases.forEach(([dir, specifier, parent, expected]) => {
+      let error: NodeError
+
+      try {
+        testSubject(dir, specifier, parent)
+      } catch (e: unknown) {
+        error = e as typeof error
+      }
+
+      expect(error!).to.not.be.undefined
+      expect(error!).to.have.property('code').equal(code)
+      expect(error!).to.have.property('message').startWith(expected)
+    })
+  })
+})

src/utils/__tests__/read-package-json.spec.ts

@@ -11,6 +11,7 @@ export { default as findRequires } from './find-requires'
 export { default as findStaticImports } from './find-static-imports'
 export { default as hasCJSSyntax } from './has-cjs-syntax'
 export { default as hasESMSyntax } from './has-esm-syntax'
+export { default as readPackageJson } from './read-package-json'
 export { default as resolveAlias } from './resolve-alias'
 export { default as resolveAliases } from './resolve-aliases'
 export { default as resolveModule } from './resolve-module'

src/utils/index.ts

@@ -0,0 +1,80 @@
+/**
+ * @file readPackageJson
+ * @module mlly/utils/readPackageJson
+ */
+
+import {
+  ERR_INVALID_PACKAGE_CONFIG,
+  type NodeError
+} from '@flex-development/errnode'
+import pathe from '@flex-development/pathe'
+import type { PackageJson } from '@flex-development/pkg-types'
+import type { Nullable } from '@flex-development/tutils'
+import fs from 'node:fs'
+import { URL, fileURLToPath } from 'node:url'
+
+/**
+ * Reads a `package.json` file from the given directory.
+ *
+ * Returns `null` if a file is not found.
+ *
+ * Throws [`ERR_INVALID_PACKAGE_CONFIG`][1] if the file found is not valid JSON.
+ *
+ * [1]: https://nodejs.org/api/errors.html#err_invalid_package_config
+ *
+ * @param {URL | string} [dir='.'] - Id of directory containing `package.json`
+ * @param {string?} [specifier] - Module specifier passed by user to initiate
+ * reading of `package.json` file
+ * @param {string?} [parent] - Id of module `specifier` is relative to
+ * @return {?PackageJson} `package.json` object or `null` if file is not found
+ * @throws {NodeError} If `package.json` file does not contain valid JSON
+ */
+const readPackageJson = (
+  dir: URL | string = '.',
+  specifier?: string,
+  parent?: string
+): Nullable<PackageJson> => {
+  // ensure dir is a path
+  if (dir instanceof URL) dir = dir.pathname
+  else if (dir.startsWith('file:')) dir = fileURLToPath(dir)
+
+  /**
+   * Full path to `package.json` file.
+   *
+   * @const {string} path
+   */
+  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
+
+  /**
+   * Possible `package.json` object.
+   *
+   * @var {PackageJson} pkg
+   */
+  let pkg: PackageJson
+
+  // try parsing package.json file
+  try {
+    pkg = JSON.parse(fs.readFileSync(path, 'utf8'))
+  } catch (e: unknown) {
+    /**
+     * String containing module specifier passed by user to initiate reading of
+     * `package.json` file and the location the module specifier was imported
+     * from.
+     *
+     * @var {string | undefined} base
+     */
+    let base: string | undefined = specifier ? `'${specifier}'` : undefined
+
+    // add specifier import location
+    if (base && parent) base += ` from ${parent}`
+
+    throw new ERR_INVALID_PACKAGE_CONFIG(path, base, (e as SyntaxError).message)
+  }
+
+  return pkg
+}
+
+export default readPackageJson

src/utils/read-package-json.ts

@@ -1352,6 +1352,7 @@ __metadata:
     "@flex-development/is-builtin": "npm:1.0.1"
     "@flex-development/mkbuild": "npm:1.0.0-alpha.9"
     "@flex-development/pathe": "npm:1.0.3"
+    "@flex-development/pkg-types": "npm:2.0.0"
     "@flex-development/tsconfig-types": "npm:2.0.1"
     "@flex-development/tutils": "npm:6.0.0-alpha.7"
     "@graphql-eslint/eslint-plugin": "npm:3.14.3"
@@ -1454,6 +1455,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@flex-development/pkg-types@npm:2.0.0":
+  version: 2.0.0
+  resolution: "@flex-development/pkg-types@npm:2.0.0::__archiveUrl=https%3A%2F%2Fnpm.pkg.github.com%2Fdownload%2F%40flex-development%2Fpkg-types%2F2.0.0%2F58267203fea93d31234e31d65e2058ed566b209a"
+  peerDependencies:
+    "@flex-development/tutils": ">=6.0.0-alpha.7"
+  checksum: 7a7ce8a3289f30e0d6aa0b5e5028c308a36956f779b9baf6f2d209842b01acc2bc645f85a541125f83f461d41b15262b3af65ff6cd3b3f727679216acf0520cb
+  languageName: node
+  linkType: hard
+
 "@flex-development/tsconfig-types@npm:2.0.1":
   version: 2.0.1
   resolution: "@flex-development/tsconfig-types@npm:2.0.1::__archiveUrl=https%3A%2F%2Fnpm.pkg.github.com%2Fdownload%2F%40flex-development%2Ftsconfig-types%2F2.0.1%2F8e8d4ca7bdb91b10b634d4d02044f15f72c46ede"