Built by Maven

typescript:npm-install

Full name:

de.eitco.cicd:typescript-maven-plugin:4.0.10:npm-install

Description:

This goal basically executes npm install.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: generate-resources.

Optional Parameters

Name Type Since Description
<additionalScripts> Map<String,String> - This parameter specifies additional scripts to be written to the package.json. Those scripts can be executed using the frontend-maven-plugin.
<angularCompilerOptions> AngularCompilerOptions - This parameter specifies the angularCompilerOptions element of the generated tsconfig.json file.
<compileOptions> CompilerOptions - This parameter specifies the compile options to the typescript compiler.
<defaultDependencies> List<NpmDependency> - This parameter specifies a list of npm dependencies to add to the package compiled. The difference to the parameter {@link #dependencies} is that this property is intended as a list of default dependencies specified in a common super pom, so that individual projects may add their dependencies without overwriting the default dependencies
<defaultValues> File - This parameter holds the name of a package json file that will be merged with the package configuration given by the maven parameters
User Property: typescript.default.package.json
<dependencies> List<NpmDependency> - This parameter specifies a list of npm dependencies to add to the package compiled.
<distributionDirectory> File - This parameter specifies a directory where distribution package should be compiled to and be packaged from.
Default: ${project.build.directory}/dist
<environmentVariables> Map<String,String> - Additional environment variables to pass to the build.
<force> boolean - This parameter specifies whether the --force command line option is set.
Default: false
User Property: typescript.install.force
<installDirectory> File - The base directory for installing node and npm.
User Property: installDirectory
<keywords> List<String> - This parameter specifies a set of keywords to add to the projects package.json file.
<legacyPeerDeps> boolean - This parameter specifies whether the --legacy-peer-deps command line option is set.
Default: false
User Property: typescript.install.legacyPeerDeps
<npmRegistryURL> String - This parameter specifies the npm registry to load dependencies from. If left empty the default registry (https://registry.npmjs.org/) will be used.
User Property: npmRegistryURL
<projectName> String - This parameter specifies the name of the project. This is the unique name the generated package will be referenced with.
Default: ${project.artifactId}
User Property: typescript.project.name
<projectVersion> String - This parameter specifies the version of the package deployed.
Default: ${project.version}
User Property: typescript.project.version
<publishRegistryURL> String - This parameter specifies the npm registry to publish the generated package to. If left empty, the value of npmRegistryURL will be used instead.
User Property: typescript.publish.registry.url
<schematics> String - This parameter specifies the name of a schematic to be added to the package.json.
<skip> boolean - This parameter specifies whether the typescript plugin goals should be executed or not.
Default: false
User Property: ts.skip
<skipTests> Boolean - Whether you should skip while running in the test phase (default is false)
Default: false
User Property: skipTests
<snapshotVersionSuffix> String - This parameter specifies a suffix appended to the projects' version if and only if this version ends with "-SNAPSHOT"
User Property: typescript.snapshot.version.suffix
<sourceExcludes> List<String> - This parameter specifies the sources to exclude from compiling.
<sources> List<String> - This parameter specifies the location of the typescript source files to compile.
<testCompileOptions> CompilerOptions - This parameter specifies the compile options to the typescript compiler when compiling test sources. This options will be used when generating the tsconfig.spec.json, which will always derive from tsconfig.json generated from the {@link #compileOptions compile options parameter}.
<testFailureIgnore> boolean 1.4 Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.
Default: false
User Property: maven.test.failure.ignore
<testSourceExcludes> List<String> - This parameter specifies sources to exclude from test compiling.
<testSources> List<String> - This parameter specifies the location of the test source files.
<typeScriptVersion> String - This parameter specifies the typescript version
Default: 4.6.2
User Property: typescript.version
<typescriptEntryPoint> String - This parameter specifies the name of the file implementing the entry point to the package. Omit the file suffix.
Default: import
<verbose> boolean - This parameter specifies whether the command line option verbose should be given to any npm execution.
Default: false
User Property: typescript.verbose
<workingDirectory> File - The base directory for running all Node commands. (Usually the directory that contains package.json)
Default: ${basedir}
User Property: workingDirectory

Parameter Details

<additionalScripts>

This parameter specifies additional scripts to be written to the package.json. Those scripts can be executed using the frontend-maven-plugin.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<angularCompilerOptions>

This parameter specifies the angularCompilerOptions element of the generated tsconfig.json file.
  • Type: de.eitco.cicd.typescript.maven.plugin.AngularCompilerOptions
  • Required: No

<compileOptions>

This parameter specifies the compile options to the typescript compiler.
  • Type: de.eitco.cicd.typescript.maven.plugin.CompilerOptions
  • Required: No

<defaultDependencies>

This parameter specifies a list of npm dependencies to add to the package compiled. The difference to the parameter {@link #dependencies} is that this property is intended as a list of default dependencies specified in a common super pom, so that individual projects may add their dependencies without overwriting the default dependencies
  • Type: java.util.List<de.eitco.cicd.typescript.maven.plugin.NpmDependency>
  • Required: No

<defaultValues>

This parameter holds the name of a package json file that will be merged with the package configuration given by the maven parameters
  • Type: java.io.File
  • Required: No
  • User Property: typescript.default.package.json

<dependencies>

This parameter specifies a list of npm dependencies to add to the package compiled.
  • Type: java.util.List<de.eitco.cicd.typescript.maven.plugin.NpmDependency>
  • Required: No

<distributionDirectory>

This parameter specifies a directory where distribution package should be compiled to and be packaged from.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/dist

<environmentVariables>

Additional environment variables to pass to the build.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<force>

This parameter specifies whether the --force command line option is set.
  • Type: boolean
  • Required: No
  • User Property: typescript.install.force
  • Default: false

<installDirectory>

The base directory for installing node and npm.
  • Type: java.io.File
  • Required: No
  • User Property: installDirectory

<keywords>

This parameter specifies a set of keywords to add to the projects package.json file.
  • Type: java.util.List<java.lang.String>
  • Required: No

<legacyPeerDeps>

This parameter specifies whether the --legacy-peer-deps command line option is set.
  • Type: boolean
  • Required: No
  • User Property: typescript.install.legacyPeerDeps
  • Default: false

<npmRegistryURL>

This parameter specifies the npm registry to load dependencies from. If left empty the default registry (https://registry.npmjs.org/) will be used.
  • Type: java.lang.String
  • Required: No
  • User Property: npmRegistryURL

<projectName>

This parameter specifies the name of the project. This is the unique name the generated package will be referenced with.
  • Type: java.lang.String
  • Required: No
  • User Property: typescript.project.name
  • Default: ${project.artifactId}

<projectVersion>

This parameter specifies the version of the package deployed.
  • Type: java.lang.String
  • Required: No
  • User Property: typescript.project.version
  • Default: ${project.version}

<publishRegistryURL>

This parameter specifies the npm registry to publish the generated package to. If left empty, the value of npmRegistryURL will be used instead.
  • Type: java.lang.String
  • Required: No
  • User Property: typescript.publish.registry.url

<schematics>

This parameter specifies the name of a schematic to be added to the package.json.
  • Type: java.lang.String
  • Required: No

<skip>

This parameter specifies whether the typescript plugin goals should be executed or not.
  • Type: boolean
  • Required: No
  • User Property: ts.skip
  • Default: false

<skipTests>

Whether you should skip while running in the test phase (default is false)
  • Type: java.lang.Boolean
  • Required: No
  • User Property: skipTests
  • Default: false

<snapshotVersionSuffix>

This parameter specifies a suffix appended to the projects' version if and only if this version ends with "-SNAPSHOT"
  • Type: java.lang.String
  • Required: No
  • User Property: typescript.snapshot.version.suffix

<sourceExcludes>

This parameter specifies the sources to exclude from compiling.
  • Type: java.util.List<java.lang.String>
  • Required: No

<sources>

This parameter specifies the location of the typescript source files to compile.
  • Type: java.util.List<java.lang.String>
  • Required: No

<testCompileOptions>

This parameter specifies the compile options to the typescript compiler when compiling test sources. This options will be used when generating the tsconfig.spec.json, which will always derive from tsconfig.json generated from the {@link #compileOptions compile options parameter}.
  • Type: de.eitco.cicd.typescript.maven.plugin.CompilerOptions
  • Required: No

<testFailureIgnore>

Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Since: 1.4
  • Required: No
  • User Property: maven.test.failure.ignore
  • Default: false

<testSourceExcludes>

This parameter specifies sources to exclude from test compiling.
  • Type: java.util.List<java.lang.String>
  • Required: No

<testSources>

This parameter specifies the location of the test source files.
  • Type: java.util.List<java.lang.String>
  • Required: No

<typeScriptVersion>

This parameter specifies the typescript version
  • Type: java.lang.String
  • Required: No
  • User Property: typescript.version
  • Default: 4.6.2

<typescriptEntryPoint>

This parameter specifies the name of the file implementing the entry point to the package. Omit the file suffix.
  • Type: java.lang.String
  • Required: No
  • Default: import

<verbose>

This parameter specifies whether the command line option verbose should be given to any npm execution.
  • Type: boolean
  • Required: No
  • User Property: typescript.verbose
  • Default: false

<workingDirectory>

The base directory for running all Node commands. (Usually the directory that contains package.json)
  • Type: java.io.File
  • Required: No
  • User Property: workingDirectory
  • Default: ${basedir}