AlaskaAirlines / auro-banner

Custom element that ....
https://auro.alaskaair.com/components/auro/banner
Apache License 2.0
0 stars 0 forks source link

Address color theming issues and tech debt #64

Closed jordanjones243 closed 2 months ago

jordanjones243 commented 2 months 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: #57

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

Address color theming issues by updating CSS variables to align with design system tokens. Introduce dynamic header tag generation and refactor component registration using RuntimeUtils for better version management. Update documentation and tests to reflect these changes, and remove deprecated Husky script.

New Features:

Bug Fixes:

Enhancements:

Build:

Documentation:

Tests:

Chores:

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request addresses color theming issues and technical debt in the auro-banner component. The changes include updating color variables, improving component versioning, refactoring the component registration process, and enhancing the banner's functionality with dynamic header tags.

File-Level Changes

Change Details Files
Refactored component registration process
  • Removed custom registerComponent function
  • Implemented RuntimeUtils for component registration
  • Updated import statements and registration calls in demo and documentation files
index.js
demo/index.html
demo/index.md
docs/partials/index.md
Updated color theming and variables
  • Replaced hardcoded color values with design system variables
  • Updated CSS custom properties for better theming support
  • Modified color-related classes and styles
src/color.scss
src/tokens.scss
demo/api.md
apiExamples/iconic.html
Improved component versioning and compatibility
  • Added AuroDependencyVersioning for header tag generation
  • Implemented dynamic header tag creation based on versioning
  • Updated tests to accommodate dynamic header tags
src/auro-banner.js
test/auro-banner.test.js
src/headerVersion.js
Enhanced banner functionality and structure
  • Added support for component tag renaming
  • Refactored firstUpdated method for better slot handling
  • Updated template literals to use dynamic header tags
src/auro-banner.js
Updated build and development tools
  • Added ESLint configuration file
  • Updated Husky hook with deprecation notice
  • Removed generateDocs.mjs and staticStyles-template.js scripts
.husky/_/husky.sh
eslint.config.mjs

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
blackfalcon commented 2 months ago

:tada: This PR is included in version 2.1.0-beta.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: