Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switch to use safeLoad for loading YML files via file.readYAML. #1719

Merged
merged 1 commit into from Aug 18, 2020
Merged

Switch to use safeLoad for loading YML files via file.readYAML. #1719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 11 additions & 2 deletions lib/grunt/file.js
View file
Open in desktop
Expand Up @@ -241,12 +241,21 @@ file.readJSON = function(filepath, options) {
};

// Read a YAML file, parse its contents, return an object.
file.readYAML = function(filepath, options) {
file.readYAML = function(filepath, options, yamlOptions) {
if (!options) { options = {}; }
if (!yamlOptions) { yamlOptions = {}; }

var src = file.read(filepath, options);
var result;
grunt.verbose.write('Parsing ' + filepath + '...');
try {
result = YAML.load(src);
// use the recommended way of reading YAML files
// https://github.com/nodeca/js-yaml#safeload-string---options-
if (yamlOptions.unsafeLoad) {
result = YAML.load(src);
} else {
result = YAML.safeLoad(src);
}
grunt.verbose.ok();
return result;
} catch (e) {
Expand Down
7 changes: 5 additions & 2 deletions test/grunt/file_test.js
View file
Open in desktop
Expand Up @@ -452,10 +452,13 @@ exports.file = {
test.done();
},
'readYAML': function(test) {
test.expect(4);
test.expect(5);
var obj;
obj = grunt.file.readYAML('test/fixtures/utf8.yaml');
test.deepEqual(obj, this.object, 'file should be read as utf8 by default and parsed correctly.');
test.deepEqual(obj, this.object, 'file should be safely read as utf8 by default and parsed correctly.');

obj = grunt.file.readYAML('test/fixtures/utf8.yaml', null, {unsafeLoad: true});
test.deepEqual(obj, this.object, 'file should be unsafely read as utf8 by default and parsed correctly.');

obj = grunt.file.readYAML('test/fixtures/iso-8859-1.yaml', {encoding: 'iso-8859-1'});
test.deepEqual(obj, this.object, 'file should be read using the specified encoding.');
Expand Down