Skip to content

Commit 327983f

Browse files
committed
Shift new troubleshooting documentation to README.md
1 parent 93477a1 commit 327983f

File tree

2 files changed

+57
-59
lines changed

2 files changed

+57
-59
lines changed

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,63 @@ USE_HEADLESS=no $(npm bin)/jest --runInBand test/integration/backpack.test.js
123123

124124
## Troubleshooting
125125

126-
[Troubleshooting](troubleshooting.md)
126+
### Ignoring optional dependencies
127+
128+
When running `npm install`, you can get warnings about optionsl dependencies:
129+
130+
```
131+
npm WARN optional Skipping failed optional dependency /chokidar/fsevents:
132+
npm WARN notsup Not compatible with your operating system or architecture: [email protected]
133+
```
134+
135+
You can suppress them by adding the `no-optional` switch:
136+
137+
```
138+
npm install --no-optional
139+
```
140+
141+
Further reading: [Stack Overflow](https://stackoverflow.com/questions/36725181/not-compatible-with-your-operating-system-or-architecture-fsevents1-0-11)
142+
143+
### Resolving dependencies
144+
145+
When installing for the first time, you can get warnings which need to be resolved:
146+
147+
```
148+
npm WARN [email protected] requires a peer of babel-eslint@^8.0.1 but none was installed.
149+
npm WARN [email protected] requires a peer of eslint@^4.0 but none was installed.
150+
npm WARN [email protected] requires a peer of react-intl-redux@^0.7 but none was installed.
151+
npm WARN [email protected] requires a peer of react-responsive@^4 but none was installed.
152+
```
153+
154+
You can check which versions are available:
155+
156+
```
157+
npm view react-intl-redux@0.* version
158+
```
159+
160+
You will neet do install the required version:
161+
162+
```
163+
npm install --no-optional --save-dev react-intl-redux@^0.7
164+
```
165+
166+
The dependency itself might have more missing dependencies, which will show up like this:
167+
168+
```
169+
user@machine:~/sources/scratch/scratch-gui (491-translatable-library-objects)$ npm install --no-optional --save-dev react-intl-redux@^0.7
170+
[email protected] /media/cuideigin/Linux/sources/scratch/scratch-gui
171+
172+
└── UNMET PEER DEPENDENCY [email protected]
173+
```
174+
175+
You will need to install those as well:
176+
177+
```
178+
npm install --no-optional --save-dev react-responsive@^5.0.0
179+
```
180+
181+
Further reading: [Stack Overflow](https://stackoverflow.com/questions/46602286/npm-requires-a-peer-of-but-all-peers-are-in-package-json-and-node-modules)
182+
127183

128184
## Publishing to GitHub Pages
129185
You can publish the GUI to github.io so that others on the Internet can view it.

troubleshooting.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

0 commit comments

Comments
 (0)