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

Refactor use of oneworld attribute #49

Merged
merged 5 commits into from
Jan 24, 2025
Merged

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Jan 24, 2025

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: #44, #48

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.

  • 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

Introduce the variant attribute to the auro-lockup component to specify the lockup variant. Deprecate the oneworld attribute in favor of variant="oneworld".

New Features:

  • Add variant attribute to support different lockup variants.

Tests:

  • Update tests to use the new variant attribute.

@jordanjones243 jordanjones243 self-assigned this Jan 24, 2025
@jordanjones243 jordanjones243 requested a review from a team as a code owner January 24, 2025 19:14
Copy link

sourcery-ai bot commented Jan 24, 2025

Reviewer's Guide by Sourcery

This pull request refactors the oneworld attribute to a variant attribute, which allows for a more flexible approach to adding new variants in the future. The oneworld attribute is now deprecated, but still supported for backwards compatibility.

Class diagram showing changes to AuroLockup component

classDiagram
    class AuroLockup {
        +String path
        +Boolean standard
        -Boolean oneworld (deprecated)
        +String variant
        +constructor()
        +updated()
        -generateIconHtml(svgContent)
        +render()
    }
    note for AuroLockup "oneworld attribute deprecated
replaced by variant attribute"
Loading

State diagram showing oneworld attribute migration

stateDiagram-v2
    [*] --> CheckAttribute
    CheckAttribute --> UseOneworld: oneworld attribute used
    CheckAttribute --> UseVariant: variant attribute used
    UseOneworld --> SetVariant: internally sets
variant='oneworld'
    UseVariant --> RenderLockup
    SetVariant --> RenderLockup
    RenderLockup --> [*]
Loading

File-Level Changes

Change Details Files
Refactor oneworld attribute to variant attribute
  • Added variant attribute to the component.
  • Deprecated the oneworld attribute, but still support it for backwards compatibility.
  • Updated the component to use the variant attribute to determine which logo to display.
src/auro-lockup.js
Update documentation and examples to use the new variant attribute
  • Updated documentation to reflect the new variant attribute.
  • Updated examples to use the new variant attribute instead of the oneworld attribute.
demo/index.md
demo/api.md
docs/api.md
docs/partials/index.md
apiExamples/onDark-2.html
apiExamples/onDark-3.html
apiExamples/oneWorld.html
apiExamples/oneWorldStandard.html
Update test to use the new variant attribute
  • Updated tests to use the new variant attribute instead of the oneworld attribute.
test/auro-lockup.test.js
Update dependencies
  • Updated the dependencies to the latest versions.
  • Updated the README.md to reflect the new version of the design tokens.
package.json
package-lock.json
README.md
Add WCA script
  • Added a new script to generate the WCA documentation.
scripts/wca/auro-lockup.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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@jordanjones243 jordanjones243 linked an issue Jan 24, 2025 that may be closed by this pull request
Copy link

github-actions bot commented Jan 24, 2025

Surge demo deployment failed! 😭

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

Overall Comments:

  • The removal of the accessibility color information table appears unrelated to the oneworld attribute refactoring. Consider moving this change to a separate PR to maintain clear change scope.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues found
  • 🟢 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-lockup.js Show resolved Hide resolved
test/auro-lockup.test.js Show resolved Hide resolved
test/auro-lockup.test.js Show resolved Hide resolved
demo/index.md Outdated Show resolved Hide resolved
@jordanjones243 jordanjones243 force-pushed the jjones/oneworldSvelte/#48 branch from 2868e1c to 6f59be9 Compare January 24, 2025 19:20
@jordanjones243 jordanjones243 merged commit f30acf4 into main Jan 24, 2025
6 of 7 checks passed
@jordanjones243 jordanjones243 deleted the jjones/oneworldSvelte/#48 branch January 24, 2025 19:54
@blackfalcon
Copy link
Member

🎉 This PR is included in version 4.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Jan 24, 2025
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
3 participants