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

feat(api): add register static method #145

Merged
merged 5 commits into from
Oct 24, 2024
Merged

Conversation

sun-mota
Copy link
Contributor

@sun-mota sun-mota commented Oct 16, 2024

Same chages applied to AuroRadioGroup

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: #144

Summary:

AuroRadio.register is to easily register the element without extra importing
import "@aurodesignsystem/auro-radio" will still register this element to <auro-radio>
import { AuroRadio.register } from '../src/auro-radio will NOT register this element until AuroRadio.register gets called

Same changes applied to AuroRadioGroup

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

Add a static register method to AuroRadio and AuroRadioGroup for manual element registration, update build configuration for demo files, and revise documentation to explain the new registration process.

New Features:

  • Introduce a static register method for AuroRadio and AuroRadioGroup to allow manual registration of custom elements.

Enhancements:

  • Remove automatic registration of AuroRadio and AuroRadioGroup elements to provide more control over element registration.

Build:

  • Add a new Rollup configuration for building demo index files.

Documentation:

  • Update documentation to reflect the new static register method for AuroRadio and AuroRadioGroup, clarifying the manual registration process.

@sun-mota sun-mota self-assigned this Oct 16, 2024
@sun-mota sun-mota linked an issue Oct 16, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Oct 16, 2024

Surge demo deployment failed! 😭

@sun-mota sun-mota marked this pull request as ready for review October 16, 2024 23:34
Copy link

sourcery-ai bot commented Oct 16, 2024

Reviewer's Guide by Sourcery

This pull request adds a static register method to both AuroRadio and AuroRadioGroup classes, allowing for easier and more flexible component registration. It also updates the documentation and demo files to reflect these changes, and modifies the build configuration.

Updated class diagram for AuroRadio and AuroRadioGroup

classDiagram
    class AuroRadio {
        +static register(name="auro-radio")
        ...
    }
    class AuroRadioGroup {
        +static register(name="auro-radio-group")
        ...
    }
    note for AuroRadio "Added static register method"
    note for AuroRadioGroup "Added static register method"
Loading

File-Level Changes

Change Details Files
Added static register method to AuroRadio and AuroRadioGroup classes
  • Implemented register method in both classes
  • Method allows custom element name registration
  • Removed automatic component registration at the end of each class file
src/auro-radio.js
src/auro-radio-group.js
Updated documentation to reflect new registration process
  • Changed instructions from using registerComponent to using static register method
  • Updated example code snippets
  • Clarified that AuroRadio.register does not automatically register AuroRadioGroup
demo/index.md
docs/partials/index.md
Modified build configuration and demo setup
  • Added indexExamplesConfig to rollup configuration
  • Updated demo/index.html to use new bundled script
  • Removed inline script for component registration in demo/index.html
rollup.config.mjs
demo/index.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

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 @sun-mota - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider refactoring the register method implementation to avoid using AuroLibraryRuntimeUtils.prototype.registerComponent. This mixing of old and new approaches could lead to maintenance issues. A more direct registration method would be preferable.
  • Enhance the documentation to more clearly explain the differences between the old registerComponent approach and the new register method. Emphasize that AuroRadio.register() and AuroRadioGroup.register() need to be called separately, unlike the previous method.
  • Consider adding a deprecation notice for the old registerComponent method and provide migration guidelines to help users transition to the new register method smoothly.
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: 1 issue found

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/index.md Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
AuroRadio.register is to easily register the element without extra importing
`import "@aurodesignsystem/auro-radio"` will still register this element to <auro-radio>
`import { AuroRadio } from '../src/auro-radio.js` wont register this element until AuroRadio.register gets called

Same chages applied to AuroRadioGroup
@sun-mota sun-mota force-pushed the sunMota/feat/easierRegistry/144 branch from e56e8dc to 096d82d Compare October 21, 2024 17:31
Copy link
Member

@jason-capsule42 jason-capsule42 left a comment

Choose a reason for hiding this comment

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

Localhost isn't running for me.

@sun-mota sun-mota merged commit 76d236a into main Oct 24, 2024
6 of 7 checks passed
@sun-mota sun-mota deleted the sunMota/feat/easierRegistry/144 branch October 24, 2024 19:21
@blackfalcon
Copy link
Member

🎉 This PR is included in version 4.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Oct 24, 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-radio: Update component registration logic
3 participants