AlaskaAirlines / auro-flight

HTML custom element that supports Alaska's flight result experience
https://auro.alaskaair.com/components/auro/flight
Apache License 2.0
2 stars 2 forks source link

Jbaker/beta release #131

Closed jason-capsule42 closed 2 days ago

jason-capsule42 commented 2 days 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

Release a beta version of the auro-flight component with theme support, refactor CSS for better maintainability, and update documentation and tests to reflect these changes.

New Features:

Enhancements:

Documentation:

Tests:

Chores:

CLAassistant commented 2 days ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
3 out of 4 committers have signed the CLA.

:white_check_mark: jordanjones243
:white_check_mark: jason-capsule42
:white_check_mark: DukeFerdinand
:x: semantic-release-bot
You have signed the CLA already but the status is still pending? Let us recheck it.

sourcery-ai[bot] commented 2 days ago

Reviewer's Guide by Sourcery

This pull request implements several changes to the auro-flight component, including code refactoring, styling updates, and dependency management improvements. The changes aim to enhance the component's maintainability, performance, and adherence to design standards.

Class diagram for AuroFlight and AuroFlightMain components

classDiagram
    class AuroFlight {
        +AuroLibraryRuntimeUtils runtimeUtils
        +firstUpdated()
        +static get properties()
        +static get styles()
    }
    class AuroFlightMain {
        +AuroDependencyVersioning versioning
        +String datetimeTag
        +static get styles()
        +constructor()
    }
    AuroFlightMain --> AuroFlight : uses
    AuroFlightMain --> AuroDependencyVersioning
    AuroFlight --> AuroLibraryRuntimeUtils

File-Level Changes

Change Details Files
Refactored styling approach to improve maintainability and theming support
  • Separated color styles into new files (color-flight.scss, color-flight-header.scss, color-flight-main.scss)
  • Introduced tokens.scss file for centralized management of design tokens
  • Updated existing style files to remove direct color definitions
  • Modified component files to import and use the new style structure
src/style-flight-main.scss
src/style-flight-header.scss
src/style-flight.scss
src/color-flight-main.scss
src/color-flight-header.scss
src/color-flight.scss
src/tokens.scss
src/auro-flight-main.js
src/auro-flight-header.js
src/auro-flight.js
Updated dependency management and component registration
  • Introduced versioning for auro-datetime component
  • Updated component registration process in index.js
  • Modified eslint configuration
  • Updated README.md with new installation and usage instructions
src/auro-flight-main.js
src/datetimeVersion.js
index.js
eslint.config.mjs
README.md
Improved accessibility and internationalization support
  • Added 'da' attribute for ISO 8601 time of arrival
  • Updated API documentation to reflect new attributes and properties
src/auro-flight-main.js
docs/api.md
demo/api.md
Removed unnecessary files and updated build process
  • Deleted scripts/generateDocs.mjs, scripts/postCss.mjs, scripts/prepForBuild.js, and scripts/staticStyles-template.js
  • Updated demo and test files to reflect changes in component structure
demo/index.html
demo/api.html
test/auro-flight-main.test.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. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. #### 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/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
blackfalcon commented 2 days ago

:tada: This PR is included in version 3.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: