Skip to content

Commit 20281d5

Browse files
committed
Highlight that configurations are not sanitised ✋
1 parent ae86ee1 commit 20281d5

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,9 @@ module.exports = {
126126

127127
### `commithashCommand: 'rev-parse HEAD'`
128128

129-
To change the default `git` command used to read the value of `COMMITHASH`:
129+
To change the default `git` command used to read the value of `COMMITHASH`.
130+
131+
This configuration is not not meant to accept arbitrary user input and it is executed by the plugin without any sanitization.
130132

131133
```javascript
132134
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -142,7 +144,9 @@ module.exports = {
142144

143145
### `versionCommand: 'describe --always'`
144146

145-
To change the default `git` command used to read the value of `VERSION`:
147+
To change the default `git` command used to read the value of `VERSION`.
148+
149+
This configuration is not not meant to accept arbitrary user input and it is executed by the plugin without any sanitization.
146150

147151
```javascript
148152
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -158,7 +162,9 @@ module.exports = {
158162

159163
### `branchCommand: 'rev-parse --abbrev-ref HEAD'`
160164

161-
To change the default `git` command used to read the value of `BRANCH`:
165+
To change the default `git` command used to read the value of `BRANCH`.
166+
167+
This configuration is not not meant to accept arbitrary user input and it is executed by the plugin without any sanitization.
162168

163169
```javascript
164170
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -174,7 +180,9 @@ module.exports = {
174180

175181
### `lastCommitDateTimeCommand: 'log -1 --format=%cI'`
176182

177-
To change the default `git` command used to read the value of `LASTCOMMITDATETIME`:
183+
To change the default `git` command used to read the value of `LASTCOMMITDATETIME`.
184+
185+
This configuration is not not meant to accept arbitrary user input and it is executed by the plugin without any sanitization.
178186

179187
```javascript
180188
var GitRevisionPlugin = require('git-revision-webpack-plugin')

0 commit comments

Comments
 (0)