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

perf: replace mark package with simple regex and replace #226 #227

Merged
merged 3 commits into from
Nov 5, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Nov 5, 2024

Alaska Airlines Pull Request

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Improve performance by replacing the 'mark.js' package with a regex-based solution for text highlighting in the 'auro-menu' component and update dependencies.

Enhancements:

  • Replace the 'mark.js' package with a simple regex-based solution for highlighting text matches in the 'auro-menu' component.

Build:

  • Update the '@alaskaairux/icons' dependency to version 4.44.1 and remove the 'mark.js' dependency from the project.

@rmenner rmenner self-assigned this Nov 5, 2024
@rmenner rmenner requested a review from a team as a code owner November 5, 2024 02:46
Copy link

sourcery-ai bot commented Nov 5, 2024

Reviewer's Guide by Sourcery

This PR replaces the mark.js package with a custom regex-based solution for highlighting matched text in the auro-menu component. The implementation uses a simple regular expression to find and wrap matched text with <strong> tags, improving performance by removing the external dependency.

Class diagram for AuroMenu changes

classDiagram
    class AuroMenu {
        +AuroLibraryRuntimeUtils runtimeUtils
        +String nestingSpacer
        +markOptions()
    }
    note for AuroMenu "Replaced mark.js with regex-based solution in markOptions method"
Loading

File-Level Changes

Change Details Files
Implemented regex-based text highlighting to replace mark.js package
  • Added regex pattern creation with escaped special characters
  • Implemented direct string replacement using regex to wrap matched text in tags
  • Preserved nested menu spacing during text highlighting
  • Removed mark.js initialization and configuration code
src/auro-menu.js
Updated package dependencies
  • Removed mark.js dependency
  • Updated @alaskaairux/icons from ^4.43.0 to ^4.44.1
package.json
Enhanced menu example documentation
  • Added more comprehensive menu examples with nested structures
  • Added horizontal rule separators between menu sections
  • Expanded the menu options to include more categories
demo/api.md
apiExamples/matchWord.html

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@rmenner rmenner linked an issue Nov 5, 2024 that may be closed by this pull request
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @rmenner - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding test coverage for the new regex-based highlighting implementation to verify it handles all edge cases correctly (e.g. special characters, multi-byte Unicode)
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

src/auro-menu.js Outdated Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Outdated Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Outdated Show resolved Hide resolved
src/auro-menu.js Outdated Show resolved Hide resolved
@rmenner
Copy link
Contributor Author

rmenner commented Nov 5, 2024

@sourcery-ai review

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @rmenner - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

demo/api.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
@jason-capsule42 jason-capsule42 merged commit f0f7bd8 into main Nov 5, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the rmenner/ssr/replace-mark-package branch November 5, 2024 18:46
@blackfalcon
Copy link
Member

🎉 This PR is included in version 4.1.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

auro-menu: ssr support
3 participants