JSON Par mode

JSON Par modeは、EmacsでJSONを構造的に編集をするためのマイナーモードであり、lispyに影響を受けています。

目次

Ctrl無しかつモードレス

ポイントが文字列の外にある場合、各キーはコマンドとして解釈されます。一方ポイントが文字列の上にある場合、キーはそのまま入力されます:

リージョンがアクティブな場合、各キーはコマンドとして解釈されます。

構造に基づく移動

前後のメンバー(キーと値のペア)や、親などへ移動できます:

その他のコマンド:

|[ 1, 2, 3 ]

↓ i (‘json-par-down’)

[ |1, 2, 3 ]


[ 1, 2, 3 ]| 

↓ i (‘json-par-down’)

[ 1, 2, 3| ]

{
  "key|": 123
}

↓ TAB (‘json-par-tab’)

{
  "key": |123
}

↓ S-TAB (‘json-par-mark-head-of-member’)

{
  "*key|": 123
}

[
  "The quick brown |fox jumps over the lazy dog."
]

↓ TAB (‘json-par-tab’)

[
  "The quick brown fox jumps over the lazy dog."| 
]

{
  |"name": "Emacs",
  "website": "https://www.gnu.org/software/emacs/",
  "written_in": [ "C", "Emacs Lisp" ]
}

↓ g (‘json-par-goto-key’) website RET

{
  "name": "Emacs",
  |"website": "https://www.gnu.org/software/emacs/",
  "written_in": [ "C", "Emacs Lisp" ]
}

[
  "a",
  |"b",
  "c"
]

↓ M-x json-par-goto-index 0 RET

[
  |"a",
  "b",
  "c"
]

小技: j、k、J、K以外のコマンドは移動前にマークリングにマークをプッシュします。またbはpop-to-mark-commandにバインドされています。そのためbを押すと移動前の位置に戻れます。

非常口(一時的に無効にする)

qを押すと次のコマンドだけJSON Par modeを無効にできます。Qを押すと明示的に再有効化するまで無効になります。

値や括弧対の挿入

1キーで値を入力できます:

カンマや改行は適宜挿入されます:

[
  [
    1, 2, 3
  ]| 
]

