Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cnille/jsonfieldexplorer
JsonFieldExplorer (jfe) is a CLI tool for easy exploration of JSON structures. It quickly lists all field paths in a JSON file, helping users navigate and understand complex, nested data. Ideal for developers and data analysts dealing with intricate JSON formats.
https://github.com/cnille/jsonfieldexplorer
json json-parser json-path json-schema json-structure json-tools
Last synced: 23 days ago
JSON representation
JsonFieldExplorer (jfe) is a CLI tool for easy exploration of JSON structures. It quickly lists all field paths in a JSON file, helping users navigate and understand complex, nested data. Ideal for developers and data analysts dealing with intricate JSON formats.
- Host: GitHub
- URL: https://github.com/cnille/jsonfieldexplorer
- Owner: cNille
- License: isc
- Created: 2024-01-16T14:37:42.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-08T07:12:36.000Z (7 months ago)
- Last Synced: 2024-10-14T03:22:10.554Z (23 days ago)
- Topics: json, json-parser, json-path, json-schema, json-structure, json-tools
- Language: JavaScript
- Homepage:
- Size: 136 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# JsonFieldExplorer (jfe)
## Description
JsonFieldExplorer (jfe) is a command-line tool that simplifies the exploration of JSON data structures. It analyzes JSON files and lists all possible field paths, aiding in understanding and navigating complex JSON objects. This tool is especially useful for developers and data analysts working with large and nested JSON files.
# Installation
To install JsonFieldExplorer, use npm:
```bash
npm install -g jsonfieldexplorer
```
This will install jfe globally on your system, allowing you to use it from any directory.
Requires minimum of node 18.x.
# Usage
To use jfe, simply pass the path of your JSON file as an argument:
```bash
jfe path/to/yourfile.json
```
You can also pipe in JSON.
```bash
$ echo '{"a": [{"b": true}]}' | jfe
.a: array
.a[]: object
.a[].b: boolean
```
# Examples
Given a JSON file like this:
```json
{
"organization": {
"name": "OpenAI",
"location": "San Francisco",
"departments": [
{
"name": "Research",
"employees": 10,
"isRemote": true
},
{
"name": "Engineering",
"employees": "80",
"budget": null,
"manager": {
"name": "John Doe",
"title": "Engineering Manager"
}
}
]
}
}
```
Running jfe on this file would produce output similar to the following:
```css
.organization: object
.organization.name: string
.organization.location: string
.organization.departments: array (size: 2)
.organization.departments[]: object
.organization.departments[].name: string
.organization.departments[].employees: number | string
.organization.departments[].isRemote: boolean
.organization.departments[].budget: null
.organization.departments[].manager: object
.organization.departments[].manager.name: string
.organization.departments[].manager.title: string
```
This output indicates that the JSON file contains fields for the organization's name and location, as well as an array of departments, each with its own name and number of employees.
# Roadmap
For future roadmap, features that could be implemented are;
- Show types in order of usage.
- Show enum if variation is small in type.
- Provide a "stat" command to show statistics about the values. Like most common strings (if enum), or min/max/average for numbers.
If you want to contribute with any of these, feel free to send a PR!
# Testing
Test files are included in `/test`. To run test:
```bash
npm test
```
# License
This project is licensed under the ISC License - see the LICENSE.md file for details.