言語設定ガイド
contributes.languages
貢献ポイントを使用すると、以下の宣言型言語機能を制御する言語構成を定義できます。
- コメントの切り替え
- ブラケットの定義
- 自動閉じ
- 自動囲み
- 折りたたみ
- 単語パターン
- インデントルール
JavaScript ファイルの編集体験を構成する言語構成のサンプルはこちらです。このガイドでは、language-configuration.json
の内容を説明します。
注: 言語構成ファイル名が language-configuration.json
であるか、これで終わる場合、VS Code で自動補完と検証が行われます。
{
"comments": {
"lineComment": "//",
"blockComment": ["/*", "*/"]
},
"brackets": [
["{", "}"],
["[", "]"],
["(", ")"]
],
"autoClosingPairs": [
{ "open": "{", "close": "}" },
{ "open": "[", "close": "]" },
{ "open": "(", "close": ")" },
{ "open": "'", "close": "'", "notIn": ["string", "comment"] },
{ "open": "\"", "close": "\"", "notIn": ["string"] },
{ "open": "`", "close": "`", "notIn": ["string", "comment"] },
{ "open": "/**", "close": " */", "notIn": ["string"] }
],
"autoCloseBefore": ";:.,=}])>` \n\t",
"surroundingPairs": [
["{", "}"],
["[", "]"],
["(", ")"],
["'", "'"],
["\"", "\""],
["`", "`"]
],
"folding": {
"markers": {
"start": "^\\s*//\\s*#?region\\b",
"end": "^\\s*//\\s*#?endregion\\b"
}
},
"wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)",
"indentationRules": {
"increaseIndentPattern": "^((?!\\/\\/).)*(\\{[^}\"'`]*|\\([^)\"'`]*|\\[[^\\]\"'`]*)$",
"decreaseIndentPattern": "^((?!.*?\\/\\*).*\\*/)?\\s*[\\)\\}\\]].*$"
}
}
コメントの切り替え
VS Code には、コメントの切り替えに関する2つのコマンドがあります。行コメントを切り替え と ブロックコメントを切り替え です。VS Code が行/ブロックをどのようにコメントアウトするかを制御するために、comments.blockComment
と comments.lineComment
を指定できます。
{
"comments": {
"lineComment": "//",
"blockComment": ["/*", "*/"]
}
}
ブラケットの定義
ここで定義されたブラケットにカーソルを移動すると、VS Code はそのブラケットと対応するペアを強調表示します。
{
"brackets": [
["{", "}"],
["[", "]"],
["(", ")"]
]
}
さらに、ブラケットへ移動 または ブラケットまで選択 を実行すると、VS Code は上記の定義を使用して最も近いブラケットとその対応するペアを見つけます。
自動閉じ
'
を入力すると、VS Code は一対の単一引用符を作成し、カーソルをその間に配置します: '|'
。このセクションでは、そのようなペアを定義します。
{
"autoClosingPairs": [
{ "open": "{", "close": "}" },
{ "open": "[", "close": "]" },
{ "open": "(", "close": ")" },
{ "open": "'", "close": "'", "notIn": ["string", "comment"] },
{ "open": "\"", "close": "\"", "notIn": ["string"] },
{ "open": "`", "close": "`", "notIn": ["string", "comment"] },
{ "open": "/**", "close": " */", "notIn": ["string"] }
]
}
notIn
キーは、特定のコード範囲でこの機能を無効にします。たとえば、次のコードを記述している場合
// ES6's Template String
`ES6's Template String`;
単一引用符は自動的に閉じられません。
notIn
プロパティを必要としないペアには、よりシンプルな構文を使用することもできます。
{
"autoClosingPairs": [
["{", "}"],
["[", "]"]
]
}
ユーザーは、editor.autoClosingQuotes
および editor.autoClosingBrackets
設定で自動閉じの動作を微調整できます。
自動閉じの前に
デフォルトでは、VS Code はカーソルの直後に空白がある場合にのみペアを自動的に閉じます。したがって、次の JSX コードで {
を入力しても、自動閉じはされません。
const Component = () =>
<div className={>
^ Does not get autoclosed by default
</div>
ただし、この定義はその動作を上書きします。
{
"autoCloseBefore": ";:.,=}])>` \n\t"
}
これで、>
の直前に {
を入力すると、VS Code は }
で自動的に閉じます。
自動囲み
VS Code で範囲を選択し、開始ブラケットを入力すると、VS Code は選択されたコンテンツを一対のブラケットで囲みます。この機能は自動囲みと呼ばれ、ここでは特定の言語の自動囲みペアを定義できます。
{
"surroundingPairs": [
["{", "}"],
["[", "]"],
["(", ")"],
["'", "'"],
["\"", "\""],
["`", "`"]
]
}
ユーザーは、editor.autoSurround
設定で自動囲みの動作を微調整できます。
折りたたみ
VS Code では、折りたたみはインデントベース、または貢献された折りたたみ範囲プロバイダーによって定義されます。
- マーカーによるインデントベースの折りたたみ:指定された言語に折りたたみ範囲プロバイダーが利用できない場合、またはユーザーが
editor.foldingStrategy
をindentation
に設定している場合、インデントベースの折りたたみが使用されます。折りたたみ領域は、行が1つ以上の後続の行よりも小さいインデントを持つときに開始し、同じまたは小さいインデントを持つ行があるときに終了します。空行は無視されます。さらに、言語構成で開始マーカーと終了マーカーを定義できます。これらは、folding.markers
のstart
およびend
正規表現として定義されます。一致する行が見つかると、ペア内に折りたたみ範囲が作成されます。折りたたみマーカーは空であってはならず、通常は//#region
および//#endregion
のようになります。
次の JSON は、//#region
および //#endregion
の折りたたみマーカーを作成します。
{
"folding": {
"markers": {
"start": "^\\s*//\\s*#?region\\b",
"end": "^\\s*//\\s*#?endregion\\b"
}
}
}
- 言語サーバーの折りたたみ:言語サーバーは、
textDocument/foldingRange
リクエストに折りたたみ範囲のリストで応答し、VS Code はその範囲を折りたたみマーカーとしてレンダリングします。言語サーバープロトコルでの折りたたみサポートの詳細については、プログラムによる言語機能のトピックを参照してください。
単語パターン
wordPattern
は、プログラミング言語で単語と見なされるものを定義します。wordPattern
が設定されている場合、コード提案機能はこの設定を使用して単語の境界を決定します。この設定は、エディター設定 editor.wordSeparators
によって制御される単語関連のエディターコマンドには影響しませんのでご注意ください。
{
"wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)"
}
インデントルール
indentationRules
は、入力、貼り付け、行の移動時にエディターが現在の行または次の行のインデントをどのように調整するかを定義します。
{
"indentationRules": {
"increaseIndentPattern": "^((?!\\/\\/).)*(\\{[^}\"'`]*|\\([^)\"'`]*|\\[[^\\]\"'`]*)$",
"decreaseIndentPattern": "^((?!.*?\\/\\*).*\\*/)?\\s*[\\)\\}\\]].*$"
}
}
たとえば、if (true) {
が increaseIndentPattern
に一致する場合、開き括弧 {
の後に Enter を押すと、エディターは自動的に1回インデントし、コードは次のようになります。
if (true) {
console.log();
increaseIndentPattern
および decreaseIndentPattern
の他に、2つのインデントルールがあります。
indentNextLinePattern
- このパターンに一致する行の場合、その後の次の行のみが1回インデントされます。unIndentedLinePattern
- このパターンに一致する行の場合、そのインデントは変更されず、他のルールに対して評価されません。
プログラミング言語にインデントルールが設定されていない場合、行が開き括弧で終わるときはエディターはインデントし、閉じ括弧を入力するときはアウトデントします。ここでいう括弧は brackets
で定義されます。
editor.formatOnPaste
設定は、DocumentRangeFormattingEditProvider
によって制御され、自動インデントには影響されないことに注意してください。
Enter キーを押したときのルール
onEnterRules
は、エディターで Enter が押されたときに評価されるルールのリストを定義します。
{
"onEnterRules": [
{
"beforeText": "^\\s*(?:def|class|for|if|elif|else|while|try|with|finally|except|async).*?:\\s*$",
"action": { "indent": "indent" }
}
]
}
Enter を押すと、カーソルの前、後、または1行上のテキストが以下のプロパティに対してチェックされます。
beforeText
(必須)。カーソルの前のテキストに一致する正規表現 (現在の行に限定)。afterText
。カーソルの後のテキストに一致する正規表現 (現在の行に限定)。previousLineText
。カーソルから1行上のテキストに一致する正規表現。
指定されたすべてのプロパティが一致する場合、そのルールが一致したと見なされ、それ以上の onEnterRules
は評価されません。onEnterRule
は以下の動作を指定できます。
indent
(必須)。none, indent, outdent, indentOutdent
のいずれか。none
は、新しい行が現在の行のインデントを継承することを意味します。indent
は、新しい行が現在の行に対して相対的にインデントされることを意味します。outdent
は、新しい行が現在の行に対して相対的にアウトデントされることを意味します。indentOutdent
は、2つの新しい行が挿入され、1つはインデントされ、もう1つはアウトデントされることを意味します。
appendText
。新しい行とインデントの後に追記される文字列。removeText
。新しい行のインデントから削除する文字数。