cds:npx

Full name:

com.sap.cds:cds-maven-plugin:2.9.0:npx

Description:

Execute an npx command on the CAP Java project.

Attributes:

  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 1.25.0.
  • Binds by default to the lifecycle phase: initialize.

Required Parameters

Name Type Since Description
<arguments> String - Add a line of space-separated arguments passed to npx for execution. For example: cowsay goodbye!.
User Property: cds.npx.arguments

Optional Parameters

Name Type Since Description
<environmentVariables> Map<String,String> 1.26.0 Additional environment variables to set on the command line.
<npmRegistry> String - URL of NPM registry to use.
User Property: cds.npm.registry
<outputFile> File - Define an optional file to redirect standard and error output to. If not specified, the standard Maven logging is used.
User Property: cds.npx.outputFile
<skip> boolean - Skip execution of this goal.
Default: false
User Property: cds.npx.skip
<workingDirectory> File - The working directory to use during npx command execution. If not specified, the goal uses the directory containing a .cdsrc.json or package.json file. It goes up the project hierarchy on the file system until one of these files is found or the top-level project directory is reached.
User Property: cds.npx.workingDirectory

Parameter Details

<arguments>
Add a line of space-separated arguments passed to npx for execution. For example: cowsay goodbye!.
  • Type: java.lang.String
  • Required: Yes
  • User Property: cds.npx.arguments

<environmentVariables>
Additional environment variables to set on the command line.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 1.26.0
  • Required: No

<npmRegistry>
URL of NPM registry to use.
  • Type: java.lang.String
  • Required: No
  • User Property: cds.npm.registry

<outputFile>
Define an optional file to redirect standard and error output to. If not specified, the standard Maven logging is used.
  • Type: java.io.File
  • Required: No
  • User Property: cds.npx.outputFile
Skip execution of this goal.
  • Type: boolean
  • Required: No
  • User Property: cds.npx.skip
  • Default: false

<workingDirectory>
The working directory to use during npx command execution. If not specified, the goal uses the directory containing a .cdsrc.json or package.json file. It goes up the project hierarchy on the file system until one of these files is found or the top-level project directory is reached.
  • Type: java.io.File
  • Required: No
  • User Property: cds.npx.workingDirectory