1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
---
layout: default
title: exportreport <sub-cmd> [options]
summary: Generate and export reports of a workspace, a project or of a Jar.
---
## Description
{{page.summary}}
Custom reports must first be configured in the project or the workspace with the [-exportreport](../instructions/exportreport.html) intruction and optionaly with the [-reportconfig](../instructions/reportconfig.html) intruction. For an "external" Jar the reports can be configured directly with the command line (replacing the `-exportreport` instruction), however if you need to fine tune the report the `-reportconfig` has to be in a properties file.
For a general introduction of the feature you can look at the [here](../chapters/395-generating-documentation.html).
## Synopsis
exportreport <[sub-cmd]> [options]
## Options
Available sub-commands:
list - List the user defined reports.
export - Export the user defined reports.
jarexport - Export a custom report of a Jar.
readme - Export a set of readme files.
jarreadme - Export a readme file of a Jar
## Sub-commands
### List
#### Description
List the user defined reports absolute path which could be exported by the workpace and/or the projects. If this command is applied on a workspace, the command will also list reports of all the projects (except if you exclude them).
#### Synopsis
list [options]
#### Options
[ -e, --exclude <string;> ] - Exclude files by pattern
[ -p, --project <string> ] - Identify another project
[ -v, --verbose ] - Prints more processing information
[ -w, --workspace <string> ] - Use the following workspace
### Export
#### Description
Generate and export the user defined reports. If this command is applied on a workspace, the command will also export reports of all the projects (except if you exclude them).
#### Synopsis
export [options]
#### Options
[ -e, --exclude <string;> ] - Exclude files by pattern
[ -p, --project <string> ] - Identify another project
[ -v, --verbose ] - Prints more processing information
[ -w, --workspace <string> ] - Use the following workspace
### Jar Export
#### Description
Generate and export a custom report of a Jar.
#### Synopsis
jarexport [options] <jar path> <output path>
#### Options
[ -c, --configName <string> ] - A configuration name defined in the property
file (check -reportconfig documentation), if not
set a default configuration will be used.
[ -l, --locale <string> ] - A locale (language-COUNTRY-variant) used to
localized the report data.
[ -p, --parameters <string;> ] - A list of parameters that will be provided
to the transformation process if any.
[ -P, --properties <string> ] - Path to a property file
[ -t, --template <string> ] - Path or URL to a template file used to
transform the generated report (twig or xslt).
[ -T, --templateType <string> ] - The template type (aka template file
extension), must be set if it could not be guess
from the template file name.
#### Examples
Create an `XML` report of a Jar:
$ bnd exportreport jarexport ./m2/.../my.bundle.jar ./my-report.xml
Create a `JSON` report of a Jar:
$ bnd exportreport jarexport ./m2/.../my.bundle.jar ./my-report.json
Generate a web page from a Jar. Here, we specify the template type because the URL is ambiguous and a locale to get data in French:
$ bnd exportreport jarexport --locale fr-FR --template https://..../templates/56z5f --templateType xslt ./m2/.../my.bundle.jar ./webpage.html
### Readme
#### Description
Generate and export a set of readme files. If this command is applied on a workspace, the command will also export readme files for each projects (except if you exclude them).
#### Synopsis
readme [options]
#### Options
[ -e, --exclude <string;> ] - Exclude files by pattern
[ -p, --project <string> ] - Identify another project
[ -v, --verbose ] - Prints more processing information
[ -w, --workspace <string> ] - Use the following workspace
> Template can be parametrized with system properties starting with 'bnd.reporter.*'. See
[here](../chapters/395-generating-documentation.html) for a complete list of parameters.
### Jar Readme
#### Description
Generate and export a readme file of a Jar.
#### Synopsis
jarreadme <jar path> <output path>
#### Options
> Template can be parametrized with system properties starting with 'bnd.reporter.*'. See
[here](../chapters/395-generating-documentation.html) for a complete list of parameters.
|
