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

Core: Fix path separator issue in check-addon-order #26362

Merged

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Mar 7, 2024

Closes #25969

What I did

The checkAddonOrder functionality wasn't covering operating systems, where the path separator is a backslash (\) instead of a forward slash.

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 React Vite sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Install the addon-interactions
  3. Paste this main.js into yours:
import type { StorybookConfig } from '@storybook/react-vite'
import { resolve } from 'node:path'
import { dirname, join } from 'path'
import { mergeConfig } from 'vite'

const config: StorybookConfig = {
  stories: ['../stories/**/*.mdx', '../stories/**/*.stories.@(ts|tsx)'],
  staticDirs: ['../public'],
  core: {
    disableTelemetry: true,
  },
  addons: [
    getAbsolutePath('@storybook/addon-links'),
    getAbsolutePath('@storybook/addon-essentials'),
    getAbsolutePath('@storybook/addon-interactions'),
    getAbsolutePath('@storybook/addon-a11y'),
  ],
  framework: {
    name: getAbsolutePath('@storybook/react-vite'),
    options: {},
  },
  docs: {
    autodocs: true,
  },
  async viteFinal(config) {
    return mergeConfig(config, {
      resolve: {
        alias: [
          {
            find: 'stories',
            replacement: resolve(__dirname, '../stories'),
          },
        ],
      },
    })
  },
}

export default config

function getAbsolutePath(value: string): any {
  return dirname(require.resolve(join(value, 'package.json')))
}
  1. Start Storybook on a Windows machine. The warning
WARN Expected '@storybook/addon-actions' (or '@storybook/addon-essentials') to be listed before '@storybook/addon-interactions' in main Storybook config.

shouldn't appear

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 pull request has been released as version 0.0.0-pr-26362-sha-ec71ddb7. Try it out in a new sandbox by running npx storybook@0.0.0-pr-26362-sha-ec71ddb7 sandbox or in an existing project with npx storybook@0.0.0-pr-26362-sha-ec71ddb7 upgrade.

More information
Published version 0.0.0-pr-26362-sha-ec71ddb7
Triggered by @valentinpalkovic
Repository storybookjs/storybook
Branch valentin/fix-addon-ordering-detection-on-windows
Commit ec71ddb7
Datetime Thu Mar 7 08:50:26 UTC 2024 (1709801426)
Workflow run 8185350081

To request a new release of this pull request, mention the @storybookjs/core team.

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

@valentinpalkovic valentinpalkovic force-pushed the valentin/fix-addon-ordering-detection-on-windows branch from ec71ddb to 5ca2466 Compare March 7, 2024 08:51
Copy link

nx-cloud bot commented Mar 7, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5ca2466. 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

Sent with 💌 from NxCloud.

Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@valentinpalkovic valentinpalkovic merged commit 1e29df2 into next Mar 7, 2024
53 of 56 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-addon-ordering-detection-on-windows branch March 7, 2024 09:14
@github-actions github-actions bot mentioned this pull request Mar 7, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants