概要
拡張機能 intra-mart e Builder for Accel Platform は、intra-mart Accel Platform(iAP)の開発を VSCode 上で行うための拡張機能です。プロジェクトの作成からサーバへのデプロイ、サーバサイドスクリプトのデバッグ、テストの実行までを、VSCode の画面から実行できます。
機能ごとに 2 つの拡張機能があり、これらをまとめて導入する拡張パックが用意されています。本セクションでは次のように表記して区別します。
| 表記 | Marketplace 上の名前 | 役割 |
|---|---|---|
| e Builder(Core) | intra-mart e Builder for Accel Platform (Core) | プロジェクトの作成・管理、サーバへのデプロイ |
| e Builder(Debug) | intra-mart e Builder for Accel Platform (Debug) | スクリプトのデバッグ、テストの実行 |
| e Builder(拡張パック) | intra-mart e Builder for Accel Platform | 上の 2 つをまとめて導入する |
2 つをまとめて指すときは e Builder(拡張機能) と表記します。本セクションのページも、この 2 つの拡張機能ごとに分けて構成しています。
e Builder(拡張機能)でできること
3 つのことができます。詳しくは、それぞれの拡張機能の概要を参照してください。
- プロジェクトの作成と管理(Core) — 開発プロジェクトを作成し、資材の更新や構成の切り替え、ビルドを VSCode の画面から実行できます。ターミナルでコマンドを打つ必要はありません。
- サーバへのデプロイ(Core) — ビルドしたユーザモジュールを、共有開発サーバのステージングへ転送できます。
- デバッグとテスト(Debug) — サーバ上で動いているサーバサイドスクリプト(jssp)を指定した行で一時停止させ、変数の中身を確認しながら 1 行ずつ実行できます。テストコードを VSCode の一覧画面から実行し、カバレッジを確認することもできます。
こんなときに使います
- プロジェクトの作成や資材の更新を、コマンドを覚えずに画面から行いたい。
- ビルドした資材を共有開発サーバへ送って、すぐに動作を確認したい。
- スクリプトが期待どおり動かない原因を、ログ出力を挟まずに調べたい。
- 変数にどんな値が入っているかを、実際にサーバで動かしながら確認したい。
- テストを書いたが、実行のたびにコマンドを打つのが手間になっている。
- コードのどこがテストされていないかを把握したい。
用語
デバッグやテストの用語に馴染みがない場合は、先に 用語集 - Visual Studio Code 拡張機能の用語 をお読みください。本セクションで使う「デバッグ」「ブレークポイント」「アタッチ」「ステップ実行」「カバレッジ」などの用語をまとめています。
前提条件
すべての機能に共通して必要なものは、次のとおりです。
| 前提 | 内容 |
|---|---|
| VSCode 1.127.0 以上 | デスクトップ版のみ対応です(vscode.dev などのブラウザ版では利用できません) |
| フォルダの信頼 | 拡張機能はビルドスクリプトやテストコードを実行するため、信頼していないフォルダでは動作しません。詳細は フォルダを信頼する を参照してください |
このほかに必要なものは、使う拡張機能によって異なります。詳細は各拡張機能の概要を参照してください。
本セクションの読み進め方
まず 拡張機能のインストール を行い、そのあとは使う拡張機能のページだけを読み進めてください。
| 拡張機能 | 読む場面 |
|---|---|
| プロジェクトの作成とデプロイ (Core) | プロジェクトを作る、資材を更新する、サーバへデプロイする |
| デバッグとテスト (Debug) | スクリプトを一時停止させて調べる、テストを実行する |
デバッグを行わない場合、デバッグとテスト (Debug) のページ(サーバ側の準備を含む)はすべて不要です。
本セクションでは、拡張機能の画面に表示される文言を日本語で記載しています。拡張機能のメッセージは VSCode の表示言語に合わせて切り替わるため、英語表示のままでも動作しますが、本文と画面の文言が一致しません。
日本語にするには、コマンドパレットから Configure Display Language を実行します。
うまくいかないとき
拡張機能の実行ログとエラーの詳細は、VSCode の「出力」パネルに記録されます。画面のメッセージだけでは原因が分からないときは、こちらを確認してください。
- メニューから
表示 → 出力を選択します。 - 右上のドロップダウンから、確認したい拡張機能を選択します。
| ドロップダウンの項目 | 記録される内容 |
|---|---|
| e Builder (Core) | プロジェクトの作成・更新・デプロイ・ビルドの実行ログ |
| e Builder (Debug) | デバッグ・テストの実行ログ |
仕様として決まっている動作は 制限事項 にまとめています。