使い方：コード補完

概要¶

「Pleasanter Code Assist」のコード補完機能について説明します。

コード補完の対象¶

コード補完の対象は、以下の4つのフォルダ配下に配置された「スクリプト」または「サーバスクリプト」です。

補完される情報¶

Pleasanter Code Assistのコード補完機能で補完される情報は以下のとおりです。補完候補の表示に加え、マウスホバーによる説明表示や定義への移動が可能です。

スクリプトの場合¶

・$pのメソッド、引数、戻り値、説明、使用例
・プリザンターでよく使う一部のjQueryメソッド

サーバスクリプトの場合¶

・context、items、model、view、httpClient、$psなどのグローバルオブジェクト
・メソッドの引数、戻り値、レコードや配列の型

ユーザはPleasanter Code Assist 1.4.0以降に含まれる型定義ファイルをVisual Studio Codeのワークスペースへ適切に配置することで、Visual Studio Code標準のIntelliSense（インテリセンス）によるコード補完機能を利用できます。

スクリプトの編集時にコード補完を使用している様子¶

サーバスクリプトの編集時にコード補完を使用している様子¶

制限事項¶

1. 何らかの理由により、既存のワークスペースにjsconfig.jsonが存在する場合、型定義ファイルとJavaScriptファイルとの関連付けをユーザが手動で行う必要があります。詳細は「ワークスペースに既存のjsconfig.jsonがある場合の設定」を参照してください。
2. スクリプトのコード補完では、プリザンターのAPIが返すjQueryオブジェクトに対して、よく使うメソッドのコード補完が表示されます。主な対象はval、attr、prop、text、css、data、addClass、removeClass、show、hide、on、findなどです。これらはjQueryの完全な型定義ではありません。未定義のjQueryメソッドも実行できますが、補完候補や詳しい説明は表示されません。

操作手順¶

コード補完のセットアップ¶

Pleasanter Code Assist 1.4.0以降でワークスペースを新規作成する場合¶

Pleasanter Code Assist 1.4.0以降で「Pleasanter Code Assist：コマンドによる作業フォルダ作成」で説明されている手順を実施した場合、特別な設定は不要です。

既存のワークスペースではじめてコード補完を使用する場合¶

「Pleasanter Code Assist」の起動時、ワークスペース内にconnectionSetting、sites、extensionsのいずれかが存在し、型定義ファイルが未配置の場合、以下のメッセージが表示されます。「作成する」を選択してください。

コード補完用の型定義ファイルがワークスペースにありません。作成しますか？

ユーザが選択できる選択肢は以下の2つです。いずれも選択せずに、メッセージを閉じただけの場合、「作成する」を選択した扱いとなります。

Pleasanter Code Assistのバージョンアップ後に型定義ファイルを更新する場合¶

新しいバージョンのPleasanter Code Assistに含まれる型定義ファイルと、ワークスペースへ配置済みの型定義ファイルが一致しない場合、Visual Studio Codeの起動時に以下のメッセージが表示されます。「更新する」を選択してください。

Pleasanterの型定義が更新されています。ワークスペースの型定義ファイルを更新しますか？

ユーザが選択できる選択肢は以下の2つです。

作成されたファイルを確認する¶

型定義ファイルを作成または更新すると、選択した作業フォルダに以下のファイルが作成されます。
 

<作業フォルダ>
├─ .pleasanter
│  ├─ pleasanter-script.d.ts
│  └─ pleasanter-server-script.d.ts
├─ sites
│  ├─ scripts
│  │  └─ jsconfig.json
│  └─ serverscripts
│     └─ jsconfig.json
└─ extensions
   ├─ scripts
   │  └─ jsconfig.json
   └─ serverscripts
      └─ jsconfig.json

Pleasanter Code AssistのパラメータhideGeneratedTypeFilesをfalseに設定すると、Visual Studio Codeの「エクスプローラー」でも確認できます。

対応バージョン¶