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 angular accent character issue #30114

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

Conversation

msmx-mnakagawa
Copy link

@msmx-mnakagawa msmx-mnakagawa commented Dec 20, 2024

Closes #29132

What I did

Just filtered accent characters from a story UID, as suggested at #29132 (comment).
The method defined in this PR could convert Example/Button with an "é" accent into Example/Button with an "e" accent.

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!

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-storybook/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>

Greptile Summary

I'll provide a concise summary of the changes in this PR focusing on the Angular accent character fix:

Added normalization of accented characters in Angular component selectors to prevent NG05104 errors when using accented characters in story titles.

  • Added generateStoryUIdFromRawStoryUid method in code/frameworks/angular/src/client/angular-beta/AbstractRenderer.ts to handle accent normalization
  • Implemented Unicode normalization (NFD) to decompose and remove diacritical marks from story UIDs
  • Fixes issue [Bug]: Accent in Meta's title break the doc page #29132 where accented characters in Meta titles were breaking doc pages
  • Maintains consistent selector generation pattern alongside existing generateTargetSelectorFromStoryId method

The changes are focused and minimal, addressing a specific issue with accented characters in Angular component selectors while following established patterns in the codebase.

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines +165 to +166
const accentCharacters = /[\u0300-\u036f]/g;
return rawStoryUid.normalize('NFD').replace(accentCharacters, '');
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider using a more comprehensive Unicode range to handle other types of diacritical marks and special characters that could cause similar issues

Comment on lines +161 to +163
if (rawStoryUid === null) {
return rawStoryUid;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider adding a trim() call to handle potential whitespace issues that could affect selectors

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Accent in Meta's title break the doc page
1 participant