Merge pull request #22972 from storybookjs/feat/addon-onboarding

React: Add addon-onboarding as part of init
storybookjs · Jun 22, 2023 · dd7032b · dd7032b
2 parents 3687785 + 90b779e
commit dd7032b
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 4 deletions.
diff --git a/code/lib/cli/src/generators/NEXTJS/index.ts b/code/lib/cli/src/generators/NEXTJS/index.ts
@@ -2,7 +2,16 @@ import { baseGenerator } from '../baseGenerator';
 import type { Generator } from '../types';
 
 const generator: Generator = async (packageManager, npmOptions, options) => {
-  await baseGenerator(packageManager, npmOptions, options, 'react', undefined, 'nextjs');
+  await baseGenerator(
+    packageManager,
+    npmOptions,
+    options,
+    'react',
+    {
+      extraAddons: ['@storybook/addon-onboarding'],
+    },
+    'nextjs'
+  );
 };
 
 export default generator;
diff --git a/code/lib/cli/src/generators/REACT/index.ts b/code/lib/cli/src/generators/REACT/index.ts
@@ -10,6 +10,7 @@ const generator: Generator = async (packageManager, npmOptions, options) => {
 
   await baseGenerator(packageManager, npmOptions, options, 'react', {
     extraPackages,
+    extraAddons: ['@storybook/addon-onboarding'],
   });
 };
 

diff --git a/code/lib/cli/src/generators/REACT_SCRIPTS/index.ts b/code/lib/cli/src/generators/REACT_SCRIPTS/index.ts
@@ -39,7 +39,10 @@ const generator: Generator = async (packageManager, npmOptions, options) => {
   }
 
   const version = versions['@storybook/preset-create-react-app'];
-  const extraAddons = [`@storybook/preset-create-react-app@${version}`];
+  const extraAddons = [
+    `@storybook/preset-create-react-app@${version}`,
+    '@storybook/addon-onboarding',
+  ];
 
   if (!isCra5OrHigher) {
     throw new Error(dedent`

diff --git a/code/lib/cli/src/generators/WEBPACK_REACT/index.ts b/code/lib/cli/src/generators/WEBPACK_REACT/index.ts
@@ -2,7 +2,9 @@ import { baseGenerator } from '../baseGenerator';
 import type { Generator } from '../types';
 
 const generator: Generator = async (packageManager, npmOptions, options) => {
-  await baseGenerator(packageManager, npmOptions, options, 'react');
+  await baseGenerator(packageManager, npmOptions, options, 'react', {
+    extraAddons: ['@storybook/addon-onboarding'],
+  });
 };
 
 export default generator;
diff --git a/code/lib/cli/src/initiate.ts b/code/lib/cli/src/initiate.ts
@@ -348,12 +348,32 @@ async function doInitiate(options: CommandOptions, pkg: PackageJson): Promise<vo
       logger.log('\nRunning Storybook');
 
       try {
+        const isReactWebProject =
+          projectType === ProjectType.REACT_SCRIPTS ||
+          projectType === ProjectType.REACT ||
+          projectType === ProjectType.WEBPACK_REACT ||
+          projectType === ProjectType.REACT_PROJECT ||
+          projectType === ProjectType.NEXTJS;
+
+        const flags = [];
+
+        // npm needs extra -- to pass flags to the command
+        if (packageManager.type === 'npm') {
+          flags.push('--');
+        }
+
+        if (isReactWebProject) {
+          flags.push('--initial-path=/onboarding');
+        }
+
+        flags.push('--quiet');
+
         // instead of calling 'dev' automatically, we spawn a subprocess so that it gets
         // executed directly in the user's project directory. This avoid potential issues
         // with packages running in npxs' node_modules
         packageManager.runPackageCommandSync(
           storybookCommand.replace(/^yarn /, ''),
-          ['--quiet'],
+          flags,
           undefined,
           'inherit'
         );

diff --git a/scripts/verdaccio.yaml b/scripts/verdaccio.yaml
@@ -75,6 +75,10 @@ packages:
     access: $all
     publish: $all
     proxy: npmjs
+  '@storybook/addon-onboarding':
+    access: $all
+    publish: $all
+    proxy: npmjs
   '@storybook/mdx1-csf':
     access: $all
     publish: $all
-Original file line number
+Diff line change
@@ Expand Up @@
       await baseGenerator(packageManager, npmOptions, options, 'react', {
         extraPackages,
+        extraAddons: ['@storybook/addon-onboarding'],
       });
     };
@@ Expand Down @@