Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

docs: complete macOS node-gyp troubleshooting steps in CONTRIBUTING.md #4036

Merged
merged 7 commits into from
Jun 21, 2023
Merged

docs: complete macOS node-gyp troubleshooting steps in CONTRIBUTING.md #4036

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
73757ea
Fill MacOS node-gyp troubleshooting guide
OnlyOneJMJQ Dec 15, 2022
ed04de6
Add final xcode-select reinstall measure
OnlyOneJMJQ Dec 15, 2022
fcdc210
Merge branch 'develop' into ngyp-macos-troubleshooting
davidmurdoch Dec 16, 2022
38f619c
Update CONTRIBUTING.md
davidmurdoch Jan 31, 2023
df907ff
Update python installation instructions
jeffsmale90 Jun 20, 2023
16a6b52
Update CONTRIBUTING.md
jeffsmale90 Jun 21, 2023
ac8af96
Merge branch 'develop' into ngyp-macos-troubleshooting
jeffsmale90 Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,17 @@ If installation fails due to a `node-gyp` issue you may need to perform some add

### on macOS

- I have no idea.
- Attempt to install Xcode command line tools (the console will tell you if they're already installed)
- example: `xcode-select --install`
- Determine if you have Python 2.x installed
- example: `which python`
- If you do not have Python 2.x installed, you need to install it. We recommend `pyenv` for this so you can keep the default MacOS python installation untouched.
Copy link
Member

Choose a reason for hiding this comment

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

I don't know Python things... but does this need to be Python 2.7.x?

Copy link
Contributor

Choose a reason for hiding this comment

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

which python won't necessarily tell you which version is installed (for example, if you use pyenv, it'll just show you the shim).

python --version is probably more useful.

davidmurdoch marked this conversation as resolved.
Show resolved Hide resolved
1. [Install `pyenv`](https://github.com/pyenv/pyenv#homebrew-in-macos)
2. [Setup your shell environment for `pyenv`](https://github.com/pyenv/pyenv#set-up-your-shell-environment-for-pyenv)
3. Install Python 2.x: `pyenv install 2.7.18`
- If the above steps don't fix the `node-gyp` issue and you've recently updated your OS, you may need to re-install Xcode command line tools:
1. Remove the existing, broken installation: `rm -rf /Library/Developer/CommandLineTools`
2. Install them again: `xcode-select --install`

## Clean install

Expand Down