PleasanterのスクリプトをTypeScriptで書きたい
概要
- PleasanterのスクリプトをTypeScriptで書きたいですよね?
- 実現するための環境設定を用意しました
- 型定義が必用だったので、型定義を作成してDefinitelyTypedにも登録しました
使い方
0.環境
Node.jsがインストールされている必要があります。
1.取得
リポジトリにひな形となるプロジェクトが格納されています。
リポジトリに格納されているテンプレートプロジェクトをダウンロードしてください。
2.必用なライブラリ取得
コンパイルに必用なライブラリをダウンロードします。
package.jsonファイルが存在するディレクトリまで移動します。
該当ディレクトリで以下コマンドを実行してください。
npm install
3.コード実装
'src/index.ts' というファイルがエントリポイントになります。
このファイルから参照されているファイルが自動的にビルド対象となります。
@typesで型定義がされているので、$pの下から各種データにアクセスすることが出来ます。
なお、型定義が間違っていたら教えてください...。
$p.apiGet({
id: 1545,
done: (data) => {
console.log(data);
// サンプルコード
$p.setMessage(
"#Message",
JSON.stringify({
Css: "alert-success",
Text: "処理が正常に終了しました。",
}as SetMessageArgumentType)
);
},
});
4.コードフォーマット
コードを整形するコマンドです。
npm run format
5.ビルド
コードをビルドするコマンドです。変更があるたびに自動でビルドが実行されます。
ビルド結果は'dist/index.js'に出力されます。
該当ファイルの内容物をスクリプトページに貼り付けてください。
このコマンドで出力されたコードは、デバッグ用のmapファイルを含んでいます。
このため、chromeデバッガーなどでコードを見ながらデバッグする事が出来ます。
npm run build
6. リリースビルド
リリース用のビルドコマンドです。コードが最適化されてビルドされます。
minifyが適用され、デバッグ用のマップファイルは含まれません。ここからデバッグするのは大変です。
npm run release
感謝
この開発環境は、Oooooomin2様のECMAScript環境をTypeScriptに変換したものです。感謝いたします。