Dumping add quote to string even it is not necessary

[joshuaavalon]

As title.

Test Code

const jsYaml = require("js-yaml");
const fs = require("fs");
const yamlStr = jsYaml.dump({ url: "https://github.com/nodeca/js-yaml" });
fs.writeFileSync("foo.yml", yamlStr, { encoding: "utf8" });

Expected Result

url: https://github.com/nodeca/js-yaml

Actual Result

url: 'https://github.com/nodeca/js-yaml'

Problem

js-yaml/lib/js-yaml/dumper.js

Line 294 in b6d2609

plain = plain && isPlainSafe(char);

js-yaml/lib/js-yaml/dumper.js

Lines 192 to 205 in b6d2609

	function isPlainSafe(c) {
	// Uses a subset of nb-char - c-flow-indicator - ":" - "#"
	// where nb-char ::= c-printable - b-char - c-byte-order-mark.
	return isPrintable(c) && c !== 0xFEFF
	// - c-flow-indicator
	&& c !== CHAR_COMMA
	&& c !== CHAR_LEFT_SQUARE_BRACKET
	&& c !== CHAR_RIGHT_SQUARE_BRACKET
	&& c !== CHAR_LEFT_CURLY_BRACKET
	&& c !== CHAR_RIGHT_CURLY_BRACKET
	// - ":" - "#"
	&& c !== CHAR_COLON
	&& c !== CHAR_SHARP;
	}

All of these characters ( except0xFEFF ) are safe inside string. Only colon cannot be followed by space or placed at the end of line.

[diberry]

This is the same as #466. Perhaps we can have a new setting to handle the quoting issue?

[puzrin]

@joshuaavalon "unquoting" quality is limited only by authors time. If anyone has time to improve it - PR is welcome.

[diberry]

@puzrin I'll make a PR this weekend, if no one does it before then.

[diberry]

PR 454 seems related

[diberry]

@puzrin Are these tests all valid/correct?

`test.only('should not unnecessaryly apply quotes', function () {

var expected = 'url: https://github.com/nodeca/js-yaml\n';
var actual = yaml.dump({ url: 'https://github.com/nodeca/js-yaml' });

assert.strictEqual(actual, expected);
});
test.only('should not unnecessaryly apply quotes - ', function () {

var expected = 'url: https://github.com/nodeca/js-yaml\n';

var obj = {};
obj['url']='https://github.com/nodeca/js-yaml';

var actual = yaml.dump(obj);

assert.strictEqual(actual, expected);
});

test.only('should not unnecessaryly apply quotes - space then /\n at end of value', function () {

var expected = 'url: 'https://github.com/nodeca/js-yaml '\n';

var obj = {};
obj['url']='https://github.com/nodeca/js-yaml ';

var actual = yaml.dump(obj);

assert.strictEqual(actual, expected);
});
test.only('should not unnecessaryly apply quotes - space after colon', function () {

var expected = 'url: 'https: //github.com/nodeca/js-yaml'\n';
var actual = yaml.dump({ url: 'https: //github.com/nodeca/js-yaml' });

assert.strictEqual(actual, expected);
});
`

[puzrin]

Could you format you message and add proper lang type for highlight?

[kchen-shanghai]

Having a same problem here. Since only colon and hash characters are limited in flow scalars, is a PR still welcome by now?

[Giszmo]

@ZEROPC I would appreciate a fix but but not speaking for the project. Crossing fingers :D

[rlidwka]

Fixed in db3f529 (in dev branch currently, to be released later).

[mgiamberardino]

I'm experiencing a related issue but not entirely sure is the same one.

We have some cases where the object is like:
{ "CC#": "some data" }

And right now this is being confused with a comment in the library. Is this fix related or should I create a new issue?

[rlidwka]

And right now this is being confused with a comment in the library. Is this fix related or should I create a new issue?

This fix is not related, so it's a new issue.

But I'm not entirely sure what you're talking about. # symbol is required to have a space/tab/newline before it to be a comment.

If you just put CC#, it's not parsed as a comment:

> require('js-yaml').dump({"CC#": "some data"})
'CC#: some data\n'

> require('js-yaml').load('CC#: some data\n')
{ 'CC#': 'some data' }