Skip to content

Commit c09f113

Browse files
committed
Highlight that configurations are not sanitized
1 parent 55406d0 commit c09f113

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules
22
tmp
3+
.DS_Store

README.md

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

129129
### `commithashCommand: 'rev-parse HEAD'`
130130

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

133135
```javascript
134136
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -144,7 +146,9 @@ module.exports = {
144146

145147
### `versionCommand: 'describe --always'`
146148

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

149153
```javascript
150154
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -160,7 +164,9 @@ module.exports = {
160164

161165
### `branchCommand: 'rev-parse --abbrev-ref HEAD'`
162166

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

165171
```javascript
166172
var GitRevisionPlugin = require('git-revision-webpack-plugin')
@@ -176,7 +182,9 @@ module.exports = {
176182

177183
### `lastCommitDateTimeCommand: 'log -1 --format=%cI'`
178184

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

181189
```javascript
182190
var GitRevisionPlugin = require('git-revision-webpack-plugin')

0 commit comments

Comments
 (0)