Skip to content

Commit 9f0c8e5

Browse files
committed
Add troubleshooting.md file to help with common problems
This change adds a new documentation file called troubleshooting.md which gives the user guidance on how to resolve commonly occuring problems when using this extension. For now it just contains information on how to install OpenSSL when using the extension on OS X.
1 parent 5d2bde7 commit 9f0c8e5

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

docs/troubleshooting.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Troubleshooting PowerShell Extension Issues
2+
3+
This document contains troubleshooting steps for commonly reported issues when using the
4+
PowerShell extension for Visual Studio Code.
5+
6+
## Mac OS X
7+
8+
### 1. PowerShell IntelliSense does not work, can't debug scripts
9+
10+
The most common problem when the PowerShell extension doesn't work on Mac OS X is that
11+
OpenSSL is not installed. You can check for the installation of OpenSSL by looking for
12+
the following two files:
13+
14+
```
15+
/usr/local/lib/libcrypto.1.0.0.dylib
16+
/usr/local/lib/libssl.1.0.0.dylib
17+
```
18+
19+
The extension should check for these files and direct you to this documentation if you
20+
do not have OpenSSL isntalled.
21+
22+
#### Installing OpenSSL via Homebrew
23+
24+
You can use Homebrew to easily install OpenSSL. First install Homebrew and then run the following command:
25+
26+
```
27+
brew install openssl
28+
```
29+
30+
Restart VS Code after completing the installation and verify that the extension is working correctly.
31+
32+
#### Installing OpenSSL via MacPorts
33+
34+
If you prefer to use [MacPorts](https://www.macports.org/), you can run the following command to install OpenSSL:
35+
36+
```
37+
sudo port install openssl
38+
```
39+
40+
You will need to take an additional step once installation completes:
41+
42+
```
43+
sudo ln -s /opt/local/lib/libcrypto.1.0.0.dylib /usr/local/lib/
44+
sudo ln -s /opt/local/lib/libssl.1.0.0.dylib /usr/local/lib/
45+
```
46+
47+
Thanks to [@MarlonRodriguez](https://github.com/MarlonRodriguez) for the tip!
48+
49+
Restart VS Code after completing the installation and verify that the extension is working correctly.

0 commit comments

Comments
 (0)