Merge pull request #941 from chromaui/todd/ap-4260-cli-prompts-user-t…

…o-install-wrong-chromatic-command

Do not prompt to install chromatic script during E2E builds

node-src/index.test.ts

@@ -12,6 +12,7 @@ import { DNSResolveAgent } from './io/getDNSResolveAgent';
 import getEnv from './lib/getEnv';
 import parseArgs from './lib/parseArgs';
 import TestLogger from './lib/testLogger';
+import * as checkPackageJson from './lib/checkPackageJson';
 import { uploadFiles } from './lib/uploadFiles';
 import { writeChromaticDiagnostics } from './lib/writeChromaticDiagnostics';
 import { Context } from './types';
@@ -41,8 +42,9 @@ vi.mock('execa');
 // NOTE: we'd prefer to mock the require.resolve() of `@chromatic-com/playwright/..` but
 // vitest doesn't allow you to do that.
 const mockedBuildCommand = 'mocked build command';
-vi.mock('./lib/getE2eBuildCommand', () => ({
-  getE2eBuildCommand: () => mockedBuildCommand,
+vi.mock('./lib/e2e', async (importOriginal) => ({
+  ...await importOriginal(),
+  getE2EBuildCommand: () => mockedBuildCommand,
 }));
 
 const execaCommand = vi.mocked(execaDefault);
@@ -711,6 +713,14 @@ it('prompts you to add a script to your package.json', async () => {
   expect(confirm).toHaveBeenCalled();
 });
 
+it('does not propmpt you to add a script to your package.json for E2E builds', async () => {
+  const ctx = getContext(['--project-token=asdf1234', '--playwright']);
+  await runAll(ctx);
+  const spy = vi.spyOn(checkPackageJson, 'default');
+  expect(spy).not.toHaveBeenCalled();
+  expect(confirm).not.toHaveBeenCalled();
+});
+
 it('ctx should be JSON serializable', async () => {
   const ctx = getContext(['--project-token=asdf1234']);
   expect(() => writeChromaticDiagnostics(ctx)).not.toThrow();

node-src/index.ts

@@ -39,6 +39,7 @@ import noPackageJson from './ui/messages/errors/noPackageJson';
 import runtimeError from './ui/messages/errors/runtimeError';
 import taskError from './ui/messages/errors/taskError';
 import intro from './ui/messages/info/intro';
+import { isE2EBuild } from './lib/e2e';
 
 /**
  Make keys of `T` outside of `R` optional.
@@ -176,7 +177,7 @@ export async function runAll(ctx: InitialContext) {
   // Run these in parallel; neither should ever reject
   await Promise.all([runBuild(ctx), checkForUpdates(ctx)]).catch(onError);
 
-  if ([0, 1].includes(ctx.exitCode)) {
+  if (!isE2EBuild(ctx.options) && [0, 1].includes(ctx.exitCode)) {
     await checkPackageJson(ctx);
   }
 

node-src/lib/getE2eBuildCommand.ts → node-src/lib/e2e.ts

@@ -1,6 +1,6 @@
 import { getCliCommand, Runner, AGENTS } from '@antfu/ni';
 
-import { Context } from '../types';
+import { Context, Options } from '../types';
 import missingDependency from '../ui/messages/errors/missingDependency';
 import { exitCodes, setExitCode } from './setExitCode';
 import { failed } from '../ui/tasks/build';
@@ -27,7 +27,7 @@ const parseNexec = <Runner>((agent, args) => {
   return command.replace('{0}', args.map(quote).join(' ')).trim();
 });
 
-export async function getE2eBuildCommand(
+export async function getE2EBuildCommand(
   ctx: Context,
   flag: 'playwright' | 'cypress',
   buildCommandOptions: string[]
@@ -59,3 +59,7 @@ export async function getE2eBuildCommand(
     throw err;
   }
 }
+
+export function isE2EBuild(options: Options) {
+  return options.playwright || options.cypress;
+}

node-src/lib/getOptions.ts

@@ -14,6 +14,7 @@ import missingBuildScriptName from '../ui/messages/errors/missingBuildScriptName
 import missingProjectToken from '../ui/messages/errors/missingProjectToken';
 import deprecatedOption from '../ui/messages/warnings/deprecatedOption';
 import invalidPackageJson from '../ui/messages/errors/invalidPackageJson';
+import { isE2EBuild } from './e2e';
 
 const takeLast = (input: string | string[]) =>
   Array.isArray(input) ? input[input.length - 1] : input;
@@ -263,7 +264,7 @@ export default function getOptions({
     return options;
   }
 
-  if (options.playwright || options.cypress) {
+  if (isE2EBuild(options)) {
     return options;
   }
 

node-src/tasks/build.ts

@@ -11,7 +11,7 @@ import { endActivity, startActivity } from '../ui/components/activity';
 import buildFailed from '../ui/messages/errors/buildFailed';
 import { failed, initial, pending, skipped, success } from '../ui/tasks/build';
 import { getPackageManagerRunCommand } from '../lib/getPackageManager';
-import { buildBinName as e2EbuildBinName, getE2eBuildCommand } from '../lib/getE2eBuildCommand';
+import { buildBinName as e2EbuildBinName, getE2EBuildCommand, isE2EBuild } from '../lib/e2e';
 import missingDependency from '../ui/messages/errors/missingDependency';
 
 export const setSourceDir = async (ctx: Context) => {
@@ -43,8 +43,8 @@ export const setBuildCommand = async (ctx: Context) => {
     ctx.git.changedFiles && webpackStatsSupported && ctx.sourceDir,
   ].filter(Boolean);
 
-  if (ctx.options.playwright || ctx.options.cypress) {
-    ctx.buildCommand = await getE2eBuildCommand(
+  if (isE2EBuild(ctx.options)) {
+    ctx.buildCommand = await getE2EBuildCommand(
       ctx,
       ctx.options.playwright ? 'playwright' : 'cypress',
       buildCommandOptions
@@ -88,7 +88,7 @@ export const buildStorybook = async (ctx: Context) => {
     // installed the right dependency or run from the right directory
     if (
       ctx.options.inAction &&
-      (ctx.options.playwright || ctx.options.cypress) &&
+      (isE2EBuild(ctx.options)) &&
       e.message.match(e2EbuildBinName)
     ) {
       const flag = ctx.options.playwright ? 'playwright' : 'cypress';