Contribution Points - package.json | 非公式

このドキュメントではpackage.jsonで定義する様々なコントリビューションポイントについて説明します。

contributes.configuration

ユーザーに公開する設定の構成キーを提供します。これによりユーザーは、ユーザー設定またはワークスペース設定のいずれかで構成オプションを設定できます。

構成キーを提供することで、キーを記述するJSONスキーマを実際に提供します。これにより、設定を構成する際にユーザーは優れたツールサポートを受けるようになります。

あなたはこの値をvscode.workspace.getConfiguration('myExtension')を使用して拡張機能から読み込むことができます。

Example

"contributes": {
    "configuration": {
        "type": "object",
        "title": "TypeScript configuration",
        "properties": {
            "typescript.useCodeSnippetsOnMethodSuggest": {
                "type": "boolean",
                "default": false,
                "description": "Complete functions with their parameter signature."
            },
            "typescript.tsdk": {
                "type": ["string", "null"],
                "default": null,
                "description": "Specifies the folder path containing the tsserver and lib*.d.ts files to use."
            }
        }
    }
}

configuration extension point example

contributes.configurationDefaults

既定の言語固有のエディター構成を提供します。これにより、提供された言語の既定のエディター構成を上書きします。
次の例はmarkdownの既定のエディター設定を提供します:

Example

contributes": {
    "configurationDefaults": {
        "[markdown]": {
            "editor.wordWrap": "on",
            "editor.quickSuggestions": false
        }
    }
}

contributes.commands

コマンドパレット(⇧⌘P (Windows, Linux Ctrl+Shift+P))にコマンドを提供します

Note: コマンドが(キーバインドかコマンドパレットから)呼び出されたとき、VS CodeはactivationEvent onCommand:${command} を発行します。

Example

"contributes": {
    "commands": [{
        "command": "extension.sayHello",
        "title": "Hello World"
    }]
}

commands extension point example

contributes.menus

エディターやエクスプローラーへメニュー項目を提供します。この定義には選択したときに呼びだすコマンドと、項目を表示する条件を含みます。後者は、キーバインドの when clause contextsで使うwhen節で定義されます。必須のcommandプロパティに加えて、代替コマンドはaltプロパティを使って定義できます。これはメニュー項目をホバーしている間にAltを押すと表示して呼び出します。最後にgroupプロパティはメニュー項目のソートとグループ化を定義します。その中でnavigationグループは特別で、常にメニューのトップ(先頭)にソートします。

現在、開発者は次を提供できます:

コマンドパレット - commandPalette
エクスプローラーのコンテキストメニュー - explorer/context
エディターのコンテキストメニュー - editor/context
エディターのタイトルメニュー - editor/title
エディターのタイトルのコンテキストメニュー - editor/title/context
デバッグコールスタックのコンテキストメニュー - debug/callstack/context
The SCM title menu - scm/title
SCM resource groups menus - scm/resourceGroup/context
SCM resources menus - scm/resource/context

Note: コマンドが(コンテキスト)メニューから呼び出されると、VS Codeは現在選択されているリソースを推定しようとして、コマンドを呼び出すときにパラメーターとして渡します。たとえば、エクスプローラー内のメニュー項目は選択したリソースのURLを渡して、エディタ内のメニュー項目ではドキュメントのURLを渡します。

その中でcommandPaletteは全てのコマンドを含んでいるため特殊です。なお、コマンドをその場所にのみ表示するようにするにはwhen節を利用します。タイトルに加えて、コマンドはVS Codeがエディターのメニューバーで表示するアイコンを定義することもできます。

Example

"contributes": {
    "menus": {
        "editor/title": [{
            "when": "resourceLangId == markdown",
            "command": "markdown.showPreview",
            "alt": "markdown.showPreviewToSide",
            "group": "navigation"
        }]
    }
}

menus extension point example

Sorting of groups

メニュー項目をグループに分類できます。これらは、以下の既定ルールに沿って辞書式順序でソートします。

エディタのコンテキストメニューには、次のデフォルト値があります:

navigation - 常に最初に表示します。
1_modification - 次にきてコードを変更するコマンドを含みます。
9_cutcopypaste - 最後にきて基本的な編集コマンドを含みます。

Menu Group Sorting

あなたはこのグループでメニュー項目を追加したり、メニュー項目の新しいグループを上下中央のいずれかに追加できます。エディターのコンテキストメニューのみがこのグループ化の制御許されています。

Sorting inside groups

