NPM パッケージ - プログラム API

@microsoft/winappcli の TypeScript/JavaScript API リファレンス。各 CLI コマンドは、stdout/stderr をキャプチャし、型指定された結果を返す非同期関数として使用できます。 MSIX ID、Electron デバッグ ID、ビルドツール用のヘルパーユーティリティもエクスポートされます。

Installation

npm install @microsoft/winappcli

簡単スタート

import { init, packageApp, certGenerate } from '@microsoft/winappcli';

// Initialize a new project with defaults
await init({ useDefaults: true });

// Generate a dev certificate
await certGenerate({ install: true });

// Package the built app
await packageApp({ inputFolder: './dist', cert: './devcert.pfx' });

共通の型

すべての CLI コマンドラッパーは、 CommonOptions を拡張する options オブジェクトを受け取り、 Promise<WinappResult>を返します。

`CommonOptions`

ほとんどのコマンドで共有される基本オプション。

財産	タイプ	必須	Description
`quiet`	`boolean \\| undefined`	いいえ	進行状況メッセージを抑制します。
`verbose`	`boolean \\| undefined`	いいえ	詳細出力を有効にします。
`cwd`	`string \\| undefined`	いいえ	CLI プロセスの作業ディレクトリ (既定値は process.cwd())。

`WinappResult`

すべてのコマンドラッパーによって返される結果。

財産	タイプ	必須	Description
`exitCode`	`number`	はい	プロセスの終了コード (成功時は常に0、非ゼロはエラーを示します)。
`stdout`	`string`	はい	キャプチャされた標準出力。
`stderr`	`string`	はい	キャプチャされた標準エラー。

CLI コマンドラッパー

これらの関数は、ネイティブ winapp CLI コマンドをラップします。すべて CommonOptions (quiet、 verbose、 cwd) を受け入れます。

`certGenerate()`

ローカルテスト専用の自己署名証明書を作成します。 Publisherマニフェストと一致する必要があります (--manifest provided または Package.appxmanifest が作業ディレクトリにある場合は自動推論されます)。出力: devcert.pfx (既定のパスワード: 'password')。運用環境では、信頼された CA から証明書を取得します。このマシンで信頼するには、'cert install' を使用します。

function certGenerate(options?: CertGenerateOptions): Promise<WinappResult>

オプション:

財産	タイプ	必須	Description
`exportCer`	`boolean \\| undefined`	いいえ	.cer ファイル (公開キーのみ) を .pfx と共にエクスポートする
`ifExists`	`IfExists \\| undefined`	いいえ	出力ファイルが存在する場合の動作: 'error' (失敗、既定値)、'skip' (既存の状態を維持)、または 'overwrite' (置換)
`install`	`boolean \\| undefined`	いいえ	生成後にローカルコンピューターストアに証明書をインストールする
`json`	`boolean \\| undefined`	いいえ	出力を JSON として書式設定する
`manifest`	`string \\| undefined`	いいえ	発行元情報を抽出する Package.appxmanifest または appxmanifest.xml ファイルへのパス
`output`	`string \\| undefined`	いいえ	生成された PFX ファイルの出力パス
`password`	`string \\| undefined`	いいえ	生成された PFX ファイルのパスワード
`publisher`	`string \\| undefined`	いいえ	生成された証明書の発行者名。指定しない場合は、マニフェストから推論されます。
`validDays`	`number \\| undefined`	いいえ	証明書が有効な日数