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.

[x] New capability
[x] Revision of an existing capability
[ ] Infrastructure change (automation, etc.)
[ ] Other (please elaborate)

Checklist:

[x] My update follows the CONTRIBUTING guidelines of this project
[x] 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

Refactor component registration to utilize RuntimeUtils, update CSS variables to new design standards, and clean up documentation and unused scripts.

Enhancements:

Refactor component registration to use RuntimeUtils for registering custom elements, improving modularity and maintainability.
Update CSS variable usage to align with new design token standards, enhancing visual consistency across components.

Documentation:

Remove outdated documentation on CSS custom property fallbacks, streamlining the README content.

Chores:

Delete unused scripts related to documentation generation and post-processing, cleaning up the project structure.

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request focuses on updating the auro-dialog component to use the latest Auro design system standards and improve its implementation. The changes include updating dependencies, refactoring the component registration process, and adjusting CSS custom properties to align with the latest design tokens.

Class diagram for updated component registration

classDiagram
    class RuntimeUtils {
        +registerComponent(name, component)
    }
    class AuroDialog
    class ComponentBase {
        +runtimeUtils: AuroLibraryRuntimeUtils
        +firstUpdated()
    }
    ComponentBase --> RuntimeUtils : uses
    RuntimeUtils --> AuroDialog : registers

Class diagram for updated CSS properties

classDiagram
    class CSSProperties {
        --ds-auro-dialog-background-color
        --ds-auro-dialog-boxshadow-color
        --ds-auro-dialog-overlay-modal-background-color
        --ds-auro-dialog-overlay-open-background-color
        --ds-auro-dialog-text-color
    }
    class Tokens {
        +updateProperties()
    }
    CSSProperties <|-- Tokens : updated
    CSSProperties : -boxshadow-color-one
    CSSProperties : -boxshadow-color-two

File-Level Changes

Change	Details	Files
Refactored component registration process	Removed custom registerComponent function Implemented RuntimeUtils for component registration Updated import statements to use new registration method	`index.js` `demo/index.html` `demo/index.md` `docs/partials/index.md`
Updated CSS custom properties and design tokens	Replaced hardcoded RGB values with design token variables Updated box-shadow properties to use new design tokens Adjusted overlay background colors to use scrimmed default color	`src/tokens.scss` `demo/api.md` `src/color.scss`
Removed outdated documentation and scripts	Removed CSS Custom Property fallbacks section from README Deleted generateDocs.mjs, postCss.mjs, and staticStyles-template.js scripts	`README.md` `scripts/generateDocs.mjs` `scripts/postCss.mjs` `scripts/staticStyles-template.js`
Updated dependencies and version references	Updated design-tokens and webcorestylesheets versions in README Removed explicit version exports for button and icon components	`README.md` `src/buttonVersion.js` `src/iconVersion.js`
Enhanced component base class	Added AuroLibraryRuntimeUtils import and initialization Implemented handleComponentTagRename method in firstUpdated lifecycle hook	`src/componentBase.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/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

jordanjones243 commented 1 month ago

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

The release is available on:

Your semantic-release bot :package::rocket:

AlaskaAirlines / auro-dialog

Beta tech debt #21