Skip to content

Commit 84de071

Browse files
committed
Improves documentation
1 parent 9394a35 commit 84de071

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -72,21 +72,21 @@ of export-ignores in the `.gitattributes` file and fail validation if the order
7272
differs. Per __default__ the order comparison is done in a non-strict fashion.
7373

7474
``` bash
75-
lean-package-validator validate [<directory>] --enforce-strict-order
75+
lean-package-validator validate --enforce-strict-order [<directory>]
7676
```
7777

7878
The `--create|-c` option creates an `.gitattributes` file if nonexistent.
7979

8080
``` bash
81-
lean-package-validator validate [<directory>] --create
81+
lean-package-validator validate --create [<directory>]
8282
```
8383

8484
The `--overwrite|-o` option overwrites an existing `.gitattributes` file when
8585
there are any `export-ignore` entries missing. Using this option on a directory
8686
with a nonexistent `.gitattributes` file implicates the `--create` option.
8787

8888
``` bash
89-
lean-package-validator validate [<directory>] --overwrite
89+
lean-package-validator validate --overwrite [<directory>]
9090
```
9191

9292
The `--glob-pattern` option allows you to overwrite the default pattern used
@@ -95,7 +95,7 @@ braces is expected to be `>1`. As shown next this utility could thereby also
9595
be used for projects (i.e. Python) outside the PHP ecosystem.
9696

9797
``` bash
98-
lean-package-validator validate [<directory>] --glob-pattern '{.*,*.rst,*.py[cod],dist/}'
98+
lean-package-validator validate --glob-pattern '{.*,*.rst,*.py[cod],dist/}' [<directory>]
9999
```
100100

101101
The default pattern is defined in the PHP preset [file](./src/Presets/PhpPreset.php).
@@ -108,37 +108,37 @@ can be taken from the [example](example/.lpv) directory or be created
108108
via `lean-package-validator init`.
109109

110110
``` bash
111-
lean-package-validator validate [<directory>] --glob-pattern-file /path/to/glob-pattern-file
111+
lean-package-validator validate --glob-pattern-file /path/to/glob-pattern-file [<directory>]
112112
```
113113

114114
The `--keep-license` option will allow a license file in the release/dist archive file which is per default ommitted.
115115

116116
``` bash
117-
lean-package-validator validate [<directory>] --keep-license
117+
lean-package-validator validate --keep-license [<directory>]
118118
```
119119

120120
The `--keep-readme` option will allow a README file in the release/dist archive file which is per default ommitted.
121121

122122
``` bash
123-
lean-package-validator validate [<directory>] --keep-readme
123+
lean-package-validator validate --keep-readme [<directory>]
124124
```
125125

126126
The `--keep-glob-pattern` option allows to keep matching files in the release/dist archive file which are per default ommitted.
127127

128128
``` bash
129-
lean-package-validator validate [<directory>] --keep-glob-pattern '{LICENSE.*,README.*,docs*}'
129+
lean-package-validator validate --keep-glob-pattern '{LICENSE.*,README.*,docs*}' [<directory>]
130130
```
131131

132132
The `--align-export-ignores|-a` option will align the created or overwritten export-ignores for a better readability.
133133

134134
``` bash
135-
lean-package-validator validate [<directory>] --align-export-ignores --create
135+
lean-package-validator validate --align-export-ignores --create [<directory>]
136136
```
137137

138138
The `--sort-from-directories-to-files|-s` option will order the export-ignores from directories to files for a better readability.
139139

140140
``` bash
141-
lean-package-validator validate [<directory>] --sort-from-directories-to-files --create
141+
lean-package-validator validate --sort-from-directories-to-files --create [<directory>]
142142
```
143143

144144
The `--enforce-alignment` option will enforce a strict alignment of export-ignores
@@ -151,13 +151,13 @@ current Git `HEAD` and inspecting its content. With a set `--keep-license` optio
151151
file becomes mandatory and will fail the archive validation if not present.
152152

153153
``` bash
154-
lean-package-validator validate [<directory>] --validate-git-archive
154+
lean-package-validator validate --validate-git-archive [<directory>]
155155
```
156156

157157
The `--diff` option will show a visual diff between the actual and expected `.gitattributes` content.
158158

159159
``` bash
160-
lean-package-validator validate --diff
160+
lean-package-validator validate --diff [<directory>]
161161

162162
The present .gitattributes file is considered invalid.
163163

@@ -200,7 +200,7 @@ The `tree` command of the lean package validator allows you to inspect the __fla
200200
of the given project/micro-package. It is __not__ intended for validation use.
201201

202202
``` bash
203-
lean-package-validator tree [<directory>] --src
203+
lean-package-validator tree --src [<directory>]
204204

205205
Package: stolt/lean-package-validator
206206
.
@@ -229,7 +229,7 @@ Package: stolt/lean-package-validator
229229
```
230230

231231
``` bash
232-
lean-package-validator tree [<directory>] --dist-package
232+
lean-package-validator tree --dist-package [<directory>]
233233

234234
Package: stolt/lean-package-validator
235235
.

0 commit comments

Comments
 (0)