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: #198

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

Release a beta version 4.0.0-beta.1 with new features including component attribute registration and theme support. Fix import and token naming issues. Refactor color tokens and custom registration configuration. Update dependencies and improve documentation by removing outdated sections and adding theme support information.

New Features:

Add component name as an attribute during custom registration to enhance component identification.
Introduce theme support allowing components to be restyled using new token values.

Bug Fixes:

Update all imports to include extensions in file paths to resolve import issues.
Update token names for container colors to ensure correct color application.

Enhancements:

Refactor color tokens to use tier 3 tokens for improved color management.
Refactor custom registration configuration for better component handling.
Update dependencies and address lint issues to maintain code quality.

Build:

Add a new ESLint configuration file to standardize code linting across the project.

Documentation:

Remove outdated CSS custom property fallback documentation to reflect current browser support.
Add documentation for theme support, including code samples for restyling components.

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements a beta release (v4.0.0-beta.1) of the auro-menu component. The changes include refactoring color tokens to use tier 3 tokens, updating dependencies, improving performance, and adding theme support. The PR also includes various bug fixes and code improvements.

ER diagram for theme support tokens

erDiagram
    AuroMenu {
        string ds-auro-menu-divider-color
        string ds-auro-menuoption-container-color
        string ds-auro-menuoption-icon-color
        string ds-auro-menuoption-text-color
    }
    AuroMenuOption {
        string ds-auro-menuoption-container-color
        string ds-auro-menuoption-text-color
        string ds-auro-menuoption-icon-color
    }
    AuroMenu ||--o{ AuroMenuOption : contains

Class diagram for AuroMenu and AuroMenuOption updates

classDiagram
    class AuroMenu {
        +bool rootMenu
        +AuroLibraryRuntimeUtils runtimeUtils
        +void firstUpdated()
        +void handleKeyDown(Event)
    }
    class AuroMenuOption {
        +AuroDependencyVersioning versioning
        +AuroLibraryRuntimeUtils runtimeUtils
        +int tabIndex
        +void firstUpdated()
    }
    class AuroLibraryRuntimeUtils {
        +void handleComponentTagRename(Element, String)
    }
    AuroMenu --> AuroLibraryRuntimeUtils
    AuroMenuOption --> AuroLibraryRuntimeUtils
    AuroMenuOption --> AuroDependencyVersioning

Class diagram for RuntimeUtils integration

classDiagram
    class RuntimeUtils {
        +void registerComponent(String, Class)
    }
    class AuroMenu {
        +void registerComponent(String)
    }
    AuroMenu --> RuntimeUtils : uses
    RuntimeUtils <|-- AuroLibraryRuntimeUtils : extends

File-Level Changes

Change	Details	Files
Refactored color tokens to use tier 3 tokens	Updated color token usage in SCSS files Added new color-menu.scss and color-menuoption.scss files Created a new tokens.scss file for theme support	`src/style-menuoption.scss` `src/style-menu.scss` `src/color-menu.scss` `src/color-menuoption.scss` `src/tokens.scss`
Updated dependencies and build process	Updated various dependencies in package.json Removed old build scripts Added new eslint.config.mjs file	`package.json` `eslint.config.mjs` `scripts/generateDocs.mjs` `scripts/postCss.mjs` `scripts/prepForBuild.mjs` `scripts/staticStyles-template.js`
Improved component registration and runtime utilities	Refactored custom registration config Added component name as attribute during custom registration Updated index.js to use new registration method	`index.js` `src/auro-menu.js` `src/auro-menuoption.js` `demo/index.html` `demo/index.md`
Added theme support documentation	Updated README.md with theme support information Added theme support section in API documentation	`README.md` `demo/api.md` `docs/partials/api.md`
Bug fixes and performance improvements	Fixed imports to include file extensions Updated token names for container colors Improved performance by updating dependencies and using library scripts	`CHANGELOG.md` `src/auro-menu.js` `src/auro-menuoption.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).

CLAassistant commented 1 month ago

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.
2 out of 3 committers have signed the CLA.

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

blackfalcon commented 1 month ago

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

The release is available on:

Your semantic-release bot :package::rocket:

AlaskaAirlines / auro-menu

Beta release #215