Improve option validation

Author: ehmicky

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 3.4.0
+
+## Features
+
+- Improve options validation
+
 # 3.3.0
 
 ## Features

src/dirs.js

@@ -1,23 +1,21 @@
 import { homedir as getHomeDir } from 'os'
-import { normalize, dirname } from 'path'
+import { dirname } from 'path'
 import { env } from 'process'
-import { fileURLToPath } from 'url'
 
 // Retrieve list of directories to search:
 //   - current directory
 //   - any parent directory
 //   - home directory
 // If `global` option is `true`, only home directory is searched
-export const getSearchDirs = function ({ cwd, globalOpt }) {
+export const getSearchDirs = function (cwd, globalOpt) {
   // For tests only
   const homeDir = env.TEST_HOME_DIR === undefined ? HOME_DIR : env.TEST_HOME_DIR
 
   if (globalOpt) {
     return [homeDir]
   }
 
-  const cwdA = normalizeCwd(cwd)
-  const parentDirs = getParentDirs(cwdA)
+  const parentDirs = getParentDirs(cwd)
 
   if (parentDirs.includes(homeDir)) {
     return parentDirs
@@ -26,10 +24,6 @@ export const getSearchDirs = function ({ cwd, globalOpt }) {
   return [...parentDirs, homeDir]
 }
 
-const normalizeCwd = function (cwd) {
-  return cwd instanceof URL ? fileURLToPath(cwd) : normalize(cwd)
-}
-
 const getParentDirs = function (dir) {
   const parentDir = dirname(dir)
   const parentDirs = parentDir === dir ? [] : getParentDirs(parentDir)

src/find.js

@@ -3,8 +3,8 @@ import { loadVersionFile } from './load.js'
 import { getFilePath } from './path.js'
 
 // Retrieve Node.js version before normalization
-export const findVersion = async function ({ cwd, globalOpt }) {
-  const { filePath, rawVersion } = await getVersionFile({ cwd, globalOpt })
+export const findVersion = async function (cwd, globalOpt) {
+  const { filePath, rawVersion } = await getVersionFile(cwd, globalOpt)
 
   if (rawVersion !== undefined) {
     return { filePath, rawVersion }
@@ -14,8 +14,8 @@ export const findVersion = async function ({ cwd, globalOpt }) {
 }
 
 // Retrieve Node.js version file
-const getVersionFile = async function ({ cwd, globalOpt }) {
-  const filePath = await getFilePath({ cwd, globalOpt })
+const getVersionFile = async function (cwd, globalOpt) {
+  const filePath = await getFilePath(cwd, globalOpt)
 
   if (filePath === undefined) {
     return {}

src/main.js

@@ -8,10 +8,10 @@ import { getOpts } from './options.js'
 // `.nvmrc` (or similar files) or `package.json` `engines.node`.
 export default async function preferredNodeVersion(opts) {
   const { cwd, globalOpt, nodeVersionAliasOpts } = getOpts(opts)
-  const { filePath, envVariable, rawVersion } = await findVersion({
+  const { filePath, envVariable, rawVersion } = await findVersion(
     cwd,
     globalOpt,
-  })
+  )
 
   if (rawVersion === undefined) {
     return {}

src/options.js

@@ -1,3 +1,6 @@
+import { normalize } from 'path'
+import { fileURLToPath } from 'url'
+
 import isPlainObj from 'is-plain-obj'
 
 // Normalize options and assign default values
@@ -7,6 +10,21 @@ export const getOpts = function (opts = {}) {
   }
 
   const { cwd = '.', global: globalOpt = false, fetch: fetchOpt, mirror } = opts
+  const cwdA = normalizeCwd(cwd)
   const nodeVersionAliasOpts = { fetch: fetchOpt, mirror }
-  return { cwd, globalOpt, nodeVersionAliasOpts }
+  return { cwd: cwdA, globalOpt, nodeVersionAliasOpts }
+}
+
+const normalizeCwd = function (cwd) {
+  if (objectToString.call(cwd) === '[object URL]') {
+    return fileURLToPath(cwd)
+  }
+
+  if (typeof cwd !== 'string') {
+    throw new TypeError(`Option "cwd" must be a string or a URL: ${cwd}`)
+  }
+
+  return normalize(cwd)
 }
+
+const { toString: objectToString } = Object.prototype

src/path.js

@@ -8,13 +8,13 @@ import { loadVersionFile, NODE_VERSION_FILES } from './load.js'
 
 // Find any file indicating the current directory's Node.js version
 // Use p-locate instead of find-up for performance (more parallelism)
-export const getFilePath = function ({ cwd, globalOpt }) {
-  const searchFiles = getSearchFiles({ cwd, globalOpt })
+export const getFilePath = function (cwd, globalOpt) {
+  const searchFiles = getSearchFiles(cwd, globalOpt)
   return pLocate(searchFiles, isNodeVersionFile)
 }
 
-const getSearchFiles = function ({ cwd, globalOpt }) {
-  const searchDirs = getSearchDirs({ cwd, globalOpt })
+const getSearchFiles = function (cwd, globalOpt) {
+  const searchDirs = getSearchDirs(cwd, globalOpt)
   const searchFiles = searchDirs.flatMap(addNodeVersionFiles)
   return searchFiles
 }