Skip to content

Commit f5332da

Browse files
committed
docs(README): Document all CLI options
Fixes: #613
1 parent db5cf22 commit f5332da

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
- [`--ignore-pattern`](#--ignore-pattern)
2525
- [`--config`](#--config)
2626
- [`--ui5-config`](#--ui5-config)
27+
- [`--log-level`](#--log-level)
28+
- [`--verbose`](#--verbose)
29+
- [`--perf`](#--perf)
30+
- [`--silent`](#--silent)
31+
- [`--version`](#--version)
2732
- [Configuration](#configuration)
2833
- [Configuration File Location](#configuration-file-location)
2934
- [Supported Configuration File Names](#supported-configuration-file-names)
@@ -202,6 +207,53 @@ Set a path for the desired UI5 yaml config file (default: `./ui5.yaml`).
202207
ui5lint --ui5-config ./configs/ui5-custom.yaml
203208
```
204209

210+
#### `--log-level`
211+
212+
Set the logging level (default: `info`).
213+
214+
Possible values are: `silent`, `error`, `warn`, `info`, `perf`, `verbose`, `silly`
215+
216+
**Example:**
217+
```sh
218+
ui5lint --log-level=warn
219+
```
220+
221+
#### `--verbose`
222+
223+
Enable verbose logging.
224+
225+
**Example:**
226+
```sh
227+
ui5lint --verbose
228+
```
229+
230+
#### `--perf`
231+
232+
Enable performance measurements and related logging.
233+
234+
**Example:**
235+
```sh
236+
ui5lint --perf
237+
```
238+
239+
#### `--silent`
240+
241+
Disable all log output.
242+
243+
**Example:**
244+
```sh
245+
ui5lint --silent
246+
```
247+
248+
#### `--version`
249+
250+
Prints the current version and CLI script location.
251+
252+
**Example:**
253+
```sh
254+
ui5lint --version
255+
```
256+
205257
## Configuration
206258

207259
UI5 linter can easily be configured with an external configuration file, allowing you to customize how the linter behaves. For example, you can tell it to ignore specific files or directories.

0 commit comments

Comments
 (0)