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 #52

Merged
merged 4 commits into from
Sep 26, 2024
Merged

Address tech debt #52

merged 4 commits into from
Sep 26, 2024

Conversation

jordanjones243
Copy link
Contributor

@jordanjones243 jordanjones243 commented Sep 26, 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.

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

Refactor the component registration process to utilize RuntimeUtils, update documentation accordingly, and clean up obsolete scripts and dependencies.

Enhancements:

  • Refactor component registration to use RuntimeUtils for registering custom elements, improving consistency and maintainability.

Documentation:

  • Update documentation to reflect changes in component registration method using RuntimeUtils.

Chores:

  • Update stylesheet links in README.md to use newer versions of design tokens and web core stylesheets.
  • Remove obsolete scripts including generateDocs.mjs, postCss.mjs, and staticStyles-template.js.

@jordanjones243 jordanjones243 self-assigned this Sep 26, 2024
@jordanjones243 jordanjones243 requested a review from a team as a code owner September 26, 2024 17:28
Copy link

sourcery-ai bot commented Sep 26, 2024

Reviewer's Guide by Sourcery

This pull request addresses technical debt by refactoring the component registration process, updating dependencies, and modernizing the project structure. The changes primarily focus on improving the way the AuroCarousel component is registered and used, as well as updating various configuration files and documentation.

Sequence Diagram

sequenceDiagram
    participant App
    participant RuntimeUtils
    participant CustomElements
    App->>RuntimeUtils: registerComponent('custom-carousel', AuroCarousel)
    RuntimeUtils->>CustomElements: define('custom-carousel', AuroCarousel)
    CustomElements-->>RuntimeUtils: Component registered
    RuntimeUtils-->>App: Registration complete
Loading

File-Level Changes

Change Details Files
Refactored component registration process
  • Removed custom registerComponent function
  • Implemented RuntimeUtils.default.prototype.registerComponent for component registration
  • Updated import statements to use the new registration method
index.js
demo/index.html
demo/index.md
docs/partials/index.md
Updated dependencies and configuration
  • Updated design-tokens and webcorestylesheets versions in README.md
  • Removed buttonVersion.js and iconVersion.js files
  • Added eslint.config.mjs file for ESLint configuration
README.md
src/buttonVersion.js
src/iconVersion.js
eslint.config.mjs
Removed deprecated scripts
  • Deleted generateDocs.mjs script
  • Deleted postCss.mjs script
  • Deleted staticStyles-template.js script
scripts/generateDocs.mjs
scripts/postCss.mjs
scripts/staticStyles-template.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 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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @jordanjones243 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please provide context for the removal of scripts/generateDocs.mjs and scripts/postCss.mjs. How is their functionality being handled now?
  • Consider measuring and documenting the performance impact of the new component registration approach, particularly on bundle size and initialization time.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 3 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

demo/index.md Show resolved Hide resolved
docs/partials/index.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@jordanjones243 jordanjones243 merged commit 75d36cb into beta Sep 26, 2024
4 checks passed
@jordanjones243 jordanjones243 deleted the jjones/betaTechDebt branch September 26, 2024 17:34
@blackfalcon
Copy link
Member

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

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.

2 participants