NPM-csomag – Programozott API

TypeScript/JavaScript API hivatkozás @microsoft/winappcli. Minden CLI-parancs aszinkron függvényként érhető el, amely rögzíti az stdout/stderrt, és egy beírt eredményt ad vissza. Az MSIX-identitás, az Elektron hibakeresési identitás és a buildelési eszközök segéd segédprogramja is exportálva van.

Telepítés

npm install @microsoft/winappcli

Gyors kezdés

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

Gyakori típusok

Minden CLI-parancsburkoló elfogad egy beállításobjektumot, amely kiterjeszti a CommonOptions-t, és visszaadja a Promise<WinappResult>-t.

`CommonOptions`

A legtöbb parancs által megosztott alapbeállítások.

Ingatlan	Típus	Szükséges	Description
`quiet`	`boolean \\| undefined`	No	A folyamatjelző üzenetek letiltása.
`verbose`	`boolean \\| undefined`	No	Részletes kimenet engedélyezése.
`cwd`	`string \\| undefined`	No	A parancssori felületi folyamat munkakönyvtára (alapértelmezés szerint a process.cwd()).

`WinappResult`

Minden parancsburkoló által visszaadott eredmény.

Ingatlan	Típus	Szükséges	Description
`exitCode`	`number`	Igen	A folyamat kilépési kódja (mindig 0 siker esetén – nem nulla érték hibát jelez).
`stdout`	`string`	Igen	Rögzített standard kimenet.
`stderr`	`string`	Igen	Rögzített standard hiba.

Parancssori felület parancsburkolói

Ezek a függvények natív parancssori felületi winapp parancsokat csomagolnak. Minden CommonOptions-t elfogad (quiet, verbose, cwd).

`certGenerate()`

Csak helyi teszteléshez hozzon létre önaláírt tanúsítványt. A kiadónak meg kell egyeznie a jegyzékkel (automatikusan kikövetkeztetve, ha a --manifest meg van adva, vagy a Package.appxmanifest a jelenlegi munkakönyvtárban van). Kimenet: devcert.pfx (alapértelmezett jelszó: 'password'). A produkcióhoz szerezzen be tanúsítványt egy megbízható hitelesítésszolgáltatótól. A 'cert install' parancs használatával bizalomra jelölhet ezen a gépen.

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

Lehetőségek:

Ingatlan	Típus	Szükséges	Description
`exportCer`	`boolean \\| undefined`	No	.cer fájl exportálása (csak nyilvános kulcs) a .pfx mellett
`ifExists`	`IfExists \\| undefined`	No	Viselkedés a kimeneti fájl létrehozásakor: "hiba" (hiba, alapértelmezett), "kihagyás" (meglévő megőrzése) vagy "felülírás" (csere)
`install`	`boolean \\| undefined`	No	A tanúsítvány telepítése a helyi géptárolóba a létrehozás után
`json`	`boolean \\| undefined`	No	Kimenet formázása JSON-ként
`manifest`	`string \\| undefined`	No	A Package.appxmanifest vagy appxmanifest.xml fájl elérési útja a közzétevő adatainak kinyeréséhez
`output`	`string \\| undefined`	No	A létrehozott PFX-fájl kimeneti elérési útja
`password`	`string \\| undefined`	No	A létrehozott PFX-fájl jelszava
`publisher`	`string \\| undefined`	No	A létrehozott tanúsítvány kiadó neve. Ha nincs megadva, a rendszer a manifest alapján következtet.
`validDays`	`number \\| undefined`	No	A tanúsítvány érvényességi napjainak száma