feat: changes NX project.json detection to rely on the user config for their package path

Author: Cephyric-gh

src/helpers/fixOutputDir.js

@@ -11,8 +11,9 @@ const fixOutputDir = async function ({
   IS_LOCAL,
   netlifyConfig,
   workspaceType,
+  packagePath,
 }) {
-  const angularJson = getAngularJson({ failPlugin, siteRoot, workspaceType })
+  const angularJson = getAngularJson({ failPlugin, siteRoot, workspaceType, packagePath })
   const project = getProject(angularJson, failBuild, workspaceType === 'nx')
 
   const { outputPath } = workspaceType === 'nx' ? project.targets.build.options : project.architect.build.options

src/helpers/getAngularJson.js

@@ -9,25 +9,24 @@ const { existsSync, readJsonSync } = require('fs-extra')
  * @param {string} obj.siteRoot Root directory of an app
  * @param {(msg: string) => never} obj.failPlugin Function to fail the plugin
  * @param {'nx' | 'default'} obj.workspaceType Type of monorepo, dictates what json file to open
+ * @param {string} obj.packagePath The path to the package directory
  *
  * @returns {any}
  */
-const getAngularJson = function ({ failPlugin, siteRoot, workspaceType }) {
+const getAngularJson = function ({ failPlugin, siteRoot, workspaceType, packagePath }) {
   if (workspaceType === 'nx') {
-    const selectedProject = process.env.ANGULAR_PROJECT
-
-    if (!selectedProject) {
+    if ((packagePath ?? '').length === 0) {
       return failPlugin(
-        `The ANGULAR_PROJECT environment variable is not set. This is needed to determine the project.json to load in an NX workspace`,
+        `packagePath must be set to the location of the package.json being built when deploying an NX monorepo, e.g. "apps/{project-name}"`,
       )
     }
 
-    if (!existsSync(join(siteRoot, 'apps', selectedProject, 'project.json'))) {
-      return failPlugin(`No project.json found in apps/${selectedProject}`)
+    if (!existsSync(join(siteRoot, packagePath, 'project.json'))) {
+      return failPlugin(`No project.json found in ${packagePath}`)
     }
 
     try {
-      return readJsonSync(join(siteRoot, 'apps', selectedProject, 'project.json'))
+      return readJsonSync(join(siteRoot, packagePath, 'project.json'))
     } catch {
       return failPlugin(`Could not parse the contents of project.json`)
     }

src/helpers/serverModuleHelpers.js

@@ -96,17 +96,18 @@ const guessUsedEngine = function (serverModuleContents) {
  * @param {string} obj.siteRoot Root directory of an app
  * @param {(msg: string) => never} obj.failPlugin Function to fail the plugin
  * @param {'nx' | 'default'} obj.workspaceType The workspace type being parsed
+ * @param {string} obj.packagePath The path to the package directory
  * * @param {(msg: string) => never} obj.failBuild Function to fail the build
  *
  * @returns {'AppEngine' | 'CommonEngine' | undefined}
  */
-const fixServerTs = async function ({ angularVersion, siteRoot, failPlugin, failBuild, workspaceType }) {
+const fixServerTs = async function ({ angularVersion, siteRoot, failPlugin, failBuild, workspaceType, packagePath }) {
   if (!satisfies(angularVersion, '>=19.0.0-rc', { includePrerelease: true })) {
     // for pre-19 versions, we don't need to do anything
     return
   }
 
-  const angularJson = getAngularJson({ failPlugin, siteRoot, workspaceType })
+  const angularJson = getAngularJson({ failPlugin, siteRoot, workspaceType, packagePath })
 
   const project = getProject(angularJson, failBuild, workspaceType === 'nx')
   const build = workspaceType === 'nx' ? project.targets.build : project.architect.build

src/index.js

@@ -37,9 +37,17 @@ module.exports = {
       IS_LOCAL: constants.IS_LOCAL,
       netlifyConfig,
       workspaceType,
+      packagePath: constants.PACKAGE_PATH,
     })
 
-    usedEngine = await fixServerTs({ angularVersion, siteRoot, failPlugin, failBuild, workspaceType })
+    usedEngine = await fixServerTs({
+      angularVersion,
+      siteRoot,
+      failPlugin,
+      failBuild,
+      workspaceType,
+      packagePath: constants.PACKAGE_PATH,
+    })
   },
   async onBuild({ utils, netlifyConfig, constants }) {
     await revertServerTsFix()
@@ -50,7 +58,7 @@ module.exports = {
     const { failBuild, failPlugin } = utils.build
 
     const { siteRoot, workspaceType } = getAngularRoot({ failBuild, netlifyConfig, onBuild: true })
-    const angularJson = getAngularJson({ failPlugin, siteRoot, workspaceType })
+    const angularJson = getAngularJson({ failPlugin, siteRoot, workspaceType, packagePath: constants.PACKAGE_PATH })
 
     const project = getProject(angularJson, failBuild, workspaceType === 'nx')
     const build = workspaceType === 'nx' ? project.targets.build : project.architect.build