↓ [

[
  [
    1, 2, 3
  ],
  [
    | 
  ]
]

[
  [ 1, 2, 3 ]| 
]

↓ [

[
  [ 1, 2, 3 ],
  [|]
]

↓ 1

[
  [ 1, 2, 3 ],
  [ 1| ]
]

リージョンがアクティブな場合[、{、"でリージョンを囲めます。C-uプレフィックスを付けた場合、"は文字列を展開します。

マークおよび削除

リージョンがアクティブな場合、dや<backspace>でリージョンを削除できます。

リージョンがアクティブでない場合、d+移動キーでメンバーや値をマークできます:

[
  1|,
  2,
  3,
  4
]

↓ d2j (「後続のメンバーを2つマークする」)

[
  1|,
  2,
  3*,
  4
]

↓ d

[
  1|,
  4
]

小技: json-par-action-when-deleting-value-or-memberをdeleteにするとマークせずに削除できます。

<backspace>やC-dを使うと構造を保ったまま様々な物を削除あるいはマークできます:

[ 1, 2, 3 ]| 

↓ <backspace>

[ *1, 2, 3| ]

[]| 

↓ <backspace>

*[]| 

[| 1, 2, 3 ]

↓ <backspace>

[ |1, 2, 3* ]

[|]

↓ <backspace>

|[]*

"Emacs"| 

↓ <backspace>

"*Emacs|"

"|Emacs"

↓ <backspace>

"|Emacs*"

[ 1,| 2 ]

↓ <backspace>

[ *1,| 2 ]

{
  "name":| "Emacs",
  "website": "https://www.gnu.org/sotware/emacs/"
}

↓ <backspace>

{
  *"name": "Emacs",
  |"website": "https://www.gnu.org/sotware/emacs/"
}

オブジェクトや配列の値の削除

v (json-par-delete-object-values)は現在のオブジェクトや配列の値を全て削除します。

{
  "group": "group1",
  "key": "foo",
  "value": |[ 1, 2, 3 ]
}

↓ V

{
  "group": ,
  "key": ,
  "value": | 
}

1行と複数行の切り替え

例:

|[
  [
    1,
    2
  ],
  [
    3,
    4
  ]
]

↓ O (‘json-par-oneline’) ↑ M (‘json-par-multiline’)

|[ [ 1, 2 ], [ 3, 4 ] ]

↓ O

|[[1,2],[3,4]]

{
  "lyrics": |"Twinkle, twinkle, little star,
How I wonder what you are!
Up above the world so high,
Like a diamond in the sky."
}

↓ O (‘json-par-oneline’) ↑ M (‘json-par-multiline’)

{
  "lyrics": |"Twinkle, twinkle, little star,\nHow I wonder what you are!\nUp above the world so high,\nLike a diamond in the sky."
}

|[
  [
    1,
    2
  ],
  [
    3,
    4
  ]
]

↓ C-1 O (レベルが1より大きいメンバーを1行に変換する)

|[
  [ 1, 2 ],
  [ 3, 4 ]
]

↑ C-1 M (レベルが1以下のカンマの後に改行を入れる)

|[ [ 1, 2 ], [ 3, 4 ] ]

括弧のすぐ内側に改行が挿入された場合、各メンバーの後にも改行が挿入されます。括弧のすぐ内側の改行が削除された場合、オブジェクトや配列全体が1行に変換されます:

[| [ 1, 2 ], [ 3, 4 ] ]

↓ RET ↑ <backspace>

[
  |[ 1, 2 ],
  [ 3, 4 ]
]

メンバーの複製

例:

{
  "properties": {
    "tags": |{
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

↓ cj (‘json-par-clone-member-forward’: 現在のメンバーをその後に複製する)

{
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "|tags*": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

[
  {
    "group": |"group1",
    "key": "foo",
    "value": [ 1, 2, 3 ]
  }
]

↓ CJ (‘json-par-clone-parent-forward-without-value’: 親であるメンバーをその後に値を除いて複製する)

[
  {
    "group": "group1",
    "key": "foo",
    "value": [ 1, 2, 3 ]
  },
  {
    "group": |,
    "key": ,
    "value":
  }
]

発展: cの後にhやiを押すと複製する祖先を選択できます。

補完

? (json-par-insert-guessed)はJSONの値やキーに対するdabbrev-expandです。つまり文脈から推測した値やキーを挿入します:

{
   "properties": {
     "id": {
       "type": "string",
       "minLength": 1
     },
     "name": {
       "type": "string"
     },
     "email": | 
   }
}

↓ ?

{
   "properties": {
     "id": {
       "type": "string",
       "minLength": 1
     },
     "name": {
       "type": "string"
     },
     "email": {
       "type": "string"
     }| 
   }
}

↓ ?

{
   "properties": {
     "id": {
       "type": "string",
       "minLength": 1
     },
     "name": {
       "type": "string"
     },
     "email": {
       "type": "string",
       "minLength": 1
     }| 
   }
}

前述の例では、まず現在のバッファや他のJSONのバッファから"email"キーを探します。その後、"properties"を探してその孫を抽出します。json-par-guess-max-ancestorsは検索に使う祖先をどれだけ辿るのか制御します。

ポイントがオブジェクトの内部にあり、キーの後にない場合は、キーを補完します:

{
   "properties": {
     "id": {
       "type": "string",
       "minLength": 1
     },
     "name": {
       "type": "string"
     },
     "email": {
       "type": "string"| 
     }
   }
}

↓ ?

{
   "properties": {
     "id": {
       "type": "string",
       "minLength": 1
     },
     "name": {
       "type": "string"
     },
     "email": {
       "type": "string",
       "minLength": | 
     }
   }
}

キーを推測する場合、祖先のキー("email"や"properties")と兄弟のキー("type")を使います。

メンバーの入れ替え

{
  "key": |"key1",
  "value": "value1"
}

↓ s (‘json-par-transpose-member-forward’) ↑ w (‘json-par-transpose-member-backward’)

{
  "value": "value1",
  "key": |"key1"
}

メンバーの昇格

{
  "items" {
    "oneOf": [
      |{ "$ref": "#/definitions/Foo" },
      { "$ref": "#/definitions/Bar" }
    ]
  }
}

↓ r (‘json-par-raise-member’)

{
  "items" {
    |{ "$ref": "#/definitions/Foo" }
  }
}

DWIM(いい感じに)マークやナロー

m (json-par-mark-more)やC-M-SPCを繰り返し押すと、リージョンを拡張できます。C-uプレフィックスを付けると拡張を取り消せます。

同様に、N (json-par-narrow)で現在の値やキーにナロー(表示範囲の限定)でき、繰り返すと拡張できます。

分割/結合

S (json-par-split)でポイントがある文字列やオブジェクトや配列を分割できます。F (json-par-join)で2つの文字列や配列やオブジェクトを結合できます。

ウィンドウ外の祖先の祖先

カスタム変数を設定すると、ウィンドウ外の祖先を表示できます::

• json-par-show-ancestors-out-of-window: nilでない場合、ウィンドウ外の祖先を表示する。
• json-par-highlight-ancestors: nilでない場合、ポイントがあるメンバーの祖先をハイライトする。
• json-par-highlight-ancestors: nilでない場合、ポイントがあるメンバーをハイライトする。

祖先は次のフェイスで表示されます:

• json-par-ancestor-out-of-window-face
• json-par-ancestor-face
• json-par-current-member-face

また、祖先や現在のメンバーの前に文字を表示できます:

• json-par-char-before-ancestor: nilでない場合、この文字を祖先の前に表示する。
• json-par-char-before-current-member: nilでない場合、この文字をポイントがあるメンバーの前に表示する。