Produit par Maven

i18n:bundle

Nom complet :

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

Description :

Generate an aggregate i18n bundle for all dependencies of the project. The main idea is to have a final unique i18n bundle for an application to launch, this really improve i18n loading time to have a unique named bundle, no need to seek in all dependencies... Moreover, this permits also to deal with order of i18n keys, more precisely, we want to use the higher level i18n key for an application. If the i18n key is present on a library, we want to be able to override it in application (or user wants it:)). This goal permits this using the dependencies graph order of artifacts.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • Exige une résolution des dépendances des artefacts dans le scope : runtime.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Depuis la version : 0.12.
  • S'associe par défaut dans la phase du cycle de vie : generate-resources.
  • Appelle l'exécution du goal de ce plugin collect-i18n-artifacts avant de s'exécuter.

Paramètres requis

Nom Type Depuis Description
<bundleOutputDir> File 1.0.0 Root directory where to generate aggregated bundles (this directory will be added as resources of the project).
Valeur par défaut : ${basedir}/target/generated-sources/resources.
Propriété utilisateur : i18n.bundleOutputDir.
<bundleOutputName> String 1.0.2 Name of the bundle to generate.
Valeur par défaut : ${project.artifactId}-i18n.
Propriété utilisateur : i18n.bundleOutputName.
<bundleOutputPackage> String 2.3.2 Package name of the generate aggregated bundles. Note: By default we use the META-INF package since it is the favorite package of I18n runtime initializer. The package name is dotted as it will be stored as folder like in Java language. Example : 
    package name : foo.bar
    directory    : foo/bar

Valeur par défaut : META-INF.
Propriété utilisateur : i18n.bundleOutputPackage.
<bundles> String 0.12 Locales to treate, separated by comma. Example : 
fr_FR,en_GB

Valeur par défaut : fr_FR,en_GB.
Propriété utilisateur : i18n.bundles.
<collectOutputDir> File 1.0.2 Directory where to generate bundles.
Valeur par défaut : ${basedir}/target/i18n.
Propriété utilisateur : i18n.collectOutputDir.
<collectOutputName> String 1.0.2 BAse name of file which contains bundles locations.
Valeur par défaut : collect-${project.artifactId}-i18n.
Propriété utilisateur : i18n.collectOutputName.
<encoding> String 0.12 Encoding used to load and store properties.
Valeur par défaut : ${project.build.sourceEncoding}.
Propriété utilisateur : i18n.encoding.

Paramètres optionnels

Nom Type Depuis Description
<bundleCsvFile> File 2.5 Obsolète. since 3.3, prefer use the new mojo generate-csv-bundle instead
Valeur par défaut : ${basedir}/target/${project.artifactId}-i18n.csv.
Propriété utilisateur : i18n.bundleCsvFile.
<bundleCsvSeparator> String 2.5 Obsolète. since 3.3, prefer use the new mojo generate-csv-bundle instead
Valeur par défaut : .
Propriété utilisateur : i18n.bundleCsvSeparator.
<bundleFormatConverter> String 2.4 Converter used to change format of bundles.
Propriété utilisateur : i18n.bundleFormatConverter.
<bundleInputEncoding> String 2.4 Encoding used to load any i18n property files. If not defined, will use the encoding parameter.
Propriété utilisateur : i18n.bundleInputEncoding.
<bundleOutputEncoding> String 2.4 Encoding used to write any i18n property files. If not defined, will use the encoding parameter.
Propriété utilisateur : i18n.bundleOutputEncoding.
<checkBundle> boolean 1.0.0 A flag to check that bundles are complete (no missing i18n translations). Note : This behaviour will be activated is failsIfWarning is on.
Valeur par défaut : true.
Propriété utilisateur : i18n.checkBundle.
<failsIfAnyKeyMissingInBundle> boolean 3.6.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.
Valeur par défaut : false.
Propriété utilisateur : i18n.failsIfAnyKeyMissingInBundle.
<failsIfAnyKeyMissingValue> boolean 3.6.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.
Valeur par défaut : false.
Propriété utilisateur : i18n.failsIfAnyKeyMissingValue.
<failsIfWarning> boolean 2.0 Obsolète. since 3.6.1, prefer use now failsIfAnyKeyMissingValue or failsIfAnyKeyMissingInBundle.
Valeur par défaut : false.
Propriété utilisateur : i18n.failsIfWarning.
<generateCsvFile> boolean 2.5 Obsolète. since 3.3, prefer use the new mojo generate-csv-bundle instead
Valeur par défaut : false.
Propriété utilisateur : i18n.generateCsvFile.
<generateDefaultLocale> boolean 2.1 A flag to generate a bundle with the first locale defined as a default bundle (with no locale specialization).
Valeur par défaut : false.
Propriété utilisateur : i18n.generateDefaultLocale.
<generateDefinitionFile> boolean 2.0 A flag to generate the i18n definition file. This file contains all generated bundles and the paths of all i18n artifacts used to make it.
Valeur par défaut : true.
Propriété utilisateur : i18n.generateDefinitionFile.
<showEmpty> boolean 1.0.0 A flag to show missing i18n translation. Note : Need the checkBundle to be activated).
Valeur par défaut : false.
Propriété utilisateur : i18n.showEmpty.
<silent> boolean 1.0.0-rc-5 Silent flag to see only errors in console.
Valeur par défaut : false.
Propriété utilisateur : i18n.silent.
<verbose> boolean 0.12 Verbose flag. Note : if not setted, we used the maven.verbose property.
Valeur par défaut : ${maven.verbose}.
Propriété utilisateur : i18n.verbose.

Détails des paramètres

<bundleCsvFile>

