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

Document extra installation step for M1 Mac #2535

Merged
merged 2 commits into from Nov 1, 2021

Conversation

srmagura
Copy link
Member

@srmagura srmagura commented Nov 1, 2021

What: yarn install fails on M1 Macs unless libvips is installed separately.

Why: So that M1 Mac users can contribute to Emotion.

How: Document the extra step in CONTRIBUTING.md.

Checklist:

  • Documentation
  • Tests N/A
  • Code complete N/A
  • Changeset N/A

@changeset-bot
Copy link

changeset-bot bot commented Nov 1, 2021

⚠️ No Changeset found

Latest commit: 2f47a64

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codesandbox-ci
Copy link

codesandbox-ci bot commented Nov 1, 2021

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 262212c:

Sandbox Source
Emotion Configuration

@Andarist
Copy link
Member

Andarist commented Nov 1, 2021

Was there any open issue about this or did you stumble upon this issue yourself? Do you know if there is any ETA when this will be no longer necessary?

@srmagura
Copy link
Member Author

srmagura commented Nov 1, 2021

Hey @Andarist, the issue was originally reported in lovell/sharp#2460 and that is where I got the solution of installing vips via Homebrew.

I just found out that installing vips seperately is no longer necessary with sharp 0.28.0+, see lovell/sharp#2604. That version of sharp is not officially compatible with the 2.x.x versions of gatsby-plugin-sharp and gatsby-transformer-sharp so we would have to upgrade to the latest Gatsby to get this improvement.

If you like, I can create a separate issue for upgrading the Emotion website to the latest Gatsby. I could PR that change sometime in the next few weeks.

@Andarist
Copy link
Member

Andarist commented Nov 1, 2021

If you are open to this then sure - this would be a preferable approach.

@srmagura
Copy link
Member Author

srmagura commented Nov 1, 2021

OK, I created #2536 for this. If you want, you can merge this PR and then I will remove the extra step from the documentation once the Gatsby upgrade is done.

TBH, I have not used Gatsby so I'm not sure how big of a task it is to upgrade from v2 to v4, but I assume it won't be too hard.

@Andarist
Copy link
Member

Andarist commented Nov 1, 2021

TBH, I have not used Gatsby so I'm not sure how big of a task it is to upgrade from v2 to v4, but I assume it won't be too hard.

I think our setup is pretty standard so hopefully, this shouldn't be overly hard. If it turns out to be problematic then it might not be worth it. Migrating to NextJS would also be an option if you are familiar with it, but that definitely won't be a 1-2h task since both frameworks are a bit different.

@Andarist Andarist merged commit 01e4e0f into emotion-js:main Nov 1, 2021
@srmagura srmagura deleted the mac-vips branch November 1, 2021 21:28
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.

None yet

2 participants