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

Fix : Update meta title error handling #26911

Open
wants to merge 8 commits into
base: next
Choose a base branch
from

Conversation

sossost
Copy link

@sossost sossost commented Apr 22, 2024

Closes #26642

What I did

The error message that appears when the story file title ends with '/' has been appropriately modified.

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

Tested in sandbox.

Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
Open Storybook in your browser
Create a story file whose title ends with /.
Check if an appropriate error message such as is displayed. 'Invalid title Example/�Component/ ending in slash.'

image

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>

@sossost sossost changed the title Fix error message handling final slash in title Fix : update error message handling final slash in title Apr 22, 2024
@yannbf yannbf changed the title Fix : update error message handling final slash in title Fix : Update meta title error handling Apr 29, 2024
@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch ci:normal labels Apr 29, 2024
Copy link

nx-cloud bot commented May 2, 2024

☁️ Nx Cloud Report

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

@ndelangen
Copy link
Member

@JReinhold does this look OK to you?

@JReinhold
Copy link
Contributor

The current error message highlights that this happens if slash is anywhere in the name, not just at the end. If that's still the case, then the proposed error message here is too misleading.

@sossost
Copy link
Author

sossost commented May 4, 2024

@JReinhold
Added error message branching.
Now, when the title ends with '/', the corresponding message is displayed
and if it is mixed in the middle of the title,
'Error: Invalid part '>', leading to id === parentId ('example-button-vue-docs'), inside title 'Example /Button/Vue <docs "/">'
It looks like this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: accidentally ending a title with a / breaks storybook
5 participants