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

feat: update auro-library to 3.0.1 #84

Merged
merged 2 commits into from
Nov 15, 2024
Merged

Conversation

DukeFerdinand
Copy link
Contributor

@DukeFerdinand DukeFerdinand commented Nov 11, 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: #83

Summary:

This updates to the latest auro-library version and ensures the documentation paths are updated in index.md and api.md to match!

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

Update auro-library to version 3.0.1 and adjust documentation paths to match the new directory structure.

New Features:

  • Update auro-library dependency to version 3.0.1.

Documentation:

  • Update documentation paths in index.md and api.md to reflect new directory structure.

Copy link

sourcery-ai bot commented Nov 11, 2024

Reviewer's Guide by Sourcery

This PR updates the auro-library dependency to version 3.0.1 and updates documentation file paths to match the new structure. The changes primarily involve updating relative path references in various markdown files to ensure proper content generation.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated auro-library dependency version
  • Upgraded @aurodesignsystem/auro-library from 2.8.0 to 3.0.1
package.json
package-lock.json
Updated documentation file paths
  • Changed relative path references from ./../../ to ./../
  • Updated paths in AURO-GENERATED-CONTENT tags
  • Modified file paths in markdown content references
demo/api.md
demo/index.md
docs/partials/api.md
docs/partials/index.md
README.md

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

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 @DukeFerdinand - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟡 Documentation: 1 issue 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 and I'll use the feedback to improve your reviews.

demo/api.md Show resolved Hide resolved
@@ -248,7 +248,7 @@ var colorCss$1 = i$3`:host{color:var(--ds-auro-icon-color)}:host([customColor]){

/* eslint-disable line-comment-position, no-inline-comments, no-confusing-arrow, no-nested-ternary, implicit-arrow-linebreak */

class AuroLibraryRuntimeUtils {
let AuroLibraryRuntimeUtils$1 = class AuroLibraryRuntimeUtils {
Copy link

Choose a reason for hiding this comment

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

issue (complexity): Consider optimizing the build configuration to prevent duplicate class definitions

The duplicate AuroLibraryRuntimeUtils class definition appears to be an artifact of the build/bundling process rather than intentional code duplication. This should be addressed through build optimization rather than code changes.

Consider:

  1. Review your bundler configuration to enable code deduplication
  2. If using Rollup, enable the dedupe option:
// rollup.config.js
export default {
  plugins: [
    resolve({
      dedupe: ['AuroLibraryRuntimeUtils']
    })
  ]
}
  1. If using Webpack, verify ModuleConcatenationPlugin is enabled for production builds:
// webpack.config.js
module.exports = {
  optimization: {
    concatenateModules: true
  }
}

Comment on lines +548 to +550
: found
? found // found a selector INside this element
: __Closest(el.getRootNode().host) // recursion!! break out to parent DOM
Copy link

Choose a reason for hiding this comment

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

suggestion (code-quality): Avoid unneeded ternary statements (simplify-ternary)

Suggested change
: found
? found // found a selector INside this element
: __Closest(el.getRootNode().host) // recursion!! break out to parent DOM
: found || __Closest(el.getRootNode().host) // recursion!! break out to parent DOM


ExplanationIt is possible to simplify certain ternary statements into either use of an || or !.
This makes the code easier to read, since there is no conditional logic.

Comment on lines +548 to +550
: found
? found // found a selector INside this element
: __Closest(el.getRootNode().host) // recursion!! break out to parent DOM
Copy link

Choose a reason for hiding this comment

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

suggestion (code-quality): Avoid unneeded ternary statements (simplify-ternary)

Suggested change
: found
? found // found a selector INside this element
: __Closest(el.getRootNode().host) // recursion!! break out to parent DOM
: found || __Closest(el.getRootNode().host) // recursion!! break out to parent DOM


ExplanationIt is possible to simplify certain ternary statements into either use of an || or !.
This makes the code easier to read, since there is no conditional logic.

@jordanjones243 jordanjones243 force-pushed the dhook/update-auro-library branch from c39947d to 263cf71 Compare November 12, 2024 22:42
@chrisfalaska chrisfalaska linked an issue Nov 12, 2024 that may be closed by this pull request
Copy link

@chrisfalaska chrisfalaska left a comment

Choose a reason for hiding this comment

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

When running npm dun dev, I noticed the local version of the "Recommended Use and Version Control" section featured an alert example:

Screenshot 2024-11-12 at 3 14 23 PM

However, the current DocSite does not:

Screenshot 2024-11-12 at 3 14 49 PM

Was this intentional?

@jordanjones243
Copy link
Contributor

When running npm dun dev, I noticed the local version of the "Recommended Use and Version Control" section featured an alert example:

Screenshot 2024-11-12 at 3 14 23 PM

However, the current DocSite does not:

Screenshot 2024-11-12 at 3 14 49 PM

Was this intentional?

The docsite example is broken, the localhost is correct.

jordanjones243
jordanjones243 previously approved these changes Nov 12, 2024
Copy link

@chrisfalaska chrisfalaska left a comment

Choose a reason for hiding this comment

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

Tested locally 🚀

@sun-mota sun-mota merged commit 2fa870b into main Nov 15, 2024
6 checks passed
@sun-mota sun-mota deleted the dhook/update-auro-library branch November 15, 2024 19:27
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update auro library
5 participants