npmpack:grunt

Full name:

net.kozelka.maven:npmpack-maven-plugin:1.0-SNAPSHOT:grunt

Description:

Executes grunt in order to perform grunt-based build.

Attributes:

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

Required Parameters

Name Type Since Description
anonymize boolean -

If set, the computed checksum is performed on top of anonymized package.json file; this is useful when working with multiple modules with equal dependencies, as it ensures that they share the same cached artifact.

If unset, only line endings are normalized to LF prior to checksum.

Anonymization is a simple process which replaces properties that identify the module with neutral identification; currently it is string "ANONYMIZED" in properties "name" and "version". Note that the package.json is also sorted (properties by name, recursively) and pretty-printed, so that all insignificant differences are eliminated.

The file node_modules/package.json always c
Default value is: true.
basedir File - Current project directory. Used internally to run grunt from the module's directory.
Default value is: ${basedir}.
gruntCommand String - The specific grunt command to execute. This is passed as the (whitespace separated) argument list to grunt.
Default value is: build.
gruntExecutables String - The executable to run as grunt. We expect that it resides under node_modules/.bin.
Default value is: grunt,grunt.cmd.
User property is: grunt.executable.
node_modules File - Pointer to node_modules directory.

Recommended use: do not change if you wish to use npm-based tools from commandline as well. Otherwise it might be practical to change this to "${project.build.directory}/node_modules".


Default value is: node_modules.
npmExecutables String - The executable to run as NPM. By default, we expect that it is available on PATH.
Default value is: npm,npm.cmd.
User property is: npm.executable.
packageJson File - Pointer to package.json file.

Recommended use: do not change


Default value is: package.json.
skip boolean - The execution is skipped it this is true.
Default value is: false.
User property is: grunt.skip.
taskName String - The name to be used in prefix of this grunt command execution
Default value is: grunt.

Parameter Details

anonymize:

If set, the computed checksum is performed on top of anonymized package.json file; this is useful when working with multiple modules with equal dependencies, as it ensures that they share the same cached artifact.

If unset, only line endings are normalized to LF prior to checksum.

Anonymization is a simple process which replaces properties that identify the module with neutral identification; currently it is string "ANONYMIZED" in properties "name" and "version". Note that the package.json is also sorted (properties by name, recursively) and pretty-printed, so that all insignificant differences are eliminated.

The file node_modules/package.json always c
  • Type: boolean
  • Required: Yes
  • Default: true

basedir:

Current project directory. Used internally to run grunt from the module's directory.
  • Type: java.io.File
  • Required: Yes
  • Default: ${basedir}

gruntCommand:

The specific grunt command to execute. This is passed as the (whitespace separated) argument list to grunt.
  • Type: java.lang.String
  • Required: Yes
  • Default: build

gruntExecutables:

The executable to run as grunt. We expect that it resides under node_modules/.bin.
  • Type: java.lang.String
  • Required: Yes
  • User Property: grunt.executable
  • Default: grunt,grunt.cmd

node_modules:

Pointer to node_modules directory.

Recommended use: do not change if you wish to use npm-based tools from commandline as well. Otherwise it might be practical to change this to "${project.build.directory}/node_modules".

  • Type: java.io.File
  • Required: Yes
  • Default: node_modules

npmExecutables:

The executable to run as NPM. By default, we expect that it is available on PATH.
  • Type: java.lang.String
  • Required: Yes
  • User Property: npm.executable
  • Default: npm,npm.cmd

packageJson:

Pointer to package.json file.

Recommended use: do not change

  • Type: java.io.File
  • Required: Yes
  • Default: package.json

skip:

The execution is skipped it this is true.
  • Type: boolean
  • Required: Yes
  • User Property: grunt.skip
  • Default: false

taskName:

The name to be used in prefix of this grunt command execution
  • Type: java.lang.String
  • Required: Yes
  • Default: grunt