From 5964c29bbdf079c537adf92a6ee61363f2750a62 Mon Sep 17 00:00:00 2001 From: Nihal <nihal9ns@gmail.com> Date: Mon, 14 Oct 2019 16:31:05 +0530 Subject: [PATCH] docs: describe npm depTypes (#4648) --- docs/usage/configuration-options.md | 17 +++++++++++++---- docs/usage/node.md | 1 + 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 43c5ca5aa4..3d7de7ee1f 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -267,7 +267,7 @@ Example: ## encrypted -See https://docs.renovatebot.com/private-modules for details on how this is used to encrypt npm tokens. +See [Private npm module support](https://docs.renovatebot.com/private-modules) for details on how this is used to encrypt npm tokens. ## engines @@ -285,7 +285,7 @@ Be careful you know what you're doing with this option. The initial intended use ## extends -See https://docs.renovatebot.com/config-presets for details. +See [shareable config presets](https://docs.renovatebot.com/config-presets) for details. ## fileMatch @@ -594,13 +594,22 @@ Check out our [Node.js documentation](https://docs.renovatebot.com/node) for a c ## npm +The following `depTypes` are currently supported by the npm manager : + +- `dependencies` +- `devDependencies` +- `optionalDependencies` +- `peerDependencies` +- `engines` : Renovate will update any `node`, `npm` and `yarn` version specified under `engines`. +- `volta` : Renovate will update any `node` and `yarn` version specified under `volta`. + ## npmToken -See https://docs.renovatebot.com/private-modules for details on how this is used. Typically you would encrypt it and put it inside the `encrypted` object. +See [Private npm module support](https://docs.renovatebot.com/private-modules) for details on how this is used. Typically you would encrypt it and put it inside the `encrypted` object. ## npmrc -See https://docs.renovatebot.com/private-modules for details on how this is used. +See [Private npm module support](https://docs.renovatebot.com/private-modules) for details on how this is used. ## nuget diff --git a/docs/usage/node.md b/docs/usage/node.md index 00285b3792..d00c5eeb53 100644 --- a/docs/usage/node.md +++ b/docs/usage/node.md @@ -12,6 +12,7 @@ Renovate can upgrade the [Node.js](https://nodejs.org/en/) runtime used by your Renovate is capable of managing the Node.js version in the following files: - The [`engines`](https://docs.npmjs.com/files/package.json#engines) field in [`package.json`](https://docs.npmjs.com/files/package.json). +- The [`volta`](https://docs.volta.sh/guide/understanding#managing-your-project) field in [`package.json`](https://docs.npmjs.com/files/package.json). - The [`.nvmrc`](https://github.com/creationix/nvm#nvmrc) file for the [Node Version Manager](https://github.com/creationix/nvm). - The [`node_js`](https://docs.travis-ci.com/user/languages/javascript-with-nodejs/#Specifying-Node.js-versions) field in [`.travis.yml`](https://docs.travis-ci.com/user/customizing-the-build/). -- GitLab