Skip to content

An extensible JSON Viewer, Editor, Formatter, Validator based on Monaco Editor

License

Notifications You must be signed in to change notification settings

agneym/json-formatter

Repository files navigation

JSON Crew

All Contributors

badge Netlify Status code style: prettier

PRs Welcome first-timers-only Friendly

An extensible JSON Viewer, Editor, Formatter and Validator that works completely on the client side.

Features

  1. JSON Viewer & Editor
  2. JSON Formatting with options.
  3. JSON Validation with respect to readily available schemas (with option to bring your own schema)
  4. PWA - You can install this directly from your browser.
  5. Upload JSON from your system or load directly from URL
  6. Download formatted JSON
  7. Share JSON with peer to peer
  8. Search & Replace words/expressions with support for case matching, regular expressions
  9. Multi-cursor editing support
  10. Editor theming support
  11. Supports Plugins to extend Functionality.

How to create a JC Plugin

JSON Crew Plugin system is based on Web Components.

It gives the JSON data entered by the user as input to the web component and allows it to render the UI for plugin area. From here, you can transform the JSON and emit a custom event json-transform with transformed JSON as the transformation response.

  1. Web Component gets data as input
  2. Render UI and allow user to configure the transformation
  3. Emit a custom event json-transform to show the transformed JSON to the user.
  4. Give me a PR editing the listing file

Tutorial Blog

A Starting Template with Lit Element can be found here

Contributing

npm install
npm start

Development server started at http://localhost:3000.

For more details, view Contributing Guidelines

Twitter Follow

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Amal Jose A

🔌

This project follows the all-contributors specification. Contributions of any kind welcome!