Node.js

Edit page
Last modified: 26 April 2022

The Node.js build runner allows running Node.js tools like npm, yarn, and node.

Refer to Configuring Build Steps for a description of common build steps' settings.

Prerequisites

Currently, Node.js steps can only be run inside a Docker container. Refer to Docker Wrapper for general information about available Docker settings.

You can define what version of Node.js to use for the current build step. TeamCity uses a node:lts image by default, or, if there is an .nvmrc file inside your project, it will search for the image specification there.

Autodetecting JavaScript Steps

If your repository contains a package.json file, TeamCity will automatically detect used frameworks and propose adding respective build steps.

note

If TeamCity detects a dependency on a test framework, it will propose choosing between two steps: run tests via this framework or with a general test command. To display structured test reports in TeamCity, select the step with the framework.

Currently supported frameworks are ESlint, Jest, and Mocha.

If TeamCity detects an .nvmrc file, it will automatically use the node version specified in it.

Running Node.js Commands

In the Shell script field, enter all Node.js commands to be executed in this step.

Accessing Private NPM Registries

To access a private npm registry during a build (for example, to download a package), you need to:

  1. Configure an NPM Registry connection as described here.

  2. In Build Configuration Settings | Build Features, add an NPM Registry Connection build feature and select the new connection, so it can be used in this configuration.

As a result, a TeamCity agent will authenticate in this registry during the build.

note

Note that TeamCity will only be able to access registries where automation tokens are allowed. If your connection test fails in TeamCity, revise the registry settings.

Alternatively to this procedure, you can let TeamCity parse a token from the .npmrc file inside your JS project. To achieve this, declare a token variable in this file as specified here and then create an environment variable NPM_TOKEN in TeamCity with the value of the access token and the "Password" type.

warning

If a token is configured in your NPM registry connection, TeamCity will use it for connecting to this registry. However, there is known issue when TeamCity might use the token specified in the .npmrc file instead of that in the connection settings. See the workarounds to this issue in our tracker.