Controls: Added server channel to create a new story

[valentinpalkovic]

Closes #26658

What I did

This PR registers a server channel backend side to listen to 'create-new-storyfile' events for creating new story files. The payload for the creation looks like this:

interface Payload {
  // The filepath of the component for which the Story should be generated for (relative to the project root)
  filepath: string;
  // The name of the exported component
  componentExportName: string;
  // is default export
  default: boolean;
}

As soon as the new story file is created the result event 'create-new-storyfile-result' is emitted with the following payload:

interface Result {
  success: true | false;
  result: null | {
    storyId: string;
  };
  error: null | string;
}

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
2. Change src/stories/Button.stories.ts and adjust the meta section like this:

import type { Meta, StoryObj } from '@storybook/react';
import { Button } from './Button';
import { addons } from '@storybook/preview-api';

const channel = addons.getChannel();

// More on how to set up stories at: https://storybook.js.org/docs/writing-stories#default-export
const meta = {
  title: 'Example/Button',
  component: Button,
  parameters: {
    // Optional parameter to center the component in the Canvas. More info: https://storybook.js.org/docs/configure/story-layout
    layout: 'centered',
  },
  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/writing-docs/autodocs
  tags: ['autodocs'],
  // More on argTypes: https://storybook.js.org/docs/api/argtypes
  argTypes: {
    backgroundColor: { control: 'color' },
  },
  // Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked: https://storybook.js.org/docs/essentials/actions#action-args
  args: { onClick: () => {
    channel.emit('create-new-storyfile', {
      filepath: 'sandbox/ButtonExample.ts',
      // The name of the exported component
      componentExportName: 'ButtonExample',
      // is default export
      default: false
    })
  } },
} satisfies Meta<typeof Button>;

3. Click the button and see whether it triggers an event, the result event is sent to the browser and whether sandbox/ButtonExample gets created.

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 154a302. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 1 target

• nx run-many -t build -c production --parallel=3

---

Sent with 💌 from NxCloud.

[ghengeveld]

Missing a newline at end-of-file.

[valentinpalkovic]

This also falls into the (opinionated) formatting preferences of the user. As elaborated earlier, we don't have a proper solution in place to format the file by using the user's formatter and formatting rules.

[ghengeveld]

I still don't like the generic Component name for default imports, but otherwise this looks good.

[ghengeveld]

Oh, I thought componentExportName would be the file's base name if there is no named export. That's what the test above suggested. Either way, can we use the file's base name (converted to PascalCase) rather than Component?