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

fix: reference consuming component's package.json, rather than relatively #73

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

chrisfalaska
Copy link
Contributor

@chrisfalaska chrisfalaska commented Oct 18, 2024

When using postInstall.mjs as part of auro-library, the script attempts to reference a relative package.json:

const pjson = require('../package.json');

If a component such as auro-input is referencing postInatll.mjs from auro-library, the install fails since it cannot find a relative package.json inside auro-library node_modules:

Error: Cannot find module '../package.json'

The postInstall script should run from node_modules and reference the consuming component's package.json

Alaska Airlines Pull Request

Before Submitting this pull request:

  • Link all tickets in this repository related to this PR in the Development section
    note: all pull requests require at least one linked ticket
  • If this PR is Ready For Review, all ticket's linked under Development must have their status changed to Ready For Review as well

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.

Summary by Sourcery

Bug Fixes:

  • Fix the postInstall script to correctly reference the consuming component's package.json instead of a relative path.

@chrisfalaska chrisfalaska self-assigned this Oct 18, 2024
@chrisfalaska chrisfalaska marked this pull request as ready for review October 18, 2024 18:21
@chrisfalaska chrisfalaska requested a review from a team as a code owner October 18, 2024 18:21
Copy link

sourcery-ai bot commented Oct 18, 2024

Reviewer's Guide by Sourcery

This pull request fixes an issue with the postInstall.mjs script in the auro-library package. The script now correctly references the consuming component's package.json file instead of trying to find it relatively, which was causing installation failures for components using auro-library.

Sequence diagram for postInstall.mjs script execution

sequenceDiagram
    participant A as Consuming Component
    participant B as postInstall.mjs
    participant C as package.json

    A->>B: Execute postInstall.mjs
    B->>B: Resolve path to package.json
    B->>C: Access consuming component's package.json
    C-->>B: Return package.json data
    B-->>A: Complete script execution
Loading

Class diagram for postInstall.mjs script changes

classDiagram
    class postInstall {
        +chalk
        +createRequire(import.meta.url)
        +resolve
        +pjson
    }

    note for postInstall "pjson now references the consuming component's package.json using resolve(process.cwd(), 'package.json')"
Loading

File-Level Changes

Change Details Files
Modified the way package.json is imported in the postinstall script
  • Removed relative import of package.json
  • Added import for 'resolve' function from 'path' module
  • Used process.cwd() and resolve() to dynamically find the correct package.json
scripts/build/postinstall.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 @chrisfalaska - 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.

@chrisfalaska chrisfalaska merged commit 21cf238 into main Oct 21, 2024
4 checks passed
@chrisfalaska chrisfalaska deleted the cfriedberg/72 branch October 21, 2024 18:19
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.10.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Oct 21, 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 postinstall script to reference component's package.json with an absolute path
3 participants