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 unresolved deps w/bundled assets #78

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

blackfalcon
Copy link
Member

@blackfalcon blackfalcon commented Oct 31, 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: #77

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.

This commit addresses an issue with unresolved dependencies regarding the building of bundled assets.

On branch dsande/unresolvedDependencies/#77
Changes to be committed:
modified: demo/api.min.js
modified: demo/index.min.js
modified: rollup.config.mjs

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

Enhancements:

  • Add nodeResolve plugin to Rollup configuration for resolving module dependencies in bundled assets.

This commit addresses an issue with unresolved dependencies regarding
the building of bundled assets.

On branch dsande/unresolvedDependencies/#77
Changes to be committed:
modified:   demo/api.min.js
modified:   demo/index.min.js
modified:   rollup.config.mjs
Copy link

sourcery-ai bot commented Oct 31, 2024

Reviewer's Guide by Sourcery

The changes update the Rollup configuration to properly resolve dependencies for bundled assets by adding the nodeResolve plugin to both the index and API example configurations.

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

File-Level Changes

Change Details Files
Added nodeResolve plugin to example bundle configurations
  • Added nodeResolve plugin to indexExamplesConfig
  • Added nodeResolve plugin to apiExamplesConfig
rollup.config.mjs

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 @blackfalcon - 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: all looks good
  • 🟢 Documentation: all looks good

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.min.js Show resolved Hide resolved
* Copyright 2020 Google LLC
* SPDX-License-Identifier: BSD-3-Clause
*/
const a$1=Symbol.for(""),o$3=t=>{if(t?.r===a$1)return t?._$litStatic$},s$1=t=>({_$litStatic$:t,r:a$1}),i$4=(t,...r)=>({_$litStatic$:r.reduce(((r,e,a)=>r+(t=>{if(void 0!==t._$litStatic$)return t._$litStatic$;throw Error(`Value passed to 'literal' function must be a 'literal' result: ${t}. Use 'unsafeStatic' to pass non-literal values, but\n take care to ensure page security.`)})(e)+t[a+1]),t[0]),r:a$1}),l$1=new Map,n$2=t=>(r,...e)=>{const a=e.length;let s,i;const n=[],u=[];let c,$=0,f=!1;for(;$<a;){for(c=r[$];$<a&&void 0!==(i=e[$],s=o$3(i));)c+=s+r[++$],f=!0;$!==a&&u.push(i),n.push(c),$++;}if($===a&&n.push(r[a]),f){const t=n.join("$$lit$$");void 0===(r=l$1.get(t))&&(n.raw=n,l$1.set(t,r=n)),e=u;}return t(r,...e)},u$1=n$2(x);
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): Use block braces for ifs, whiles, etc. (use-braces)

Suggested change
const a$1=Symbol.for(""),o$3=t=>{if(t?.r===a$1)return t?._$litStatic$},s$1=t=>({_$litStatic$:t,r:a$1}),i$4=(t,...r)=>({_$litStatic$:r.reduce(((r,e,a)=>r+(t=>{if(void 0!==t._$litStatic$)return t._$litStatic$;throw Error(`Value passed to 'literal' function must be a 'literal' result: ${t}. Use 'unsafeStatic' to pass non-literal values, but\n take care to ensure page security.`)})(e)+t[a+1]),t[0]),r:a$1}),l$1=new Map,n$2=t=>(r,...e)=>{const a=e.length;let s,i;const n=[],u=[];let c,$=0,f=!1;for(;$<a;){for(c=r[$];$<a&&void 0!==(i=e[$],s=o$3(i));)c+=s+r[++$],f=!0;$!==a&&u.push(i),n.push(c),$++;}if($===a&&n.push(r[a]),f){const t=n.join("$$lit$$");void 0===(r=l$1.get(t))&&(n.raw=n,l$1.set(t,r=n)),e=u;}return t(r,...e)},u$1=n$2(x);
const a$1=Symbol.for(""),o$3=t=>{if(t?.r===a$1)return t?._$litStatic$},s$1=t=>({_$litStatic$:t,r:a$1}),i$4=(t,...r)=>({_$litStatic$:r.reduce(((r,e,a)=>r+(t=>{if (void 0!==t._$litStatic$) {


ExplanationIt is recommended to always use braces and create explicit statement blocks.

Using the allowed syntax to just write a single statement can lead to very confusing
situations, especially where subsequently a developer might add another statement
while forgetting to add the braces (meaning that this wouldn't be included in the condition).

demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
@blackfalcon
Copy link
Member Author

Confirmed that the warnings were removed from the build output

> @aurodesignsystem/auro-alert@3.1.0 bundler
> rollup -c


./index.js → dist/...
created dist/ in 244ms

./demo/index.js → demo/...
created demo/ in 103ms

./demo/api.js → demo/...
created demo/ in 95ms

> @aurodesignsystem/auro-alert@3.1.0 types
> tsc

@blackfalcon blackfalcon linked an issue Oct 31, 2024 that may be closed by this pull request
@blackfalcon blackfalcon self-assigned this Oct 31, 2024
@blackfalcon blackfalcon requested a review from sun-mota October 31, 2024 18:18
@jason-capsule42 jason-capsule42 merged commit 3bc9e88 into main Nov 5, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the dsande/unresolvedDependencies/#77 branch November 5, 2024 01:02
@blackfalcon
Copy link
Member Author

🎉 This PR is included in version 3.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Nov 5, 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.

Rollup bundled assets unresolved dependencies warning
2 participants