Obsolète. since 3.3, prefer use the new mojo generate-csv-bundle instead
Location of the csv file to generate if parameter generateCsvFile is on.
  • Type : java.io.File
  • Depuis : 2.5
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleCsvFile
  • Défaut : ${basedir}/target/${project.artifactId}-i18n.csv

<bundleCsvSeparator>

Obsolète. since 3.3, prefer use the new mojo generate-csv-bundle instead
Char separator used when generating the csv bundle file if parameter generateCsvFile is on.
  • Type : java.lang.String
  • Depuis : 2.5
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleCsvSeparator
  • Défaut :

<bundleFormatConverter>

Converter used to change format of bundles.
  • Type : java.lang.String
  • Depuis : 2.4
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleFormatConverter

<bundleInputEncoding>

Encoding used to load any i18n property files. If not defined, will use the encoding parameter.
  • Type : java.lang.String
  • Depuis : 2.4
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleInputEncoding

<bundleOutputDir>

Root directory where to generate aggregated bundles (this directory will be added as resources of the project).
  • Type : java.io.File
  • Depuis : 1.0.0
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundleOutputDir
  • Défaut : ${basedir}/target/generated-sources/resources

<bundleOutputEncoding>

Encoding used to write any i18n property files. If not defined, will use the encoding parameter.
  • Type : java.lang.String
  • Depuis : 2.4
  • Exigé : Non
  • Propriété utilisateur : i18n.bundleOutputEncoding

<bundleOutputName>

Name of the bundle to generate.
  • Type : java.lang.String
  • Depuis : 1.0.2
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundleOutputName
  • Défaut : ${project.artifactId}-i18n

<bundleOutputPackage>

Package name of the generate aggregated bundles. Note: By default we use the META-INF package since it is the favorite package of I18n runtime initializer. The package name is dotted as it will be stored as folder like in Java language. Example : 
    package name : foo.bar
    directory    : foo/bar
  • Type : java.lang.String
  • Depuis : 2.3.2
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundleOutputPackage
  • Défaut : META-INF

<bundles>

Locales to treate, separated by comma. Example : 
fr_FR,en_GB
  • Type : java.lang.String
  • Depuis : 0.12
  • Exigé : Oui
  • Propriété utilisateur : i18n.bundles
  • Défaut : fr_FR,en_GB

<checkBundle>

A flag to check that bundles are complete (no missing i18n translations). Note : This behaviour will be activated is failsIfWarning is on.
  • Type : boolean
  • Depuis : 1.0.0
  • Exigé : Non
  • Propriété utilisateur : i18n.checkBundle
  • Défaut : true

<collectOutputDir>

Directory where to generate bundles.
  • Type : java.io.File
  • Depuis : 1.0.2
  • Exigé : Oui
  • Propriété utilisateur : i18n.collectOutputDir
  • Défaut : ${basedir}/target/i18n

<collectOutputName>

BAse name of file which contains bundles locations.
  • Type : java.lang.String
  • Depuis : 1.0.2
  • Exigé : Oui
  • Propriété utilisateur : i18n.collectOutputName
  • Défaut : collect-${project.artifactId}-i18n

<encoding>

Encoding used to load and store properties.
  • Type : java.lang.String
  • Depuis : 0.12
  • Exigé : Oui
  • Propriété utilisateur : i18n.encoding
  • Défaut : ${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
  • Depuis : 3.6.1
  • Exigé : Non
  • Propriété utilisateur : i18n.failsIfAnyKeyMissingInBundle
  • Défaut : 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
  • Depuis : 3.6.1
  • Exigé : Non
  • Propriété utilisateur : i18n.failsIfAnyKeyMissingValue
  • Défaut : false

<failsIfWarning>

Obsolète. since 3.6.1, prefer use now failsIfAnyKeyMissingValue or failsIfAnyKeyMissingInBundle.
A flag to make the build fails if there is some warnings while generating bundle, says when it misses some translations. Note : This parameter should be used in a release profile to ensure bundles are complete.
  • Type : boolean
  • Depuis : 2.0
  • Exigé : Non
  • Propriété utilisateur : i18n.failsIfWarning
  • Défaut : false

<generateCsvFile>

Obsolète. since 3.3, prefer use the new mojo generate-csv-bundle instead
A flag to generate the i18n csv file wich contains all translation for all locales. Useful to translate from a language to another one.
  • Type : boolean
  • Depuis : 2.5
  • Exigé : Non
  • Propriété utilisateur : i18n.generateCsvFile
  • Défaut : false

<generateDefaultLocale>

A flag to generate a bundle with the first locale defined as a default bundle (with no locale specialization).
  • Type : boolean
  • Depuis : 2.1
  • Exigé : Non
  • Propriété utilisateur : i18n.generateDefaultLocale
  • Défaut : false

<generateDefinitionFile>

A flag to generate the i18n definition file. This file contains all generated bundles and the paths of all i18n artifacts used to make it.
  • Type : boolean
  • Depuis : 2.0
  • Exigé : Non
  • Propriété utilisateur : i18n.generateDefinitionFile
  • Défaut : true

<showEmpty>

A flag to show missing i18n translation. Note : Need the checkBundle to be activated).
  • Type : boolean
  • Depuis : 1.0.0
  • Exigé : Non
  • Propriété utilisateur : i18n.showEmpty
  • Défaut : false

<silent>

Silent flag to see only errors in console.
  • Type : boolean
  • Depuis : 1.0.0-rc-5
  • Exigé : Non
  • Propriété utilisateur : i18n.silent
  • Défaut : false

<verbose>

Verbose flag. Note : if not setted, we used the maven.verbose property.
  • Type : boolean
  • Depuis : 0.12
  • Exigé : Non
  • Propriété utilisateur : i18n.verbose
  • Défaut : ${maven.verbose}