Merge pull request #4472 from bartvandenende-wm/bartvandenende-wm/sto…

…rybook-improvements

[heft-storybook-plugin] Add support for storybook 7, HMR and provide new plugin configuration options

.gitignore

@@ -31,7 +31,7 @@ bower_components
 build/Release
 
 # Dependency directories
-node_modules/
+node_modules
 jspm_packages/
 
 # Optional npm cache directory

README.md

@@ -123,6 +123,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/build-tests-samples/heft-node-rig-tutorial](./build-tests-samples/heft-node-rig-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
 | [/build-tests-samples/heft-serverless-stack-tutorial](./build-tests-samples/heft-serverless-stack-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
 | [/build-tests-samples/heft-storybook-react-tutorial](./build-tests-samples/heft-storybook-react-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
+| [/build-tests-samples/heft-storybook-react-tutorial-app](./build-tests-samples/heft-storybook-react-tutorial-app/) | Building this project is a regression test for heft-storybook-plugin |
 | [/build-tests-samples/heft-storybook-react-tutorial-storykit](./build-tests-samples/heft-storybook-react-tutorial-storykit/) | Storybook build dependencies for heft-storybook-react-tutorial |
 | [/build-tests-samples/heft-web-rig-app-tutorial](./build-tests-samples/heft-web-rig-app-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
 | [/build-tests-samples/heft-web-rig-library-tutorial](./build-tests-samples/heft-web-rig-library-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |

build-tests-samples/heft-storybook-react-tutorial-app/README.md

@@ -0,0 +1,4 @@
+# heft-storybook-react-tutorial-app
+
+This is project builds the storybook exports from the
+[heft-storybook-react-tutorial](https://github.com/microsoft/rushstack-samples/tree/main/heft/heft-storybook-react-tutorial) and is a regression test for the heft-storybook-plugin `cwdPackageName` option.

build-tests-samples/heft-storybook-react-tutorial-app/config/heft.json

@@ -0,0 +1,25 @@
+/**
+ * Defines configuration used by core Heft.
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json",
+
+  "phasesByName": {
+    "build": {
+      "tasksByName": {
+        "storybook": {
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft-storybook-plugin",
+            "options": {
+              "storykitPackageName": "heft-storybook-react-tutorial-storykit",
+              "cliPackageName": "@storybook/react",
+              "cliCallingConvention": "storybook6",
+              "staticBuildOutputFolder": "dist",
+              "cwdPackageName": "heft-storybook-react-tutorial"
+            }
+          }
+        }
+      }
+    }
+  }
+}

build-tests-samples/heft-storybook-react-tutorial-app/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "heft-storybook-react-tutorial-app",
+  "description": "Building this project is a regression test for heft-storybook-plugin",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "build": "heft build --clean --storybook",
+    "_phase:build": "heft run --only build -- --clean",
+    "_phase:test": ""
+  },
+  "dependencies": {
+    "heft-storybook-react-tutorial": "workspace: *"
+  },
+  "devDependencies": {
+    "@rushstack/heft-storybook-plugin": "workspace:*",
+    "@rushstack/heft": "workspace:*",
+    "heft-storybook-react-tutorial-storykit": "workspace:*"
+  }
+}

build-tests-samples/heft-storybook-react-tutorial/config/heft.json

@@ -33,8 +33,8 @@
             "pluginPackage": "@rushstack/heft-storybook-plugin",
             "options": {
               "storykitPackageName": "heft-storybook-react-tutorial-storykit",
-              "startupModulePath": "@storybook/react/bin/index.js",
-              "staticBuildModulePath": "@storybook/react/bin/build.js",
+              "cliPackageName": "@storybook/react",
+              "cliCallingConvention": "storybook6",
               "staticBuildOutputFolder": "dist-storybook"
             }
           }

build-tests-samples/heft-storybook-react-tutorial/package.json

@@ -4,11 +4,11 @@
   "version": "1.0.0",
   "private": true,
   "scripts": {
-    "build": "heft build --clean --storybook",
+    "build": "heft build --clean",
     "start": "heft build-watch",
-    "storybook": "heft build-watch --storybook",
+    "storybook": "heft build-watch --serve --storybook",
     "build-storybook": "heft build --storybook",
-    "_phase:build": "heft run --only build -- --clean",
+    "_phase:build": "heft run --only build -- --clean --storybook",
     "_phase:test": "heft run --only test -- --clean"
   },
   "dependencies": {

common/changes/@rushstack/heft-storybook-plugin/bartvandenende-wm-storybook-improvements_2024-01-03-11-53.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-storybook-plugin",
+      "comment": "Add support for storybook 7, HMR, and breaking chages in the plugin configuration option. The \"startupModulePath\" and \"staticBuildModulePath\" have been removed in favour of \"cliCallingConvention\" and \"cliPackageName\". A new 'cwdPackageName' option provides the ability to set an alternative dependency name as (cwd) target for the storybook commands." ,
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft-storybook-plugin"
+}

common/changes/@rushstack/node-core-library/bartvandenende-wm-storybook-improvements_2024-01-22-13-23.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/node-core-library",
+      "comment": "Improve 'bin' definition in `IPackageJson` type",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@rushstack/node-core-library"
+}