Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address tech debt #243

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Address tech debt #243

merged 2 commits into from
Sep 18, 2024

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Sep 18, 2024

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.

  • Reconfigure custom component registration
  • Update dependencies
  • Remove beta releases from CHANGELOG

Type of change:

Please delete options that are not relevant.

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

Checklist:

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

Address technical debt by updating dependencies, reconfiguring component registration, and enhancing the AuroDropdown component with new styling options and runtime utilities. Update documentation to reflect these changes and remove outdated content.

Enhancements:

  • Reconfigure custom component registration to use a new runtime utility for registering components.
  • Update the AuroDropdown component to include additional stylesheets for color and tokens.
  • Refactor the AuroDropdown component to use a dynamic tag for the auro-icon element, allowing for versioning and customization.
  • Improve the AuroDropdown component by adding runtime utilities for handling component tag renaming.

Documentation:

  • Update documentation to include new theme support and styling options for the AuroDropdown component.
  • Remove beta releases from the CHANGELOG to streamline the documentation.

Chores:

  • Update dependencies to their latest versions to address technical debt.
  • Remove unused and outdated files related to the onDark theme and static styles.

@jordanjones243 jordanjones243 self-assigned this Sep 18, 2024
@jordanjones243 jordanjones243 requested a review from a team as a code owner September 18, 2024 20:33
Copy link

sourcery-ai bot commented Sep 18, 2024

Reviewer's Guide by Sourcery

This pull request addresses technical debt and updates the auro-dropdown component. The changes include reconfiguring custom component registration, updating dependencies, removing beta releases from the CHANGELOG, and making various code improvements and optimizations.

File-Level Changes

Change Details Files
Refactored component registration and dependency management
  • Updated import statements and component registration method
  • Removed registerComponent function and replaced with RuntimeUtils
  • Added AuroDependencyVersioning for generating unique names for dependency components
src/auro-dropdown.js
index.js
demo/index.html
demo/index.md
docs/partials/index.md
Updated styling and theming approach
  • Removed inline styles and replaced with CSS custom properties
  • Added new color.scss and tokens.scss files for centralized styling
  • Updated existing style.scss file to use new CSS custom properties
src/style.scss
src/color.scss
src/tokens.scss
Improved build and development setup
  • Updated tsconfig.json with new compiler options
  • Added eslint.config.mjs for ESLint configuration
  • Removed scripts/generateDocs.mjs and scripts/staticStyles-template.js
tsconfig.json
eslint.config.mjs
Updated documentation and examples
  • Removed onDark examples from apiExamples folder
  • Updated README.md with new installation and usage instructions
  • Added theme support section in API documentation
README.md
demo/api.md
docs/partials/api.md

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:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@CLAassistant
Copy link

CLAassistant commented Sep 18, 2024

CLA assistant check
All committers have signed the CLA.

@jordanjones243 jordanjones243 changed the base branch from main to beta September 18, 2024 20:33
@jordanjones243 jordanjones243 merged commit a378bd1 into beta Sep 18, 2024
2 of 4 checks passed
@jordanjones243 jordanjones243 deleted the jjones/betaTechDebt branch September 18, 2024 20:34
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.0.0-beta.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants