Produit par Maven

nuiton-config:report

Note :Ce goal doit être utilisé comme un rapport de Maven.

Nom complet :

org.nuiton:nuiton-config-maven-plugin:3.5-SNAPSHOT:report

Description :

Generates a report for declared application config via the ApplicationConfigProvider mechanism.

For each configuration, you can find all his options and actions.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • S'exécute seulement comme un reportSet (goal de reporting).
  • Exige une résolution des dépendances des artefacts dans le scope : runtime.
  • Depuis la version : 3.0.

Paramètres requis

Nom Type Depuis Description
<outputDirectory> File 3.0 Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
Valeur par défaut : ${project.reporting.outputDirectory}.
Propriété utilisateur : config.outputDirectory.
<outputEncoding> String 3.0 Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.
Valeur par défaut : ${project.reporting.outputEncoding}.
Propriété utilisateur : config.outputEncoding.
<project> MavenProject 3.0 The Maven Project.
Valeur par défaut : ${project}.

Paramètres optionnels

Nom Type Depuis Description
<exclude> String 3.0 List of application config to exclude from report (separated by comma).

Note: If not filled no config will be exclude.


Propriété utilisateur : config.exclude.
<i18nBundleName> String 3.0 Optional i18n bundle name as used by the nuiton I18n system to init his files.

If not given, will look at all i18n files in all over class-path (which could be costy if many dependencies), otherwise will init I18n system usinga DefaultI18nInitializer with this bundle name.


Propriété utilisateur : config.i18nBundleName.
<include> String 3.0 List of application config to include in report (separated by comma).

Note: If not filled then will use all config found in class-path.


Propriété utilisateur : config.include.
<skip> boolean 3.0 Skip to generate the report.
Propriété utilisateur : config.skip.
<verbose> boolean 3.0 Flag to activate verbose mode.

Note: Verbose mode is always on if you starts a debug maven instance (says via -X).


Valeur par défaut : ${maven.verbose}.
Propriété utilisateur : config.verbose.

Détails des paramètres

<exclude>

List of application config to exclude from report (separated by comma).

Note: If not filled no config will be exclude.

  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.exclude

<i18nBundleName>

Optional i18n bundle name as used by the nuiton I18n system to init his files.

If not given, will look at all i18n files in all over class-path (which could be costy if many dependencies), otherwise will init I18n system usinga DefaultI18nInitializer with this bundle name.

  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.i18nBundleName

<include>

List of application config to include in report (separated by comma).

Note: If not filled then will use all config found in class-path.

  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.include

<outputDirectory>

Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
  • Type : java.io.File
  • Depuis : 3.0
  • Exigé : Oui
  • Propriété utilisateur : config.outputDirectory
  • Défaut : ${project.reporting.outputDirectory}

<outputEncoding>

Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.
  • Type : java.lang.String
  • Depuis : 3.0
  • Exigé : Oui
  • Propriété utilisateur : config.outputEncoding
  • Défaut : ${project.reporting.outputEncoding}

<project>

The Maven Project.
  • Type : org.apache.maven.project.MavenProject
  • Depuis : 3.0
  • Exigé : Oui
  • Défaut : ${project}

<skip>

Skip to generate the report.
  • Type : boolean
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.skip

<verbose>

Flag to activate verbose mode.

Note: Verbose mode is always on if you starts a debug maven instance (says via -X).

  • Type : boolean
  • Depuis : 3.0
  • Exigé : Non
  • Propriété utilisateur : config.verbose
  • Défaut : ${maven.verbose}