第2章 Che-Theia IDE の基本

このセクションでは、Red Hat CodeReady Workspaces のネイティブ統合開発環境である Che-Theia の基本ワークフローおよびコマンドを説明します。

2.1. Che-Theia のカスタムコマンドの定義
リンクのコピー

Che-Theia IDE を使用すると、ユーザーは devfile でカスタムコマンドを定義できます。これは、ワークスペースで作業する場合に利用できます。

以下は、devfile の commands セクションの例です。

commands:
- name: theia:build
  actions:
  - type: exec
    component: che-dev
    command: >
              yarn
    workdir: /projects/theia
- name: run
  actions:
  - type: vscode-task
    referenceContent: |
            {
             "version": "2.0.0",
             "tasks":
             [
              {
               "label": "theia:watch",
                "type": "shell",
                "options": {"cwd": "/projects/theia"},
                "command": "yarn",
                "args": ["watch"]
              }
             ]
            }
- name: debug
  actions:
  - type: vscode-launch
    referenceContent: |
            {
             "version": "0.2.0",
             "configurations": [
              {
               "type": "node",
               "request": "attach",
               "name": "Attach by Process ID",
               "processId": "${command:PickProcess}"
              }
             ]
            }

commands:
- name: theia:build
  actions:
  - type: exec
    component: che-dev
    command: >
              yarn
    workdir: /projects/theia
- name: run
  actions:
  - type: vscode-task
    referenceContent: |
            {
             "version": "2.0.0",
             "tasks":
             [
              {
               "label": "theia:watch",
                "type": "shell",
                "options": {"cwd": "/projects/theia"},
                "command": "yarn",
                "args": ["watch"]
              }
             ]
            }
- name: debug
  actions:
  - type: vscode-launch
    referenceContent: |
            {
             "version": "0.2.0",
             "configurations": [
              {
               "type": "node",
               "request": "attach",
               "name": "Attach by Process ID",
               "processId": "${command:PickProcess}"
              }
             ]
            }

Copy to Clipboard

Toggle word wrap

CodeReady Workspaces コマンド

theia:build

exec タイプは、CodeReady Workspaces ランナーがコマンド実行に使用されることを意味します。ユーザーは、コマンドが実行されるコンテナー内のコンポーネントを指定できます。
コマンド フィールドには、実行のコマンドラインが含まれます。
workdir は、コマンドを実行する作業ディレクトリーです。

Visual Studio Code(VS Code)タスク

run

タイプは vscode -task です。
このタイプのコマンドでは、referenceContent フィールド に VS Code 形式のタスク設定のコンテンツが含まれている必要があります。
VS Code タスクの詳細は、「 Visual Studio User Guide」ページの Task セクションを参照してください。

vs コード起動の設定

debug

タイプは vscode -launch です。
VS Code 形式の起動設定が含まれます。
VS コード起動設定の詳細は、Visual Studio のドキュメントページの Debugging セクションを参照してください。

利用可能なタスクおよび起動設定の一覧は、以下を参照してください。

/projects/.theia ディレクトリーの tasks.json ファイル
/home/theia/.theia ディレクトリー内の launch.json ファイル
theia -ide コンテナーから。

2.1.1. CHECH: Theia task type
リンクのコピー

devfile の commands セクションでは、CodeReady Workspaces ワークスペースを実行する際に、ユーザーは特定のアクションを自動化できます。

CodeReady Workspaces コマンドには、以下の 3 つのタイプがあります。

EXEC:exec タイプの各コマンドは、タイプ codeready の Che-Theia タスクに変換されます。codeready コマンドはシェルコマンドを実行しますが、通常の Che-Theia シェルタイプのタスクとは対照的に、ユーザーはコマンド実行用のワークスペースコンテナーを選択できます。
vscode-task: vscode-task は、特定のコマンドの referenceContentfield の内容を Che-Theia の ユーザーレベルのタスク設定に直接コピーする単一のコマンドタイプです。
vscode-launch: vscode -task コマンドの関数として機能しますが、タスク設定にコピーされる代わりに、referenceContent フィールド の内容は launch.json 設定ファイルにコピーされます。

codeready タイプのタスク（ exec コマンドとも呼ばれる）は 、Terminal→Run Task メニューから、または My Workspace パネルでクリックして実行できます。その他のタスクは 、Terminal→Run Task でのみ利用できます。起動設定は Che-Theia デバッガーで利用できます。

たとえば、以下のようになります。

以下の例は、codeready タスクと vscode -task タスク サンプルです。

Che-Theia のカスタムコマンドの定義で、 theia ワークスペース に theia:watch および theia:build タスクを設定します。

Theia:watch:watch: 監視 モード で theia プロジェクト を実行する。
Theia:build: は、che-dev コンポーネントで theia プロジェクト をビルドします。

上記の例の theia :buildで使用されている codeready コマンドの説明

exec タイプは、CodeReady Workspaces ランナーがコマンド実行に使用されることを意味します。
ユーザーは、コマンドが実行されるコンテナー内のコンポーネントを指定できます。
コマンド フィールドには、実行のコマンドラインが含まれます。
workdir は、コマンドを実行する作業ディレクトリーです。

これらのタスクは 、Terminal→Run Task メニューからワークスペースで実行するか、My Workspace パネルでクリックします。

その他の例

2.1.2. 実行中およびデバッグ
リンクのコピー

che-Theia はデバッグアダプタープロトコルをサポートします。このプロトコルは、開発ツールがデバッガーと通信する方法の一般的な方法を定義します。これは、Che-Theia がすべての実装と連携することを意味します。

前提条件

Red Hat CodeReady Workspaces の稼働中のインスタンス。Red Hat CodeReady Workspaces のインスタンスをインストールするには、「 Installing CodeReady Workspaces on OpenShift Container Platform 」を参照してください。

手順

アプリケーションをデバッグするには、以下を実行します。

Debug Add Configuration をクリックして、デバッグを追加するか、またはプロジェクトに設定を起動します。

View larger image
ポップアップメニューから、デバッグするアプリケーションに適した設定を選択します。

View larger image
属性を変更または追加して、設定を更新します。

View larger image
ブレークポイントは、エディターのマージンをクリックすると切り替えることができます。

View larger image
コンテキストメニューを開いた後に、Edit Breakpoint コマンド を使用して条件を追加します。

View larger image

その後、IDE は Expresion 入力フィールド を 表示します。

View larger image
デバッグを開始するには 、View→Debug をクリックします。

View larger image
Debug ビューで設定を選択し、F5 を押してアプリケーションをデバッグします。または、Ctrl+F5 を押して、デバッグなしでアプリケーションを起動します。

View larger image

2.1.3. タスクの編集および設定の起動
リンクのコピー

手順

設定ファイルをカスタマイズするには、以下を実行します。

tasks.json または launch.json 設定ファイルを編集します。
設定ファイルに新しい定義を追加するか、または既存の定義を変更します。
注記
この変更は設定ファイルに保存されます。
プラグインが提供するタスク設定をカスタマイズするには、Terminal Configure Task メニュー オプションを選択し、設定するタスクを選択します。その後、設定は tasks.json ファイルにコピーされ、編集に利用できます。

トップに戻る

第2章 Che-Theia IDE の基本