1.0.0 • Published 8 years ago

JSON-Splora v1.0.0

Weekly downloads
22
License
MIT
Repository
github
Last release
8 years ago

JSON-Splora

Warning: Name Change!

JSON-Splora is becoming json-splora. This is because of a bug with npm confusing the two packages. I am releasing 1.0.0 and deprecating "JSON-Splora" module and moving to "json-splora". I apologize for any inconvenience.

JSON-Splora is a GUI for editing, visualizing, and manipulating JSON data with jq or JavaScript.

Demo

Join the chat at https://gitter.im/JSON-Splora/Lobby

Design

The editor is a JavaScript editor, and the input is parsed as json5. This allows for comments as well as a relaxed JSON input format. Once the editor has valid JSON, an input window will appear below, allowing you to manipulate the object with JavaScript or jq. A panel will appear to the right with the output, and updates live as the input or filter changes.

Input

  • URLs resolve to any JSON they return
  • Drag-and-drop or open any file
  • Plain text input

Filters

  • First evaluated as JavaScript with output = x${filter}
  • If JS fails, it attempts to use jq

Command Line

jsplora [file]

Install

Globally

This will create the application as well as the alias jsplora.

npm i -g JSON-Splora

Locally

Building locally creates a directory JSON-Splora-<system> which contains the application.

npm install

# build for darwin, linux, win32
npm run-script build-darwin
npm run-script build-linux
npm run-script build-win32

Contributing

Contributions are welcome! Please read through and follow the style of the rest of the code. eslint is used as a code pre-commit hook, and will catch many simple errors. Please squash your commits and leave concise commit messages.

License

MIT