about summary refs log tree commit diff
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorLily Foster <lily@lily.flowers>2023-06-28 18:33:02 -0400
committerGitHub <noreply@github.com>2023-06-28 18:33:02 -0400
commit59713b5555cc182545f81422c596089e871c9103 (patch)
treef39d278720e4eeba4903c05a062b524cac5e9a81 /doc/languages-frameworks
parentf0a06ede39fe010ff9be2e2914d66d7c1692e2d6 (diff)
parent3a2cf5b3f5723a62fc93b1d13052b8bd6ca31a11 (diff)
downloadnixlib-59713b5555cc182545f81422c596089e871c9103.tar
nixlib-59713b5555cc182545f81422c596089e871c9103.tar.gz
nixlib-59713b5555cc182545f81422c596089e871c9103.tar.bz2
nixlib-59713b5555cc182545f81422c596089e871c9103.tar.lz
nixlib-59713b5555cc182545f81422c596089e871c9103.tar.xz
nixlib-59713b5555cc182545f81422c596089e871c9103.tar.zst
nixlib-59713b5555cc182545f81422c596089e871c9103.zip
Merge pull request #230157 from teutat3s/buildnpmpackage-docs
buildNpmPackage: document dontNpmBuild option
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/javascript.section.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/languages-frameworks/javascript.section.md b/doc/languages-frameworks/javascript.section.md
index a6c5aad15c15..7fd84ed0e65e 100644
--- a/doc/languages-frameworks/javascript.section.md
+++ b/doc/languages-frameworks/javascript.section.md
@@ -196,6 +196,8 @@ buildNpmPackage rec {
 * `npmDepsHash`: The output hash of the dependencies for this project. Can be calculated in advance with [`prefetch-npm-deps`](#javascript-buildNpmPackage-prefetch-npm-deps).
 * `makeCacheWritable`: Whether to make the cache writable prior to installing dependencies. Don't set this unless npm tries to write to the cache directory, as it can slow down the build.
 * `npmBuildScript`: The script to run to build the project. Defaults to `"build"`.
+* `dontNpmBuild`: Option to disable running the build script. Set to `true` if the package does not have a build script. Defaults to `false`. Alternatively, setting `buildPhase` explicitly also disables this.
+* `dontNpmInstall`: Option to disable running `npm install`. Defaults to `false`. Alternatively, setting `installPhase` explicitly also disables this.
 * `npmFlags`: Flags to pass to all npm commands.
 * `npmInstallFlags`: Flags to pass to `npm ci` and `npm prune`.
 * `npmBuildFlags`: Flags to pass to `npm run ${npmBuildScript}`.