AlaskaAirlines / auro-badge

Custom element to illustrate status, show count, convey selections
https://auro.alaskaair.com/components/auro/badge
Apache License 2.0
0 stars 2 forks source link

Beta tech debt #111

Closed jordanjones243 closed 1 month ago

jordanjones243 commented 1 month ago

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: # (issue, if applicable)

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

Type of change:

Please delete options that are not relevant.

Checklist:

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

Refactor the component registration process to utilize AuroLibraryRuntimeUtils for improved tag handling and update related documentation and demo files accordingly. Remove obsolete scripts to clean up the codebase.

Enhancements:

Documentation:

Chores:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request focuses on refactoring the AuroBadge component to use a new AuroLibraryRuntimeUtils class for handling custom tag names and component registration. It also updates dependencies and removes some unused scripts.

Sequence Diagram

sequenceDiagram
    participant App
    participant RuntimeUtils
    participant AuroBadge
    participant CustomElements
    App->>RuntimeUtils: registerComponent('custom-badge', AuroBadge)
    RuntimeUtils->>CustomElements: define('custom-badge', AuroBadge)
    CustomElements-->>RuntimeUtils: Component registered
    RuntimeUtils-->>App: Registration complete

File-Level Changes

Change Details Files
Refactored custom tag name handling and component registration
  • Introduced AuroLibraryRuntimeUtils class for handling runtime operations
  • Replaced custom handleCustomTagName method with runtimeUtils.handleComponentTagRename
  • Updated component registration process to use RuntimeUtils.registerComponent
  • Removed registerComponent function from index.js
src/auro-badge.js
index.js
demo/index.html
demo/index.md
docs/partials/index.md
Updated dependencies and version numbers
  • Updated design-tokens version to 4.9.2
  • Updated webcorestylesheets version to 5.1.2
  • Removed buttonVersion.js and iconVersion.js files
README.md
src/buttonVersion.js
src/iconVersion.js
Modified styling variables
  • Updated --ds-auro-badge-container-color variable value
demo/api.md
Removed unused scripts
  • Deleted generateDocs.mjs
  • Deleted staticStyles-template.js
scripts/generateDocs.mjs
scripts/staticStyles-template.js

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. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) 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 - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourceryai/) or [GitHub](https://github.com/sourcery-ai).
blackfalcon commented 1 month ago

:tada: This PR is included in version 3.0.0-beta.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket: