Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/json-stringify-nice/README.md')
-rw-r--r--node_modules/json-stringify-nice/README.md105
1 files changed, 0 insertions, 105 deletions
diff --git a/node_modules/json-stringify-nice/README.md b/node_modules/json-stringify-nice/README.md
deleted file mode 100644
index 66cb1a7c5..000000000
--- a/node_modules/json-stringify-nice/README.md
+++ /dev/null
@@ -1,105 +0,0 @@
-# json-stringify-nice
-
-Stringify an object sorting scalars before objects, and defaulting to
-2-space indent.
-
-Sometimes you want to stringify an object in a consistent way, and for
-human legibility reasons, you may want to put any non-object properties
-ahead of any object properties, so that it's easier to track the nesting
-level as you read through the object, but you don't want to have to be
-meticulous about maintaining object property order as you're building up
-the object, since it doesn't matter in code, it only matters in the output
-file. Also, it'd be nice to have it default to reasonable spacing without
-having to remember to add `, null, 2)` to all your `JSON.stringify()`
-calls.
-
-If that is what you want, then this module is for you, because it does
-all of that.
-
-## USAGE
-
-```js
-const stringify = require('json-stringify-nice')
-const obj = {
- z: 1,
- y: 'z',
- obj: { a: {}, b: 'x' },
- a: { b: 1, a: { nested: true} },
- yy: 'a',
-}
-
-console.log(stringify(obj))
-/* output:
-{
- "y": "z", <-- alphabetical sorting like whoa!
- "yy": "a",
- "z": 1,
- "a": { <-- a sorted before obj, because alphabetical, and both objects
- "b": 1,
- "a": { <-- note that a comes after b, because it's an object
- "nested": true
- }
- },
- "obj": {
- "b": "x",
- "a": {}
- }
-}
-*/
-
-// specify an array of keys if you have some that you prefer
-// to be sorted in a specific order. preferred keys come before
-// any other keys, and in the order specified, but objects are
-// still sorted AFTER scalars, so the preferences only apply
-// when both values are objects or both are non-objects.
-console.log(stringify(obj, ['z', 'yy', 'obj']))
-/* output
-{
- "z": 1, <-- z comes before other scalars
- "yy": "a", <-- yy comes after z, but before other scalars
- "y": "z", <-- then all the other scalar values
- "obj": { <-- obj comes before other objects, but after scalars
- "b": "x",
- "a": {}
- },
- "a": {
- "b": 1,
- "a": {
- "nested": true
- }
- }
-}
-*/
-
-// can also specify a replacer or indent value like with JSON.stringify
-// this turns all values with an 'a' key into a doggo meme from 2011
-const replacer = (key, val) =>
- key === 'a' ? { hello: 'πŸ“ž yes', 'this is': 'πŸ•', ...val } : val
-
-console.log(stringify(obj, replacer, 'πŸ“žπŸΆ'))
-
-/* output:
-{
-πŸ“žπŸΆ"y": "z",
-πŸ“žπŸΆ"yy": "a",
-πŸ“žπŸΆ"z": 1,
-πŸ“žπŸΆ"a": {
-πŸ“žπŸΆπŸ“žπŸΆ"b": 1,
-πŸ“žπŸΆπŸ“žπŸΆ"hello": "πŸ“ž yes",
-πŸ“žπŸΆπŸ“žπŸΆ"this is": "πŸ•",
-πŸ“žπŸΆπŸ“žπŸΆ"a": {
-πŸ“žπŸΆπŸ“žπŸΆπŸ“žπŸΆ"hello": "πŸ“ž yes",
-πŸ“žπŸΆπŸ“žπŸΆπŸ“žπŸΆ"nested": true,
-πŸ“žπŸΆπŸ“žπŸΆπŸ“žπŸΆ"this is": "πŸ•"
-πŸ“žπŸΆπŸ“žπŸΆ}
-πŸ“žπŸΆ},
-πŸ“žπŸΆ"obj": {
-πŸ“žπŸΆπŸ“žπŸΆ"b": "x",
-πŸ“žπŸΆπŸ“žπŸΆ"a": {
-πŸ“žπŸΆπŸ“žπŸΆπŸ“žπŸΆ"hello": "πŸ“ž yes",
-πŸ“žπŸΆπŸ“žπŸΆπŸ“žπŸΆ"this is": "πŸ•"
-πŸ“žπŸΆπŸ“žπŸΆ}
-πŸ“žπŸΆ}
-}
-*/
-```