Skip to content

Commit 0fcf25c

Browse files
committed
Clarify that --root does not restrict filesystem access
The `--root` option only strips a prefix from template names, but its description could be read as limiting which files the CLI reads. State explicitly that it is not a filesystem boundary.
1 parent ea8ed82 commit 0fcf25c

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

‎bin/handlebars‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ var argv = parseArgs({
6565
},
6666
'r': {
6767
'type': 'string',
68-
'description': 'Template root. Base value that will be stripped from template names.',
68+
'description': 'Template root. Base value that will be stripped from template names; it does not restrict filesystem access.',
6969
'alias': 'root'
7070
},
7171
'p': {

‎spec/expected/help.menu.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Options:
1616
multiple templates. [string]
1717
-i, --string Generates a template from the passed CLI argument.
1818
"-" is treated as a special value and causes stdin to be read for the template value. [string]
19-
-r, --root Template root. Base value that will be stripped from template names. [string]
19+
-r, --root Template root. Base value that will be stripped from template names; it does not restrict
20+
filesystem access. [string]
2021
-p, --partial Compiling a partial template [boolean]
2122
-d, --data Include data when compiling [boolean]
2223
-e, --extension Template extension. [string] [default: "handlebars"]

0 commit comments

Comments
 (0)