Balíček NPM – programové rozhraní API

Referenční informace k TypeScriptu/Rozhraní JavaScript API pro @microsoft/winappcli. Každý příkaz rozhraní příkazového řádku je k dispozici jako asynchronní funkce, která zachycuje stdout/stderr a vrací zadaný výsledek. Exportují se také pomocné nástroje pro identitu MSIX, identitu ladění Electronu a nástroje sestavení.

Instalace

npm install @microsoft/winappcli

Rychlý start

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' });

Běžné typy

Každý obal příkazů CLI přijímá objekt možností, který rozšiřuje CommonOptions a vrací Promise<WinappResult>.

`CommonOptions`

Základní možnosti sdílené většinou příkazů

Vlastnictví	Typ	Povinné	Description
`quiet`	`boolean \\| undefined`	Ne	Potlačit zprávy o průběhu
`verbose`	`boolean \\| undefined`	Ne	Povolte podrobný výstup.
`cwd`	`string \\| undefined`	Ne	Pracovní adresář pro proces rozhraní příkazového řádku (výchozí hodnota je process.cwd()).

`WinappResult`

Výsledek vrácený každým obalem příkazu

Vlastnictví	Typ	Povinné	Description
`exitCode`	`number`	Ano	Ukončovací kód procesu (vždy 0 při úspěchu – nenulové vyvolání).
`stdout`	`string`	Ano	Zachycený standardní výstup
`stderr`	`string`	Ano	Zachycená standardní chyba

Obaly příkazů rozhraní příkazového řádku

Tyto funkce zabalí nativní winapp příkazy rozhraní příkazového řádku. Všechny přijímají CommonOptions (quiet, verbose, cwd).

`certGenerate()`

Vytvořte samosignovaný certifikát jenom pro místní testování. Vydavatel musí odpovídat manifestu (automaticky odvozeno, pokud je uvedeno --manifest nebo pokud je Package.appxmanifest v pracovním adresáři). Výstup: devcert.pfx (výchozí heslo: "password"). V produkčním prostředí získejte certifikát od důvěryhodné certifikační autority. K důvěryhodnosti na tomto počítači použijte certifikát cert install.

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

Možnosti:

Vlastnictví	Typ	Povinné	Description
`exportCer`	`boolean \\| undefined`	Ne	Export souboru .cer (jenom veřejného klíče) vedle souboru .pfx
`ifExists`	`IfExists \\| undefined`	Ne	Chování, když výstupní soubor již existuje: "error" (chyba, selhání, výchozí nastavení), "skip" (ponechat stávající) nebo "overwrite" (přepsat)
`install`	`boolean \\| undefined`	Ne	Nainstalujte certifikát do úložiště místního počítače po vytvoření.
`json`	`boolean \\| undefined`	Ne	Formátování výstupu ve formátu JSON
`manifest`	`string \\| undefined`	Ne	Cesta k souboru Package.appxmanifest nebo appxmanifest.xml k extrahování informací o vydavateli
`output`	`string \\| undefined`	Ne	Výstupní cesta pro vygenerovaný soubor PFX
`password`	`string \\| undefined`	Ne	Heslo pro vygenerovaný soubor PFX
`publisher`	`string \\| undefined`	Ne	Název vydavatele vygenerovaného certifikátu. Pokud není zadáno, bude odvozeno z manifestu.
`validDays`	`number \\| undefined`	Ne	Počet dnů platnosti certifikátu