グループ内の順序はタイトルや順序属性(order-attribute)に依存します。次に示すように、メニュー項目のグループローカル順序は@<number>をグループ識別子に追加することで指定します:

"editor/title": [{
    "when": "editorHasSelection",
    "command": "extension.Command",
    "group": "myGroup@1"
}]

contributes.keybindings

ユーザーがキーの組み合わせを押したときに呼びだすキーバインドを提供します。キーバインドについて詳しく説明しているKey Bindingsトピックを確認してください。

キーバインドを提供すると、既定のキーボードショートカットと全てのUI表現に追加のキーバインドを表示します。もちろんユーザーがキーの組み合わせを押すば、コマンドを呼び出せます。

Note: VS CodeはWindows、Mac、Linux上で動作します。修飾子が異なる場合には”key”を使用して規定のキー組み合わせを設定し、特定のOS上で上書きしてください。
Note: コマンドが(キーバインドかコマンドパレットから)呼び出されたとき、VS CodeはactivationEvent onCommand:${command} を発行します。

Example

WindowsとLinuxでCtrl+F1、MacではCmd+F1を定義して"extension.sayHello"をトリガーします。

"contributes": {
    "keybindings": [{
        "command": "extension.sayHello",
        "key": "ctrl+f1",
        "mac": "cmd+f1",
        "when": "editorTextFocus"
    }]
}

keybindings extension point example

contributes.languages

言語の宣言を提供します。これは新しい言語を導入したり、既にVS Codeにある言語に関する情報を補充します。

これにおいて、言語を基本的にファイルに関連付けられた文字列の識別子で表します。(参照TextDocument.getLanguageId())

VS Codeはファイルに関連付けられている言語を決定するために3つのヒントを使用します。それぞれの「ヒント」を個別に補完できます:

ファイル名の拡張子(以下extensions)
ファイル名(以下filenames)
ファイルの最初の行(以下firstLine)

ユーザーがファイルを開くと、これらの3つのルールを適用して、言語を決定します。このときVS CodeはactivationEvent onLanguage:${language}を発行します。(下記の例では:onLanguage:python)

aliasesプロパティには他人が言語を識別できる名前を指定します。このリストの最初の項目は、右側のステータスバーに表示する言語ラベルとして選択されます。

configurationプロパティは、言語の構成オプションを含むファイルパスを指定します。パスは拡張機能フォルダーとの相対パスで、通常は./language-configuration.jsonです。このファイルはJSON形式を使用し、次のプロパティを含むことができます:

comments - コメント記号を定義します。
- blockComment - ブロックコメントをマークする開始と終了のトークンを指定します。’Toggle Block Comment’コマンドによって使用されます。
- lineComment - 行コメントをマークする開始トークンを指定します。 ‘Add Line Comment’コマンドによって使用されます。
brackets - 括弧の間のインデントに影響する括弧記号を定義します。新しい行を挿入するときに新しいインデントレベルを決定または修正するためにエディターで使用されます。
autoClosingPairs - Auto-Close機能の開始と終了の記号を定義します。開始記号を入力すると、エディターは終了記号を挿入します。これは、オプションでnotInパラメーターをとってペアの文字列かコマンドを無効化します。
surroundingPairs - 文字列を囲う文字の開始と終了のペアを定義します。

もし言語構成のファイル名がlanguage-configuration.jsonで終わるものであれば、VS Code内で検証と編集ができます。

Example

...
"contributes": {
    "languages": [{
        "id": "python",
        "extensions": [ ".py" ],
        "aliases": [ "Python", "py" ],
        "filenames": [ ... ],
        "firstLine": "^#!/.*\\bpython[0-9.-]*\\b",
        "configuration": "./language-configuration.json"
    }]
}

language-configuration.json

{
    "comments": {
        "lineComment": "//",
        "blockComment": [ "/*", "*/" ]
    },
    "brackets": [
        ["{", "}"],
        ["[", "]"],
        ["(", ")"]
    ],
    "autoClosingPairs": [
        ["{", "}"],
        ["[", "]"],
        ["(", ")"],
        { "open": "'", "close": "'", "notIn": ["string", "comment"] },
        { "open": "/**", "close": " */", "notIn": ["string"] }
    ],
    "surroundingPairs": [
        ["{", "}"],
        ["[", "]"],
        ["(", ")"],
        ["<", ">"],
        ["'", "'"]
    ]
}

contributes.debuggers

デバッグアダプターを提供します。これには次のプロパティがあります:

