Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SWC: Add settings for react and preact #24805

Merged
merged 3 commits into from
Nov 13, 2023

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Nov 10, 2023

Closes #24763

What I did

Added necessary swc config for React and Preact projects

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!

React:

  1. Run the react-webpack-18-ts sandbox
  2. Go to .storybook/main.ts and enable fast refresh and swc:
framework: {
    name: '@storybook/react-webpack5',
    options: {
      fastRefresh: true,
      builder: {
        useSWC: true,
      }
    },
  },
  1. Check, whether fast refresh works, e.g. adjust Button.tsx component like so:
const mode = primary ? 'storybook-button--primary' : 'storybook-button--secondary';
  const [counter, setCounter] = useState(0);

  useEffect(() => {
    const interval = setInterval(() => {
      setCounter((c) => c + 1);
    }, 1000)

    return () => {
      clearInterval(interval);
    }
  }, [])
  
  return (
    <button
      type="button"
      className={['storybook-button', `storybook-button--${size}`, mode].join(' ')}
      style={{ backgroundColor }}
      {...props}
    >
      {label} {counter}
    </button>
  );

Now change something in the button. The counter shouldn't reset if fast-refresh works appropriately.

Preact:

  1. Create a Preact sandbox (preact-webpack5/default-ts)
  2. Adjust the configuration to enable swc:
framework: {
    name: '@storybook/preact-webpack5',
    options: {
      builder: {
        useSWC: true
      }
    },
  },
  1. Check whether Stories are rendered (Note: Fast refresh for Preact doesn't work, since there isn't an appropriate swc plugin in place)

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>

@valentinpalkovic valentinpalkovic marked this pull request as draft November 10, 2023 14:25
@valentinpalkovic valentinpalkovic self-assigned this Nov 10, 2023
@valentinpalkovic valentinpalkovic changed the title Valentin/add swc settings for react and preact SWC: Add settings for react and preact Nov 10, 2023
@valentinpalkovic valentinpalkovic marked this pull request as ready for review November 10, 2023 14:40
@valentinpalkovic valentinpalkovic force-pushed the valentin/add-swc-settings-for-react-and-preact branch from 225cf51 to 731281e Compare November 10, 2023 15:03
@valentinpalkovic valentinpalkovic merged commit 4278a43 into next Nov 13, 2023
60 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/add-swc-settings-for-react-and-preact branch November 13, 2023 08:01
@github-actions github-actions bot mentioned this pull request Nov 13, 2023
30 tasks
@kasperpeulen kasperpeulen restored the valentin/add-swc-settings-for-react-and-preact branch November 13, 2023 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add export const swc to @storybook/react and @storybook/preact
2 participants