Package com.sap.cds.maven.plugin.build
Class NpxMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
com.sap.cds.maven.plugin.AbstractCdsMojo
com.sap.cds.maven.plugin.build.NpxMojo
- All Implemented Interfaces:
CdsMojoLogger
,org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Mojo(name="npx",
defaultPhase=INITIALIZE,
aggregator=true,
requiresProject=false)
public class NpxMojo
extends AbstractCdsMojo
Execute an
npx
command on the CAP Java project.- Since:
- 1.25.0
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected org.eclipse.aether.RepositorySystemSession
Defines settings and components that control the repository system.Fields inherited from class com.sap.cds.maven.plugin.AbstractCdsMojo
buildContext, CDS_SERVICES_GROUPID, mojoExecution, PLUGIN_KEY, project, session, settings
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
protected void
execute
(File workDir, File execFile, OutputStream outputStream, Map<String, String> additionalEnv, int[] exitValues, String... args) Executes a program as child process.protected String
executeNpm
(File workDir, int[] exitValues, String... args) protected void
executeNpm
(File workDir, File outputFile, String... args) protected String
executeNpm
(File workDir, String... args) protected File
Finds the cds working directory by going upwards and looking for a .cdsrc.json file.void
setNpxExec
(File npxExec) Gets called to inject parameter "npxExec".void
setWorkingDirectory
(File workingDirectory) Gets called to inject parameter "workingDirectory".Methods inherited from class com.sap.cds.maven.plugin.AbstractCdsMojo
ensureCliExecuted, findGoalExecution, findSrvProject, getReactorBaseDirectory, isCliExecuted, logDebug, logDebug, logError, logError, logError, logInfo, logWarn, logWarn, logWarn, scanDirectory, setProperty, strong
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
PROP_NODE_DIR
- See Also:
-
PROP_NODE_EXECUTABLE
- See Also:
-
PROP_NPM_EXECUTABLE
- See Also:
-
PROP_NPX_EXECUTABLE
- See Also:
-
PARAM_NODE_DIR
- See Also:
-
PARAM_NPX_EXECUTABLE
- See Also:
-
PARAM_NPM_EXECUTABLE
- See Also:
-
repositorySystemSession
@Parameter(defaultValue="${repositorySystemSession}", required=true, readonly=true) protected org.eclipse.aether.RepositorySystemSession repositorySystemSessionDefines settings and components that control the repository system.
-
-
Constructor Details
-
NpxMojo
public NpxMojo()
-
-
Method Details
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException- Throws:
org.apache.maven.plugin.MojoExecutionException
-
setNpxExec
Gets called to inject parameter "npxExec".- Parameters:
npxExec
- aFile
pointing to npx executable
-
setWorkingDirectory
Gets called to inject parameter "workingDirectory".- Parameters:
workingDirectory
- aFile
pointing to working directory
-
executeNpm
- Throws:
IOException
-
executeNpm
- Throws:
IOException
-
executeNpm
- Throws:
IOException
-
execute
protected void execute(File workDir, File execFile, OutputStream outputStream, Map<String, String> additionalEnv, int[] exitValues, String... args) throws IOExceptionExecutes a program as child process.- Parameters:
workDir
- the working directory of child processexecFile
- the executable to useoutputStream
- an optional standard output streamadditionalEnv
- additional environment variables, can benull
exitValues
- an optional list with exit values of the process to be considered successful, can benull
args
- an optional command line arguments passed to the process- Throws:
IOException
- if an I/O exception occurredorg.apache.commons.exec.ExecuteException
- if process execution failed
-
findCdsWorkingDir
Finds the cds working directory by going upwards and looking for a .cdsrc.json file. It stops at the top-most project directory.- Returns:
- the cds working directory or
null
if not found.
-