AlaskaAirlines / auro-avatar

Custom element for the purpose of displaying an avatar image.
https://auro.alaskaair.com/components/auro/avatar
Apache License 2.0
1 stars 0 forks source link

Fix theming issues and address tech debt #60

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

Fix theming issues and address technical debt by refactoring component registration, updating documentation, and enhancing the auro-avatar component with improved version control and icon handling. Update tests and remove obsolete scripts to streamline the project.

Enhancements:

Documentation:

Tests:

Chores:

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request addresses theming issues and technical debt in the auro-avatar component. The changes include refactoring the component registration process, updating dependencies, improving version control, and making minor adjustments to the component's implementation and documentation.

File-Level Changes

Change Details Files
Refactored component registration process
  • Replaced custom registerComponent function with RuntimeUtils.registerComponent method
  • Updated import statements to use @aurodesignsystem/auro-library
  • Modified demo and index files to use new registration method
index.js
demo/index.html
src/auro-avatar.js
Updated dependencies and version control
  • Added iconVersion.js file to manage auro-icon version
  • Updated design-tokens and webcorestylesheets versions in README.md
  • Implemented AuroDependencyVersioning for icon versioning
src/iconVersion.js
README.md
src/auro-avatar.js
Improved theming and styling
  • Updated CSS custom properties for avatar tail container gradient colors
  • Modified SCSS variables to use utility colors instead of brand colors
  • Updated selectors to target [auro-icon] instead of auro-icon element
src/tokens.scss
demo/api.md
src/style.scss
Enhanced documentation and examples
  • Added section on recommended use and version control in demo/index.md and docs/partials/index.md
  • Updated example code for custom element registration
  • Removed CSS Custom Property fallbacks section from README.md
demo/index.md
docs/partials/index.md
README.md
Implemented ESLint configuration changes
  • Added eslint.config.mjs file with new ESLint configuration
  • Removed old ESLint configuration files
eslint.config.mjs
Made minor adjustments to component implementation
  • Added firstUpdated lifecycle method to handle component tag renaming
  • Updated error handling in HTTP request method
  • Modified test case to use updated image source
src/auro-avatar.js
test/auro-avatar.test.js

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 4.6.0-beta.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: