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

Jbaker/handle missing flights #145

Merged
merged 2 commits into from
Jan 28, 2025
Merged

Conversation

jason-capsule42
Copy link
Member

@jason-capsule42 jason-capsule42 commented Jan 28, 2025

Alaska Airlines Pull Request

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

Update auro-flight to handle missing flight numbers.

Bug Fixes:

  • Handle cases where no flight numbers are provided.

Enhancements:

  • Update dependencies.

@jason-capsule42 jason-capsule42 self-assigned this Jan 28, 2025
@jason-capsule42 jason-capsule42 requested a review from a team as a code owner January 28, 2025 21:50
Copy link

sourcery-ai bot commented Jan 28, 2025

Reviewer's Guide by Sourcery

This pull request updates several dependencies, including auro-flightline, auro-library, design-tokens, eslint-config, commitlint, rollup, compression, concurrently, core-js, eslint, eslint-plugin-jsdoc, husky, nodemon, rollup, sass, semantic-release, stylelint, stylelint-config-standard, stylelint-config-standard-scss, stylelint-scss, and typescript. It also modifies the auro-flight-header component to handle cases where there are no flights and updates the documentation to include a default value for the flights property.

Sequence diagram showing updated flight type handling

sequenceDiagram
    participant C as Client
    participant FH as AuroFlightHeader

    C->>FH: Get flight type
    alt no flights (length = 0)
        FH-->>C: return empty string ''
    else single flight
        FH-->>C: return flight number
    else multiple flights
        FH-->>C: return default case
    end
Loading

Class diagram showing changes to AuroFlight and AuroFlightHeader components

classDiagram
    class AuroFlight {
        +Array flights
        +constructor()
    }
    note for AuroFlight "Added default flights=[] in constructor"

    class AuroFlightHeader {
        +Array flights
        +flightType()
    }
    note for AuroFlightHeader "Modified flightType() to return '' instead of null for empty flights"

    AuroFlight <|-- AuroFlightHeader
Loading

File-Level Changes

Change Details Files
Updated dependencies in package.json.
  • Updated @aurodesignsystem/auro-flightline from 3.1.2 to 3.1.3.
  • Updated @aurodesignsystem/auro-library from 3.0.3 to 3.0.7.
  • Updated chalk from 5.3.0 to 5.4.1.
  • Updated @aurodesignsystem/design-tokens from 4.10.1 to 4.13.0.
  • Updated @aurodesignsystem/eslint-config from 1.3.2 to 1.3.3.
  • Updated @commitlint/cli from 19.5.0 to 19.6.1.
  • Updated @commitlint/config-conventional from 19.5.0 to 19.6.0.
  • Updated @rollup/plugin-node-resolve from 15.3.0 to 16.0.0.
  • Updated compression from 1.7.4 to 1.7.5.
  • Updated concurrently from 9.0.1 to 9.1.2.
  • Updated core-js from 3.38.1 to 3.40.0.
  • Updated eslint from 9.13.0 to 9.19.0.
  • Updated eslint-plugin-jsdoc from 50.4.3 to 50.6.3.
  • Updated husky from 9.1.6 to 9.1.7.
  • Updated nodemon from 3.1.7 to 3.1.9.
  • Updated rollup from 4.24.0 to 4.32.1.
  • Updated sass from 1.80.4 to 1.83.4.
  • Updated semantic-release from 24.1.3 to 24.2.1.
  • Updated stylelint from 16.10.0 to 16.14.1.
  • Updated stylelint-config-standard from 36.0.1 to 37.0.0.
  • Updated stylelint-config-standard-scss from 13.1.0 to 14.0.0.
  • Updated stylelint-scss from 6.8.1 to 6.10.1.
  • Updated typescript from 5.6.3 to 5.7.3.
package.json
Modified the documentation to include a default value for the flights property.
  • Added a default value of [] to the flights property in the documentation.
demo/api.md
docs/api.md
Modified auro-flight-header to handle cases where there are no flights.
  • Modified the flightType method to return an empty string instead of null when there are no flights.
src/auro-flight-header.js
Initialized the flights property in the auro-flight constructor.
  • Added this.flights = []; to the constructor to ensure the property is always initialized.
src/auro-flight.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

Copy link

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 @jason-capsule42 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 3 issues 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.

demo/api.md Show resolved Hide resolved
demo/api.md Show resolved Hide resolved
docs/api.md Show resolved Hide resolved
@jason-capsule42 jason-capsule42 merged commit a1eaaab into main Jan 28, 2025
6 of 7 checks passed
@jason-capsule42 jason-capsule42 deleted the jbaker/handleMissingFlights branch January 28, 2025 21:56
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.2.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Jan 28, 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
Development

Successfully merging this pull request may close these issues.

Auro flight needs to correctly handle when flights is not passed in or is an empty array
3 participants