Built by Maven

i18n:gen

Full name:

org.nuiton.i18n:i18n-maven-plugin:4.1:gen

Description:

Merge new generated i18n bundles with older existing ones.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 3.3.
  • Binds by default to the lifecycle phase: generate-resources.
  • Invokes the execution of this plugin's goal get prior to executing itself.

Required Parameters

Name Type Since Description
<bundles> String 3.3 Locales to treate, separated by comma. Example : 
fr_FR,en_GB

Default value is: fr_FR,en_GB.
User property is: i18n.bundles.
<checkBundle> boolean 1.0.0 A flag to check that bundles are complete (no missing i18n translations).
Default value is: true.
User property is: i18n.checkBundle.
<encoding> String 3.3 Encoding used to load and store properties.
Default value is: ${project.build.sourceEncoding}.
User property is: i18n.encoding.
<out> File 3.3 Directory where to generate i18n files.
Default value is: ${basedir}/target/generated-sources/i18n.
User property is: i18n.out.
<showEmpty> boolean 1.0.0 A flag to show missing i18n translation. Note : Need the checkBundle to be activated).
Default value is: false.
User property is: i18n.showEmpty.
<src> File 3.3 Directory where to find project i18n files.
Default value is: ${basedir}/src/main/resources/i18n.
User property is: i18n.src.

Optional Parameters

Name Type Since Description
<failsIfAnyKeyMissingInBundle> boolean 3.5.1 A flag to make the build fails if there is some missing keys. Note : This parameter should be used in a release profile to ensure bundles are complete.
Default value is: false.
User property is: i18n.failsIfAnyKeyMissingInBundle.
<failsIfAnyKeyMissingValue> boolean 3.5.1 A flag to make the build fails if there is some missing key values. Note : This parameter should be used in a release profile to ensure bundles are complete.
Default value is: false.
User property is: i18n.failsIfAnyKeyMissingValue.
<failsIfWarning> boolean 3.3 (no description)
Default value is: false.
User property is: i18n.failsIfWarning.
<genSrc> boolean 3.3 To update generated files to user i18n files. Note : By default, this is active, in order to have a project uptodate with last i18n bundles detected.
Default value is: true.
User property is: i18n.genSrc.
<keepBackup> boolean 3.3 To keep a backup of old i18n bundles (suffiex by a ~). Note: By default, this property is not active.
Default value is: false.
User property is: i18n.keepBackup.
<keepGetters> boolean 3.3 To keep generated getter files. Note: By default, this property is not active.
Default value is: false.
User property is: i18n.keepGetters.
<silent> boolean 1.0.0-rc-5 Silent flag to see only errors in console.
Default value is: false.
User property is: i18n.silent.
<strictMode> boolean 3.3 Strict mode to only keep in user i18n detected i18n keys and remove obsolete keys. Note : By default not active. Use this with care since it can delete keys. Moreover if this flag is activated, then all files will be parsed.
Default value is: false.
User property is: i18n.strictMode.
<verbose> boolean 3.3 Verbose flag. Note : if not setted, we used the maven.verbose property.
Default value is: ${maven.verbose}.
User property is: i18n.verbose.

Parameter Details

<bundles>

Locales to treate, separated by comma. Example : 
fr_FR,en_GB
  • Type: java.lang.String
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.bundles
  • Default: fr_FR,en_GB

<checkBundle>

A flag to check that bundles are complete (no missing i18n translations).
  • Type: boolean
  • Since: 1.0.0
  • Required: Yes
  • User Property: i18n.checkBundle
  • Default: true

<encoding>

Encoding used to load and store properties.
  • Type: java.lang.String
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.encoding
  • Default: ${project.build.sourceEncoding}

<failsIfAnyKeyMissingInBundle>

A flag to make the build fails if there is some missing keys. Note : This parameter should be used in a release profile to ensure bundles are complete.
  • Type: boolean
  • Since: 3.5.1
  • Required: No
  • User Property: i18n.failsIfAnyKeyMissingInBundle
  • Default: false

<failsIfAnyKeyMissingValue>

A flag to make the build fails if there is some missing key values. Note : This parameter should be used in a release profile to ensure bundles are complete.
  • Type: boolean
  • Since: 3.5.1
  • Required: No
  • User Property: i18n.failsIfAnyKeyMissingValue
  • Default: false

<failsIfWarning>

(no description)
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.failsIfWarning
  • Default: false

<genSrc>

To update generated files to user i18n files. Note : By default, this is active, in order to have a project uptodate with last i18n bundles detected.
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.genSrc
  • Default: true

<keepBackup>

To keep a backup of old i18n bundles (suffiex by a ~). Note: By default, this property is not active.
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.keepBackup
  • Default: false

<keepGetters>

To keep generated getter files. Note: By default, this property is not active.
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.keepGetters
  • Default: false

<out>

Directory where to generate i18n files.
  • Type: java.io.File
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.out
  • Default: ${basedir}/target/generated-sources/i18n

<showEmpty>

A flag to show missing i18n translation. Note : Need the checkBundle to be activated).
  • Type: boolean
  • Since: 1.0.0
  • Required: Yes
  • User Property: i18n.showEmpty
  • Default: false

<silent>

Silent flag to see only errors in console.
  • Type: boolean
  • Since: 1.0.0-rc-5
  • Required: No
  • User Property: i18n.silent
  • Default: false

<src>

Directory where to find project i18n files.
  • Type: java.io.File
  • Since: 3.3
  • Required: Yes
  • User Property: i18n.src
  • Default: ${basedir}/src/main/resources/i18n

<strictMode>

Strict mode to only keep in user i18n detected i18n keys and remove obsolete keys. Note : By default not active. Use this with care since it can delete keys. Moreover if this flag is activated, then all files will be parsed.
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.strictMode
  • Default: false

<verbose>

Verbose flag. Note : if not setted, we used the maven.verbose property.
  • Type: boolean
  • Since: 3.3
  • Required: No
  • User Property: i18n.verbose
  • Default: ${maven.verbose}