Implemented `stringifyPartial` and use it in Transform modal

This commit is contained in:
jos 2019-06-26 21:57:22 +02:00
parent 1e1ee3463c
commit cda54f95fc
4 changed files with 275 additions and 7 deletions

View File

@ -291,8 +291,9 @@ div.jsoneditor code.jsoneditor-preview {
div.jsoneditor.jsoneditor-mode-preview pre.jsoneditor-preview { div.jsoneditor.jsoneditor-mode-preview pre.jsoneditor-preview {
width: 100%; width: 100%;
height: 100%; height: 100%;
overflow: hidden; overflow: auto;
margin: 2px; padding: 2px;
margin: 0;
white-space: pre-wrap; white-space: pre-wrap;
word-break: break-all; word-break: break-all;
} }

View File

@ -2,6 +2,7 @@ var jmespath = require('jmespath');
var picoModal = require('picomodal'); var picoModal = require('picomodal');
var Selectr = require('./assets/selectr/selectr'); var Selectr = require('./assets/selectr/selectr');
var translate = require('./i18n').translate; var translate = require('./i18n').translate;
var stringifyPartial = require('./stringifyPartial').stringifyPartial;
var util = require('./util'); var util = require('./util');
var debounce = util.debounce; var debounce = util.debounce;
@ -257,13 +258,11 @@ function showTransformModal (container, json, onTransform) {
console.timeEnd('transform') // TODO: cleanup console.timeEnd('transform') // TODO: cleanup
console.time('stringify') // TODO: cleanup console.time('stringify') // TODO: cleanup
var lines = JSON.stringify(transformed, null, 2) var lines = stringifyPartial(transformed, 2, 10000);
console.timeEnd('stringify') // TODO: cleanup console.timeEnd('stringify') // TODO: cleanup
console.time('split') // TODO: cleanup // TODO: create a more efficient way to limit to a max number of lines, move this in a util function
lines = lines.split('\n'); // FIXME: remove split, it's slow lines = lines.split('\n');
console.timeEnd('split') // TODO: cleanup
if (lines.length > MAX_PREVIEW_LINES) { if (lines.length > MAX_PREVIEW_LINES) {
lines = lines.slice(0, MAX_PREVIEW_LINES).concat(['...']) lines = lines.slice(0, MAX_PREVIEW_LINES).concat(['...'])
} }

187
src/js/stringifyPartial.js Normal file
View File

@ -0,0 +1,187 @@
'use strict';
/**
* Convert part of a JSON object to a JSON string.
* Use case is to stringify a small part of a large JSON object so you can see
* a preview.
*
* @param {*} value
* The value to convert to a JSON string.
*
* @param {number | string | null} [space]
* A String or Number object that's used to insert white space into the output
* JSON string for readability purposes. If this is a Number, it indicates the
* number of space characters to use as white space; this number is capped at 10
* if it's larger than that. Values less than 1 indicate that no space should be
* used. If this is a String, the string (or the first 10 characters of the string,
* if it's longer than that) is used as white space. If this parameter is not
* provided (or is null), no white space is used.
*
* @param {number} [limit] Maximum size of the string output.
*
* @returns {string | undefined} Returns the string representation of the JSON object.
*/
function stringifyPartial(value, space, limit) {
var _space; // undefined by default
if (typeof space === 'number') {
if (space > 10) {
_space = repeat(' ', 10);
}
else if (space >= 1) {
_space = repeat(' ', space);
}
// else ignore
}
else if (typeof space === 'string' && space !== '') {
_space = space;
}
var output = stringifyValue(value, _space, '', limit);
return slice(output, limit);
}
/**
* Stringify a value
* @param {*} value
* @param {string} space
* @param {string} indent
* @param {number} limit
* @return {string | undefined}
*/
function stringifyValue(value, space, indent, limit) {
// boolean, null, number, string, or date
if (typeof value === 'boolean' || value instanceof Boolean ||
value === null ||
typeof value === 'number' || value instanceof Number ||
typeof value === 'string' || value instanceof String ||
value instanceof Date) {
return JSON.stringify(value);
}
// array
if (Array.isArray(value)) {
return stringifyArray(value, space, indent, limit);
}
// object (test lastly!)
if (value && typeof value === 'object') {
return stringifyObject(value, space, indent, limit);
}
return undefined;
}
/**
* Stringify an array
* @param {Array} array
* @param {string} space
* @param {string} indent
* @param {number} limit
* @return {string}
*/
function stringifyArray(array, space, indent, limit) {
var childIndent = space ? (indent + space) : undefined;
var str = space ? '[\n' : '[';
for (var i = 0; i < array.length; i++) {
var item = array[i];
if (space) {
str += childIndent;
}
if (typeof item !== 'undefined' && typeof item !== 'function') {
str += stringifyValue(item, space, childIndent, limit);
}
else {
str += 'null'
}
if (i < array.length - 1) {
str += space ? ',\n' : ',';
}
// stop as soon as we're exceeding the limit
if (str.length > limit) {
return str;
}
}
str += space ? ('\n' + indent + ']') : ']';
return str;
}
/**
* Stringify an object
* @param {Object} object
* @param {string} space
* @param {string} indent
* @param {number} limit
* @return {string}
*/
function stringifyObject(object, space, indent, limit) {
var childIndent = space ? (indent + space) : undefined;
var first = true;
var str = space ? '{\n' : '{';
if (typeof object.toJSON === 'function') {
return stringifyValue(object.toJSON(), space, indent, limit);
}
for (var key in object) {
if (object.hasOwnProperty(key)) {
var value = object[key];
if (first) {
first = false;
}
else {
str += space ? ',\n' : ',';
}
str += space
? (childIndent + '"' + key + '": ')
: ('"' + key + '":');
str += stringifyValue(value, space, childIndent, limit);
// stop as soon as we're exceeding the limit
if (str.length > limit) {
return str;
}
}
}
str += space ? ('\n' + indent + '}') : '}';
return str;
}
/**
* Repeat a string a number of times.
* Simple linear solution, we only need up to 10 iterations in practice
* @param {string} text
* @param {number} times
* @return {string}
*/
function repeat (text, times) {
var res = '';
while (times-- > 0) {
res += text;
}
return res;
}
/**
* Limit the length of text
* @param {string} text
* @param {number} [limit]
* @return {string}
*/
function slice(text, limit) {
return typeof limit === 'number'
? text.slice(0, limit)
: text;
}
exports.stringifyPartial = stringifyPartial;

View File

@ -0,0 +1,81 @@
var assert = require('assert');
var stringifyPartial = require('../src/js/stringifyPartial').stringifyPartial;
describe('stringifyPartial', function () {
it('should stringify a small object', function () {
var json = {
a: 2,
b: 'foo',
c: null,
d: false,
e: [ 1, 2, 3],
f: { g: 'h' }
};
assert.strictEqual(stringifyPartial(json), '{"a":2,"b":"foo","c":null,"d":false,"e":[1,2,3],"f":{"g":"h"}}');
});
it('should stringify a small object with formatting', function () {
var json = {
a: 2,
b: 'foo',
c: null,
d: false,
e: [ 1, 2, 3],
f: { g: 'h' }
};
assert.strictEqual(stringifyPartial(json, 2),
'{\n' +
' "a": 2,\n' +
' "b": "foo",\n' +
' "c": null,\n' +
' "d": false,\n' +
' "e": [\n' +
' 1,\n' +
' 2,\n' +
' 3\n' +
' ],\n' +
' "f": {\n' +
' "g": "h"\n' +
' }\n' +
'}');
assert.strictEqual(stringifyPartial(json, ' '), '{\n' +
' "a": 2,\n' +
' "b": "foo",\n' +
' "c": null,\n' +
' "d": false,\n' +
' "e": [\n' +
' 1,\n' +
' 2,\n' +
' 3\n' +
' ],\n' +
' "f": {\n' +
' "g": "h"\n' +
' }\n' +
'}');
});
it('should limit stringified output', function () {
var json = {
a: 2,
b: 'foo',
c: null,
d: false,
e: [ 1, 2, 3],
f: { g: 'h' }
};
var all = '{"a":2,"b":"foo","c":null,"d":false,"e":[1,2,3],"f":{"g":"h"}}';
var limit = 20;
assert.strictEqual(stringifyPartial(json, undefined, limit),
all.slice(0, limit));
assert.strictEqual(stringifyPartial([1,2,3,4,5,6,7,8,9,10], undefined, 10),
'[1,2,3,4,5');
});
});