[cli] add support for JSON5 and skip when no rootDirectory (vercel#8913)

### Related Issues Adds support for comments in JSON configs and skips operation when root directory is null or `'.'` ### 📋 Checklist <!-- Please keep your PR as a Draft until the checklist is complete --> #### Tests - [ ] The code changed/added as part of this PR has been covered with tests - [ ] All tests pass locally with `yarn test-unit` #### Code Review - [ ] This PR has a concise title and thorough description useful to a reviewer - [ ] Issue from task tracker has a link to this PR

Author: Ethan Arrowood

packages/cli/package.json

@@ -51,6 +51,7 @@
  "@vercel/remix": "1.0.35",
  "@vercel/ruby": "1.3.41",
  "@vercel/static-build": "1.0.36",
+ "json5": "2.2.1",
  "update-notifier": "5.1.0"
  },
  "devDependencies": {

packages/cli/src/commands/build.ts

@@ -304,7 +304,12 @@ async function doBuild(
  ...pickOverrides(localConfig),
  };
 
- await setMonorepoDefaultSettings(cwd, workPath, projectSettings, output);
+ if (
+ projectSettings.rootDirectory !== null &&
+ projectSettings.rootDirectory !== '.'
+ ) {
+ await setMonorepoDefaultSettings(cwd, workPath, projectSettings, output);
+ }
 
  // Get a list of source files
  const files = (await getFiles(workPath, client)).map(f =>

packages/cli/src/util/build/monorepo.ts

@@ -9,6 +9,7 @@ import {
 import { ProjectLinkAndSettings } from '../projects/project-settings';
 import { Output } from '../output';
 import title from 'title';
+import JSON5 from 'json5';
 
 export async function setMonorepoDefaultSettings(
  cwd: string,
@@ -55,7 +56,7 @@ export async function setMonorepoDefaultSettings(
 
  if (monorepoManager === 'turbo') {
  // No ENOENT handling required here since conditional wouldn't be `true` unless `turbo.json` was found.
- const turboJSON = JSON.parse(
+ const turboJSON = JSON5.parse(
  fs.readFileSync(join(cwd, 'turbo.json'), 'utf-8')
  );
 
@@ -76,7 +77,7 @@ export async function setMonorepoDefaultSettings(
  );
  } else if (monorepoManager === 'nx') {
  // No ENOENT handling required here since conditional wouldn't be `true` unless `nx.json` was found.
- const nxJSON = JSON.parse(fs.readFileSync(join(cwd, 'nx.json'), 'utf-8'));
+ const nxJSON = JSON5.parse(fs.readFileSync(join(cwd, 'nx.json'), 'utf-8'));
 
  if (!nxJSON?.targetDefaults?.build) {
  output.log(
@@ -92,14 +93,14 @@ export async function setMonorepoDefaultSettings(
 
  if (projectJSONBuf) {
  output.log('Found project.json Nx configuration.');
- const projectJSON = JSON.parse(projectJSONBuf.toString('utf-8'));
+ const projectJSON = JSON5.parse(projectJSONBuf.toString('utf-8'));
  if (projectJSON?.targets?.build) {
  hasBuildTarget = true;
  }
  }
 
  if (packageJsonBuf) {
- const packageJSON = JSON.parse(packageJsonBuf.toString('utf-8'));
+ const packageJSON = JSON5.parse(packageJsonBuf.toString('utf-8'));
  if (packageJSON?.nx) {
  output.log('Found package.json Nx configuration.');
  if (packageJSON.nx.targets?.build) {

packages/cli/test/fixtures/unit/commands/build/monorepo-detection/nx-package-config/build.js

@@ -0,0 +1,7 @@
+const path = require('node:path');
+const fs = require('node:fs');
+
+const public = path.join(__dirname, 'public');
+fs.rmSync(public, { recursive: true, force: true });
+fs.mkdirSync(public);
+fs.writeFileSync(path.join(public, 'index.txt'), `Hello, world`);

packages/cli/test/fixtures/unit/commands/build/monorepo-detection/nx-project-and-package-config-1/build.js

@@ -0,0 +1,7 @@
+const path = require('node:path');
+const fs = require('node:fs');
+
+const public = path.join(__dirname, 'public');
+fs.rmSync(public, { recursive: true, force: true });
+fs.mkdirSync(public);
+fs.writeFileSync(path.join(public, 'index.txt'), `Hello, world`);

packages/cli/test/fixtures/unit/commands/build/monorepo-detection/nx-project-and-package-config-2/build.js

@@ -0,0 +1,7 @@
+const path = require('node:path');
+const fs = require('node:fs');
+
+const public = path.join(__dirname, 'public');
+fs.rmSync(public, { recursive: true, force: true });
+fs.mkdirSync(public);
+fs.writeFileSync(path.join(public, 'index.txt'), `Hello, world`);

packages/cli/test/fixtures/unit/commands/build/monorepo-detection/nx-project-config/build.js

@@ -0,0 +1,7 @@
+const path = require('node:path');
+const fs = require('node:fs');
+
+const public = path.join(__dirname, 'public');
+fs.rmSync(public, { recursive: true, force: true });
+fs.mkdirSync(public);
+fs.writeFileSync(path.join(public, 'index.txt'), `Hello, world`);

packages/cli/test/fixtures/unit/commands/build/monorepo-detection/nx/build.js

@@ -0,0 +1,7 @@
+const path = require('node:path');
+const fs = require('node:fs');
+
+const public = path.join(__dirname, 'public');
+fs.rmSync(public, { recursive: true, force: true });
+fs.mkdirSync(public);
+fs.writeFileSync(path.join(public, 'index.txt'), `Hello, world`);

packages/cli/test/fixtures/unit/commands/build/monorepo-detection/turbo/build.js

@@ -0,0 +1,7 @@
+const path = require('node:path');
+const fs = require('node:fs');
+
+const public = path.join(__dirname, 'public');
+fs.rmSync(public, { recursive: true, force: true });
+fs.mkdirSync(public);
+fs.writeFileSync(path.join(public, 'index.txt'), `Hello, world`);

packages/cli/test/fixtures/unit/commands/build/monorepo-detection/turbo/turbo.json

@@ -1 +1,2 @@
+// TEST COMMENT TO VERIFY JSON5 SUPPORT
 { "pipeline": { "build": { "dependsOn": ["^build"], "outputs": ["dist/**"] } } }