type は起動設定でこのデバッガーを識別する固有のIDです。
label はデバッグアダプターの表示名です。
program は実際のデバッガまたはランタイムに対してVS Codeデッグプロトコルを実装する、デバッグアダプタープログラムへのパスです。
runtime はデバッグアダプターのプログラム属性が実行可能ファイルではなく、ランタイムが必要な場合に指定します。
configurationAttributes は`launch.json’ を検証するためのJSONスキーマ構成です。
initialConfigurations は初期 ‘launch.json’を生成するための構成です。
configurationSnippets はlaunch.jsonを編集するときにIntelliSenseで新しい構成を追加するためのスニペットを構成します。
variables は置換変数を導入して、デバッガ拡張拡張機能で実装したコマンドにバインドします。

Example

"contributes": {
    "debuggers": [{
        "type": "node",
        "label": "Node Debug",
        "program": "./out/node/nodeDebug.js",
        "runtime": "node",
        "configurationAttributes": {
            "launch": {
                "required": [ "program" ],
                "properties": {
                    "program": {
                        "type": "string",
                        "description": "The program to debug."
                    }
                }
            }
        },
        "initialConfigurations": [{
            "type": "node",
            "request": "launch",
            "name": "Launch Program",
            "program": "${workspaceRoot}/app.js"
        }],
        "configurationSnippets": [
            {
                "label": "Node.js: Attach Configuration",
                "description": "A new configuration for attaching to a running node program.",
                "body": {
                    "type": "node",
                    "request": "attach",
                    "name": "${2:Attach to Port}",
                    "port": 5858
                }
            }
        ],
        "variables": {
            "PickProcess": "extension.node-debug.pickNodeProcess"
        }
    }]
}

debuggerを統合する方法についてはDebuggersを参照してください。

contributes.breakpoints

通常デバッガー拡張機能でブレークポイントも提供します。これにブレークポイントを有効にする任意の言語ファイルタイプを設定します。

"contributes": {
    "breakpoints": [
        {
            "language": "javascript"
        },
        {
            "language": "javascriptreact"
        }
    ]
}

contributes.grammars

TextMate文法を提供します。あなたは文法を適応するlanguageに文法とファイルパスのためのTextMate scopeNameを提供しなければなりません。

Note: 文法を含むファイルは、JSON(.jsonで終わるファイル名)またはXML plist format (全てファイル)にすることができます。

Example

"contributes": {
    "grammars": [{
        "language": "shellscript",
        "scopeName": "source.shell",
        "path": "./syntaxes/Shell-Unix-Bash.tmLanguage"
    }]
}

TextMateの.tmLanguageファイルをyo code extension generatorを使用して、簡単にパッケージ化する方法をAdding Language Colorization で参照してください。

grammars extension point example

contributes.themes

VS CodeにTextMateの配色テーマを提供します。エディターの周囲の色を定義する基本テーマをdarkかlightから選択し、ファイル(XML plist format)へのパスを指定する必要があります。

Example

"contributes": {
    "themes": [{
        "label": "Monokai",
        "uiTheme": "vs-dark",
        "path": "./themes/Monokai.tmTheme"
    }]
}

themes extension point example

yo code extension generatorを使用してTextMate .tmThemeファイルを簡単に拡張機能へパッケージ化する方法については、Changing the Color Themeを参照してください。

contributes.snippets

"contributes": {
    "snippets": [{
        "language": "go",
        "path": "./snippets/go.json"
    }]
}

contributes.jsonValidation

特定jsonファイルにJSONスキーマ構成を提供します。url値には拡張機能内のスキーマへの相対パスか、scheme URLを指定できます。

"contributes": {
    "jsonValidation": [{
        "fileMatch": ".jshintrc",
        "url": "http://json.schemastore.org/jshintrc"
    }]
}

次のステップ

VS Codeの拡張モデルの詳細については次のトピックを試してください:

Extension Manifest File - VS Code package.json extension manifest file reference
Activation Events - VS Code activation events reference

Visual Studio Code

Contribution Points - package.json

Last updated: 2018-03-10

contributes.configuration

Example

contributes.configurationDefaults

Example

contributes.commands

Example

contributes.menus

Example

Sorting of groups

Sorting inside groups

contributes.keybindings

Example

contributes.languages

Example

contributes.debuggers

Example

contributes.breakpoints

contributes.grammars

Example

contributes.themes

Example

contributes.snippets

contributes.jsonValidation

次のステップ