FarNet.JsonKit 0.1.1

FarNet.JsonKit

Far Manager JSON helpers

• About
• Install
• Commands
  • jk:open
• Panels
  • Array panel
  • Object panel
• Editing

About

JsonKit is the FarNet module for JSON operations in Far Manager.

Project FarNet

• Wiki: https://github.com/nightroman/FarNet/wiki
• Site: https://github.com/nightroman/FarNet
• Author: Roman Kuzmin

Install

• Far Manager
• Package FarNet
• Package FarNet.JsonKit

How to install and update FarNet and modules
https://github.com/nightroman/FarNet#readme

Commands

JsonKit commands start with jk:. Commands are invoked in the command line or using F11 / FarNet / Invoke or defined in the user menu and file associations. Command parameters are key=value pairs using the connection string format

jk:command key=value; ...

Commands

• jk:open

  Opens JSON file in Array panel or Object panel.

jk:open

Opens JSON file in Array panel or Object panel. The file may have several JSON values separated by spaces, tabs, new lines.

Syntax

jk:open file=<string>

Parameters

• file=<string> (required)

  Specifies the JSON file path. Environment variables are expanded.

Panels

Panels used for browsing and editing JSON

• Array panel
• Object panel

Array panel

Shows array values.

Keys and actions

• Enter

  For arrays and objects, opens their panels.

• F4

  Opens the cursor value editor.

• Del, F8

  Removes selected items.

• ShiftDel, ShiftF8

  Sets nulls to selected items.

• CtrlS

  Saves JSON to the source file.

Object panel

Shows object property names and values.

Keys and actions

• Enter

  For arrays and objects, opens their panels.

• F4

  Opens the cursor value editor.

• Del, F8

  Removes selected items.

• ShiftDel, ShiftF8

  Sets nulls to selected items.

• CtrlS

  Saves JSON to the source file.

Editing

In array and object panels, use the following keys for editing:

• F4 to edit the cursor item in the editor
• Del, F8 to remove selected items
• ShiftDel, ShiftF8 to set nulls

String values are opened in the editor as plain text. Strings cannot be changed to other JSON types in the editor. But you can set a string to null (ShiftDel, ShiftF8) in a panel and then edit this null.

Other values are opened in the editor as formatted JSON. This includes null, true, false, number, array, and object. Change this JSON to any valid JSON value, same type or not.

Saving in the editor updates JSON nodes in panels but does not save the file. You may have several node edits before saving the file.

Use CtrlS in panels in order to save the file. If you do not save manually then you are prompted to save when the root panel is about to close and JSON contains not saved changes.

Notes

Editors are not modal, you may have several values edited at the same time. You may keep value editors opened after closing source panels. But if you plan saving changes in editors then do so before closing source panels, because JSON files are saved from panels.

Note that removing items in array and object panels detaches their opened editors from the source. Saving changes in these editors is not possible.