Merge pull request #2954 from mplesec/issue/2935/update-docs-re-npm-config-flag

docs: update docs regarding npm config ignore-scripts flag
2020-10-18 19:24:15 +02:00
parent c3113d1d39 edeb5e45a3
commit 3dda28f908
1 changed files with 18 additions and 0 deletions
@@ -124,3 +124,21 @@ the root directory:
 ```bash
 yarn workspace backend start
 ```
+
+### Troubleshooting
+
+#### Cannot find module
+
+You may encounter an error similar to below:
+
+```
+internal/modules/cjs/loader.js:968
+  throw err;
+  ^
+
+Error: Cannot find module '../build/Debug/nodegit.node'
+```
+
+This can occur if an npm dependency is not completely installed. Because some
+dependencies run a post-install script, ensure that both your npm and yarn
+configs have the `ignore-scripts` flag set to `false`.