Socket
Socket
Sign inDemoInstall

golden-fleece

Package Overview
Dependencies
0
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

golden-fleece

Parse and manipulate JSON5 strings


Version published
Maintainers
1
Weekly downloads
192,126
decreased by-9.85%

Weekly downloads

Readme

Source

golden-fleece

Parse a JSON5 string (like JSON, but less strict).

Why?

For the Svelte REPL, where we want to allow arbitrary data in the bottom right-hand panel, but we also want to update the object without reformatting it as JSON.

Usage

Install it with npm install golden-fleece and import it into your app:

import * as fleece from 'golden-fleece';

fleece.parse(str, [options])

const ast = fleece.parse(`true`);
// { start: 0, end: 4, type: 'Literal', raw: 'true', value: true }

The returned AST is ESTree compliant.

You can optionally pass callbacks that are fired whenever a value or comment is encountered:

const ast = fleece.parse(str, {
	onComment: comment => {
		console.log('got a comment', comment);
	},
	onValue: value => {
		console.log('got a value', value);
	}
});

fleece.evaluate(str)

const { answer } = fleece.evaluate(`{ answer: 42 }`);
answer === 42; // true

fleece.patch(str, value)

This is where it gets fun:

const str = `
	number: 1,
	string: 'yes',
	object: { nested: true },
	array: ['this', 'that', 'the other']
`;

const object = fleece.evaluate(str);
object.number = 42;
object.array[2] = 'EVERYTHING';

fleece.patch(str, object) === `{
	number: 42,
	string: 'yes',
	object: { nested: true },
	array: ['this', 'that', 'EVERYTHING']
}`; // true

Notice that the formatting has been preserved.

fleece.stringify(value, [options])

const object = {
	string: 'hello',
	'quoted-property': 2,
	array: [3, 4]
};

fleece.stringify(object) === `{
	string: "hello",
	"quoted-property": 2,
	array: [
		3,
		4
	]
}`; // true

To indent with spaces instead of tabs, pass spaces: n, where n is the number of spaces at each level of indentation.

fleece.stringify(object, {
	spaces: 2
}) === `{
  string: "hello",
  "quoted-property": 2,
  array: [
    3,
    4
  ]
}`; // true

To prefer single-quotes to double-quotes, pass singleQuotes: true:

fleece.stringify(object, {
	singleQuotes: true
}) === `{
	string: 'hello',
	'quoted-property': 2,
	array: [
		3,
		4
	]
}`; // true

License

LIL

FAQs

Last updated on 05 Jun 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc