fix: migrate context to TS and ensure we do not access version on und…

…efined
netlify · Jan 12, 2023 · c7783b9 · c7783b9
1 parent 898c210
commit c7783b9
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 11 deletions.
diff --git a/packages/framework-info/src/context.js b/packages/framework-info/src/context.js
@@ -1,10 +1,21 @@
 import { cwd, version as nodejsVersion } from 'process'
 
-import isPlainObj from 'is-plain-obj'
 import { locatePath } from 'locate-path'
 import { readPackageUp } from 'read-pkg-up'
 
-export const getPackageJson = async (projectDir) => {
+/*
+interface PackageJsonInfo {
+  packageJson?: PackageJson
+  packageJsonPath?: string
+}
+
+interface Context extends PackageJsonInfo {
+  pathExists: (path: string) => Promise<boolean>
+  nodeVersion: string
+}
+*/
+
+export const getPackageJson = async (projectDir /*: string*/) /*: Promise<PackageJsonInfo>*/ => {
   try {
     const result = await readPackageUp({ cwd: projectDir, normalize: false })
     if (result === undefined) {
@@ -13,18 +24,18 @@ export const getPackageJson = async (projectDir) => {
 
     const { packageJson, path: packageJsonPath } = result
 
-    if (!isPlainObj(packageJson)) {
-      return { packageJsonPath }
-    }
-
     return { packageJson, packageJsonPath }
   } catch {
     return {}
   }
 }
 
-export const getContext = async ({ projectDir = cwd(), nodeVersion = nodejsVersion } = {}) => {
+export const getContext = async (
+  projectDir /*: string*/ = cwd(),
+  nodeVersion /*: string*/ = nodejsVersion,
+) /*: Promise<Context>*/ => {
   const { packageJson, packageJsonPath = projectDir } = await getPackageJson(projectDir)
+
   return {
     pathExists: async (path) => (await locatePath([path], { type: 'file', cwd: projectDir })) !== undefined,
     packageJson,

diff --git a/packages/framework-info/src/main.js b/packages/framework-info/src/main.js
@@ -69,7 +69,7 @@ const getFrameworkVersion = async (projectDir, frameworkInfo) => {
     ...frameworkInfo,
     package: {
       name: npmPackage,
-      version: packageJson.version || 'unknown',
+      version: packageJson?.version || 'unknown',
     },
   }
 }
@@ -82,7 +82,7 @@ const getFrameworkVersion = async (projectDir, frameworkInfo) => {
  * @returns {Promise<Framework[]>} frameworks - Frameworks used by a project
  */
 export const listFrameworks = async function (opts) {
-  const context = await getContext(opts)
+  const context = await getContext(opts.projectDir, opts.nodeVersion)
   const frameworkList = await list(context)
 
   const projectDir = opts && opts.projectDir ? opts.projectDir : cwd()
@@ -110,7 +110,7 @@ export const listFrameworks = async function (opts) {
  * @returns {Promise<boolean>} result - Whether the project uses this framework
  */
 export const hasFramework = async function (frameworkId, options) {
-  const context = await getContext(options)
+  const context = await getContext(options.projectDir, options.nodeVersion)
   return has(frameworkId, context)
 }
 
@@ -123,6 +123,6 @@ export const hasFramework = async function (frameworkId, options) {
  * @returns {Promise<Framework>} framework - Framework used by a project
  */
 export const getFramework = async function (frameworkId, options) {
-  const context = await getContext(options)
+  const context = await getContext(options.projectDir, options.nodeVersion)
   return get(frameworkId, context)
 }