docs: improve prerequisites for OSX users (#6157)

* chore: added extra error logs when gdu is not installed * chore: improves prerequisites for osx * chore: fixed spelling * chore: update list symbol Co-authored-by: Nico Flaig <[email protected]> * chore: update quote type Co-authored-by: Nico Flaig <[email protected]> * chore: fix lint issue * chore: added extra words to wordlist * chore: fixed wordlist order * chore: fix wording Co-authored-by: Matthew Keil <[email protected]> * chore: fix wording Co-authored-by: Matthew Keil <[email protected]> * fix: revert linking to CONTRIBUTING for prerequisites --------- Co-authored-by: Nico Flaig <[email protected]> Co-authored-by: Matthew Keil <[email protected]>
ChainSafe · Dec 7, 2023 · 5270ef2 · 5270ef2
1 parent 6154029
commit 5270ef2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -77,6 +77,7 @@ config
 configs
 const
 constantish
+coreutils
 cors
 cryptographic
 dApp

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,6 +7,13 @@ Thanks for your interest in contributing to Lodestar. It's people like you that
 - :gear: [NodeJS](https://nodejs.org/) (LTS)
 - :toolbox: [Yarn](https://yarnpkg.com/)
 
+### MacOS Specifics
+
+When using MacOS, there are a couple of extra prerequisites that are required.
+
+- python
+- coreutils (e.g. via `brew install coreutils`)
+
 ## Getting Started
 
 - :gear: Run `yarn` to install dependencies.

diff --git a/packages/db/test/unit/controller/level.test.ts b/packages/db/test/unit/controller/level.test.ts
@@ -144,7 +144,8 @@ describe("LevelDB controller", () => {
           return "gdu";
         }
       } catch {
-        /* no-op */
+        /* eslint-disable no-console */
+        console.error("Cannot find gdu command, falling back to du");
       }
     }
     return "du";
-Original file line number
+Diff line change
@@ Expand Up / @@ -77,6 +77,7 @@ config @@
     configs
     const
     constantish
+    coreutils
     cors
     cryptographic
     dApp
@@ Expand Down @@