@mrpelz/boilerplate-node 13.0.1 → 13.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -72,17 +72,19 @@ Feel free to change them in your project to use `yarn`, `pnpm` or something else
|
|
|
72
72
|
* (GNU!) `make`, `sed`, `tmux` and `xargs` installed
|
|
73
73
|
> This boilerplate uses `make` for task orchestration. In order to compose Makefiles from NPM-dependency artifacts, **GNU**-Make is a strict necessity.
|
|
74
74
|
>
|
|
75
|
-
>
|
|
75
|
+
> If you’re using macOS, install using `brew install make` and amend your `$PATH` to use GNU-Make by default (e.g. by putting
|
|
76
76
|
> ```bash
|
|
77
77
|
> PATH="$HOMEBREW_PREFIX/opt/make/libexec/gnubin:$PATH"
|
|
78
78
|
> ```
|
|
79
|
-
>
|
|
79
|
+
> into your `.zshrc`).
|
|
80
80
|
* (GNU!) `ln` installed
|
|
81
|
-
> Some config files cannot be natively extended and need to be symlinked to the boilerplate’s default. This ensures new defaults apply when the boilerplate is updated. In order to keep the project root portable across different developers’ environments, symlinks need to use relative paths, which unfortunately is only a feature in the `ln` utility from GNU-Coreutils.
|
|
81
|
+
> Some config files cannot be natively extended and need to be symlinked to the boilerplate’s default. This ensures new defaults apply when the boilerplate is updated. In order to keep the project root portable across different developers’ environments, symlinks need to use relative paths, which unfortunately is only a feature in the `ln` utility from GNU-Coreutils.
|
|
82
|
+
>
|
|
83
|
+
> If you’re using macOS, install using `brew install coreutils` and amend your `$PATH` to use GNU-Coreutils by default (e.g. by putting
|
|
82
84
|
> ```bash
|
|
83
85
|
> PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
|
|
84
86
|
> ```
|
|
85
|
-
>
|
|
87
|
+
> into your `.zshrc`).
|
|
86
88
|
|
|
87
89
|
### 1. Optionally Create Environment First
|
|
88
90
|
|
|
@@ -173,7 +175,7 @@ make <target>
|
|
|
173
175
|
> ```
|
|
174
176
|
> to your `.zshrc`.
|
|
175
177
|
|
|
176
|
-
> **ℹ️ Good to know
|
|
178
|
+
> **ℹ️ Good to know**
|
|
177
179
|
>
|
|
178
180
|
> The boilerplate tries to handle “monorepos”.
|
|
179
181
|
> For the purpose of this ReadMe, “root package” is the package that contains NPM workspace definitions and the packages within those workspaces are called “sub packages”.
|
|
@@ -207,7 +209,7 @@ Run `commitlint` for the latest commit.
|
|
|
207
209
|
|
|
208
210
|
Run `tsc` to typecheck meta-files.
|
|
209
211
|
|
|
210
|
-
> **ℹ️ Good to know
|
|
212
|
+
> **ℹ️ Good to know**
|
|
211
213
|
>
|
|
212
214
|
> For the purpose of this ReadMe, “meta-file” means a file that is related to the tooling itself (e.g. configuring ESLint) and is not part of the application’s source code.
|
|
213
215
|
|