benjycui / jsonml.js Goto Github PK

When calling utils.appendChild with a child fragment, the fragment is mutated, resulting in an empty array.

const jml = ['div'];
const fragment = ['', 'hello world'];
utils.appendChild(jml, fragment);
// jml === ['div', 'hello world']
// fragment === []

Ideally, the fragment should not be mutated.
See discussion: #5 (comment)

Original comments: #5 (comment)

Calling utils.appendChild with a raw element throws an error.

const html = require('jsonml.js/lib/html');
const utils = require('jsonml.js/lib/utils');

const jml = ['div']
const rawEl = html.raw('foo');
utils.appendChild(jml, rawEl); // TypeError: exports.isRaw is not a function

Indeed, exports.isRaw is not defined within utils.js. It is, however, defined within html.js. So, the fix should be fairly straightforward.

When writing tests for the utils methods, I came across some logic that was confusing:
https://github.com/benjycui/jsonml.js/blob/master/lib/utils.js#L132

} else if (child || !parent.length) {
  // append
  parent.push(child);

This allows for some unclear behavior, particularly when allowing exception for a parent with no length.

1. append a child to an empty parent array

const jml = [];
utils.appendChild(jml, '');
// jml === ['']

const jml = []; 
utils.appendChild(jml, ['p', 'hello']);
// jml === [ ['p', 'hello'] ]

Is this a real use case or an edge case bug? I'm guessing this would never be desired and should probably not be allowed.

Hey @benjycui,

I'm using this module in some libraries and applications and it's been helpful. I'd like to contribute back and help with the maintenance of the project. Are you accepting contributions at this time? Where is the best place to begin? It looks like there's a need for complete test coverage, eslint cleanup, and documentation. If you're interested, we could begin opening issues to track this work.

I've gone ahead and opened a few PRs that should help move things along:

• #4 - Add nyc for coverage reports
• #5 - Add complete unit tests for utils interface
• #6 - Cleanup existing lint rules on utils

在 windows 下面报错:

https://github.com/benjycui/jsonml.js/blob/master/lib/utils.js#L68

windows 下面才有这个问题,mac 下面同样的代码运行没有问题

jsdom is too heavy.