Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rakannimer/generate-json
https://github.com/rakannimer/generate-json
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rakannimer/generate-json
- Owner: rakannimer
- Created: 2018-08-17T18:06:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-29T09:43:03.000Z (almost 6 years ago)
- Last Synced: 2024-12-16T22:13:51.927Z (2 months ago)
- Language: TypeScript
- Size: 39.1 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSON Data Generator
- [JSON Data Generator](#json-data-generator)
- [1 - Generate based on datashape only](#1---generate-based-on-datashape-only)
- [2 - Generate based on datashape and keys reducers](#2---generate-based-on-datashape-and-keys-reducers)
- [3 - Use the cli](#3---use-the-cli)
## 1 - Generate based on datashape only
```javascript
const dataShape = {
"{env}": {
users: {
"{userID}": {
comment_count: "number",
username: "string",
is_verified: "boolean",
created_at: "timestamp"
}
},
posts: {
"{postID}": {
post_title: "string",
post_data: (faker, key) => {
// return faker.random.words(5)
return key.split("/").join("-") + ":post_data";
},
author_id: "{userID}",
created_at: "timestamp"
}
},
comments: {
"{postID}": {
"{commentID}": {
value: "👍",
userID: "{userID}"
}
}
}
}
};
const { generateJSON } = require("json-data-generator");
const { keys, values, tree } = generateJSON(schema);
console.log({ keys, values, tree });
// Will Output :
Object {
"keys": Array [
"G_K_dsy6q.users.G_K_sll5g.comment_count",
"G_K_dsy6q.users.G_K_sll5g.username",
"G_K_dsy6q.users.G_K_sll5g.is_verified",
"G_K_dsy6q.users.G_K_sll5g.created_at",
"G_K_dsy6q.posts.G_K_5pn02.post_title",
"G_K_dsy6q.posts.G_K_5pn02.post_data",
"G_K_dsy6q.posts.G_K_5pn02.author_id",
"G_K_dsy6q.posts.G_K_5pn02.created_at",
"G_K_dsy6q.comments.G_K_5pn02.G_K_6mami.value",
"G_K_dsy6q.comments.G_K_5pn02.G_K_6mami.userID",
],
"tree": Object {
"G_K_dsy6q": Object {
"comments": Object {
"G_K_5pn02": Object {
"G_K_6mami": Object {
"userID": "G_K_sll5g",
"value": "👍",
},
},
},
"posts": Object {
"G_K_5pn02": Object {
"author_id": "G_K_sll5g",
"created_at": 24761311291,
"post_data": "G_K_dsy6q.posts.G_K_5pn02.post_data:post_data",
"post_title": "Coordinator Multi-channelled",
},
},
"users": Object {
"G_K_sll5g": Object {
"comment_count": 29122,
"created_at": 9213076313,
"is_verified": false,
"username": "Namibia enable",
},
},
},
},
"values": Array [
29122,
"Namibia enable",
false,
9213076313,
"Coordinator Multi-channelled",
"G_K_dsy6q.posts.G_K_5pn02.post_data:post_data",
"G_K_sll5g",
24761311291,
"👍",
"G_K_sll5g",
],
}
```
## 2 - Generate based on datashape and keys reducers
```javascript
const keyReducers = {
"{env}": (fakerjs: typeof faker) => {
return fakerjs.random.arrayElement(["prod", "staging"]);
},
"{userID}": (fakerjs: typeof faker) => {
return fakerjs.random.alphaNumeric(5);
},
"{postID}": (fakerjs: typeof faker) => {
return fakerjs.random.alphaNumeric(5);
}
}
const { generateJSON } = require("json-data-generator");
const { keys, values, tree } = generateJSON(schema, keyReducers);
console.log({ keys, values, tree });
// Will Output :
Object {
"keys": Array [
"prod.users.sy6qs.comment_count",
"prod.users.sy6qs.username",
"prod.users.sy6qs.is_verified",
"prod.users.sy6qs.created_at",
"prod.posts.gvcl5.post_title",
"prod.posts.gvcl5.post_data",
"prod.posts.gvcl5.author_id",
"prod.posts.gvcl5.created_at",
"prod.comments.gvcl5.G_K_706z6.value",
"prod.comments.gvcl5.G_K_706z6.userID",
],
"tree": Object {
"prod": Object {
"comments": Object {
"gvcl5": Object {
"G_K_706z6": Object {
"userID": "sy6qs",
"value": "👍",
},
},
},
"posts": Object {
"gvcl5": Object {
"author_id": "sy6qs",
"created_at": 14382625758,
"post_data": "prod.posts.gvcl5.post_data:post_data",
"post_title": "enable Gorgeous Frozen Pants",
},
},
"users": Object {
"sy6qs": Object {
"comment_count": 52475,
"created_at": 19295395373,
"is_verified": true,
"username": "Grocery Home",
},
},
},
},
"values": Array [
52475,
"Grocery Home",
true,
19295395373,
"enable Gorgeous Frozen Pants",
"prod.posts.gvcl5.post_data:post_data",
"sy6qs",
14382625758,
"👍",
"sy6qs",
],
}
```
## 3 - Use the cli
Create a js file that exports `schema`, (and optionally `keyReducers` and `count`)
```javascript
const keyReducers = {
"{env}": fakerjs => {
return fakerjs.random.arrayElement(["prod", "staging"]);
},
"{userID}": fakerjs => {
return fakerjs.random.alphaNumeric(5);
},
"{postID}": fakerjs => {
return fakerjs.random.alphaNumeric(5);
}
};
const schema = {
"{env}": {
users: {
"{userID}": {
comment_count: "number",
username: "string",
is_verified: "boolean",
created_at: "timestamp"
}
},
posts: {
"{postID}": {
post_title: "string",
post_data: (faker, key) => {
// return faker.random.words(5)
return key.split("/").join("-") + ":post_data";
},
author_id: "{userID}",
created_at: "timestamp"
}
},
comments: {
"{postID}": {
"{commentID}": {
value: "👍",
userID: "{userID}"
}
}
}
}
};
const count = 5;
module.exports = {
schema,
keyReducers,
count
};
```
Then run :
```sh
generate-json path/to/schema.js path/to/output-directory/
```
This will create 3 files in `path/to/output-directory/` :
- `tree.json`
- `keys.json`
- `values.json`