Merge branch 'main' into update/vc-dev-repo-root2

vercel · Jul 19, 2023 · f2351a8 · f2351a8
2 parents ba5fb64 + ce4633f
commit f2351a8
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 5 deletions.
diff --git a/.changeset/sixty-buttons-listen.md b/.changeset/sixty-buttons-listen.md
@@ -0,0 +1,8 @@
+---
+'@vercel/frameworks': minor
+'@vercel/static-build': patch
+---
+
+Add `ignorePackageJsonScript` configuration for Framework command settings to ignore the `package.json` script.
+
+Enable this mode for Storybook's `buildCommand`, since it should not invoke the "build" script, which is most likely designated for the frontend app build.
diff --git a/...ages/cli/test/fixtures/unit/commands/build/storybook-with-middleware/.vercel/project.json b/...ages/cli/test/fixtures/unit/commands/build/storybook-with-middleware/.vercel/project.json
@@ -2,8 +2,6 @@
   "orgId": ".",
   "projectId": ".",
   "settings": {
-    "framework": "storybook",
-    "buildCommand": "npm run build-storybook",
-    "outputDirectory": "storybook-static"
+    "framework": "storybook"
   }
 }
diff --git a/packages/frameworks/src/frameworks.ts b/packages/frameworks/src/frameworks.ts
@@ -1955,6 +1955,7 @@ export const frameworks = [
       },
       buildCommand: {
         value: 'storybook build',
+        ignorePackageJsonScript: true,
       },
       devCommand: {
         value: `storybook dev -p $PORT`,

diff --git a/packages/frameworks/src/types.ts b/packages/frameworks/src/types.ts
@@ -32,11 +32,24 @@ export interface SettingPlaceholder {
 
 export interface SettingValue {
   /**
-   * A predefined setting for the detected framework
+   * A predefined setting for the detected framework.
    * @example "next dev --port $PORT"
    */
   value: string | null;
+  /**
+   * Placeholder text that may be shown in the UI when
+   * the user is configuring this setting value.
+   * @example "`npm run build` or `next build`"
+   */
   placeholder?: string;
+  /**
+   * When set to `true`, then the builder will not
+   * invoke the equivalent script in `package.json`,
+   * and instead will invoke the command specified in
+   * configuration setting directly. When this
+   * configuration is enabled, `value` must be a string.
+   */
+  ignorePackageJsonScript?: boolean;
 }
 
 export type Setting = SettingValue | SettingPlaceholder;

diff --git a/packages/frameworks/test/frameworks.unit.test.ts b/packages/frameworks/test/frameworks.unit.test.ts
@@ -49,6 +49,22 @@ const SchemaSettings = {
         },
       },
     },
+    {
+      type: 'object',
+      required: ['value', 'ignorePackageJsonScript'],
+      additionalProperties: false,
+      properties: {
+        value: {
+          type: 'string',
+        },
+        placeholder: {
+          type: 'string',
+        },
+        ignorePackageJsonScript: {
+          type: 'boolean',
+        },
+      },
+    },
     {
       type: 'object',
       required: ['placeholder'],

diff --git a/packages/static-build/src/index.ts b/packages/static-build/src/index.ts
@@ -137,7 +137,11 @@ function getCommand(
     return propValue;
   }
 
-  if (pkg) {
+  const ignorePackageJsonScript =
+    name === 'build' &&
+    framework?.settings.buildCommand.ignorePackageJsonScript;
+
+  if (pkg && !ignorePackageJsonScript) {
     const scriptName = getScriptName(pkg, name, config);
 
     if (hasScript(scriptName, pkg)) {