https://github.com/vsm/vsm-json-pretty

Converts VSM-JSON (as String or JS-Object) to a compact, readable JSON or JSON5 String
https://github.com/vsm/vsm-json-pretty

json json5 stringify vsm

Last synced: 20 days ago
JSON representation

Converts VSM-JSON (as String or JS-Object) to a compact, readable JSON or JSON5 String

• Host: GitHub
• URL: https://github.com/vsm/vsm-json-pretty
• Owner: vsm
• License: agpl-3.0
• Created: 2020-02-17T20:21:21.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T07:32:58.000Z (almost 2 years ago)
• Last Synced: 2024-05-27T20:41:03.775Z (7 months ago)
• Topics: json, json5, stringify, vsm
• Language: JavaScript
• Homepage:
• Size: 1.31 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# vsm-json-pretty

## Specification

This is a function that accepts a VSM JSON-String, or a VSM JS-Object,

and converts it into a pretty, compact, readable JSON or JSON5 String.

For JSON:

- it uses `JSON.stringify(.., null, 2)`,

- and then applies VSM-specific compactness optimizations.

For JSON5:

- it builds on the package

[`json-stringify-pretty-compact`](https://github.com/lydell/json-stringify-pretty-compact),

- applies simplifications supported by JSON5,

- and adds compactness optimizations specific for a VSM data structure.

It also provides this as a build for the browser.

(Note: to convert a generated JSON5-String back to a JS-Object, use the

[json5](https://github.com/json5/json5) package).  

## Installation

### Node.js

```sh

npm install vsm-json-pretty

```

```js

const VsmJsonPretty = require('vsm-json-pretty')

```

### Browsers

```html

```

This will create a global variable `VsmJsonPretty`.

## Use

Call the function with these arguments:

- `vsm` {String|Object}:

  the VSM data as a JSON-String or JS-Object.

- `options` {Object} (optional):

  - `json5` {Boolean} (default `false`): select JSON5 or JSON output.

  - other options that will be passed on to `json-stringify-pretty-compact`.

## Example

```js

var vsm = {

  terms: [

    {  str : 'subj', classID: null, instID: null },

    { "str": "rel" , classID: null, instID: null },

    {  str : 'obj' , classID: 'http://ont.ex/D/Obj', instID: null, dictID: 'http://ont.ex/D' }

  ],

  conns: [

    { type: 'T', pos: [ 0, 1, 2 ] }

  ]

};

var str1 = VsmJsonPretty(vsm);                  // Input as JS-Object.

var str2 = VsmJsonPretty(JSON.stringify(vsm));  // Input as JSON-String.

console.log(str1, str2);

/* Both output the same:

{ "terms": [

    { "str"    : "subj",

      "classID": null,

      "instID" : null

    },

    { "str"    : "rel",

      "classID": null,

      "instID" : null

    },

    { "str"    : "obj",

      "classID": "http://ont.ex/D/Obj",

      "instID" : null,

      "dictID" : "http://ont.ex/D"

  }],

  "conns": [

    { "type": "T", "pos": [ 0, 1, 2 ]}

  ]

}

*/

str1 = VsmJsonPretty(vsm, { json5: true });

str2 = VsmJsonPretty(vsm, { json5: true, maxLength: 80 });

console.log(str1, str2);

/* Both output the same:

{ terms: [

    { str: 'subj', classID: null, instID: null },

    { str: 'rel', classID: null, instID: null },

    { str: 'obj',

      classID: 'http://ont.ex/D/Obj',

      instID: null,

      dictID: 'http://ont.ex/D'

    }

  ],

  conns: [ { type: 'T', pos: [ 0, 1, 2 ] } ]

}

*/

```

## License

[AGPL](LICENSE.md).