NPM 패키지 - 프로그래밍 방식 API

@microsoft/winappcli 대한 TypeScript/JavaScript API 참조입니다. 각 CLI 명령은 stdout/stderr를 캡처하고 형식화된 결과를 반환하는 비동기 함수로 사용할 수 있습니다. MSIX ID, Electron 디버그 ID 및 빌드 도구에 대한 도우미 유틸리티도 내보내집니다.

설치

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을(를) 확장하는 옵션 객체를 받아들이고 Promise<WinappResult>을(를) 반환합니다.

`CommonOptions`

대부분의 명령에서 공유하는 기본 옵션입니다.

재산	Type	필수	Description
`quiet`	`boolean \\| undefined`	No	진행률 메시지를 표시하지 않습니다.
`verbose`	`boolean \\| undefined`	No	자세한 정보 출력을 사용하도록 설정합니다.
`cwd`	`string \\| undefined`	No	CLI 프로세스의 작업 디렉터리(기본값은 process.cwd())입니다.

`WinappResult`

각 명령 래퍼에서 반환된 결과입니다.

재산	Type	필수	Description
`exitCode`	`number`	Yes	프로세스 종료 코드(성공 시 항상 0이며, 0이 아닌 경우 예외 발생).
`stdout`	`string`	Yes	캡처된 표준 출력입니다.
`stderr`	`string`	Yes	캡처된 표준 오류입니다.

CLI 명령 포장기

이러한 함수는 네이티브 winapp CLI 명령을 래핑합니다. 모두 CommonOptions (quiet, verbose, cwd)를 허용합니다.

`certGenerate()`

로컬 테스트용으로만 자체 서명된 인증서를 만듭니다. Publisher 매니페스트와 일치해야 합니다(--manifest가 제공되었거나 Package.appxmanifest가 작업 디렉터리에 있는 경우 자동 유추됨). 출력: devcert.pfx(기본 암호: '암호'). 프로덕션의 경우 신뢰할 수 있는 CA에서 인증서를 가져옵니다. '인증서 설치'를 사용하여 이 컴퓨터를 신뢰합니다.

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

옵션:

재산	Type	필수	Description
`exportCer`	`boolean \\| undefined`	No	.pfx와 함께 .cer 파일(공개 키만 해당) 내보내기
`ifExists`	`IfExists \\| undefined`	No	출력 파일이 있을 때의 동작: 'error'(fail, default), 'skip'(기존 항목 유지) 또는 '덮어쓰기'(바꾸기)
`install`	`boolean \\| undefined`	No	생성 후 로컬 컴퓨터 저장소에 인증서 설치
`json`	`boolean \\| undefined`	No	출력을 JSON으로 서식 지정
`manifest`	`string \\| undefined`	No	게시자 정보를 추출할 Package.appxmanifest 또는 appxmanifest.xml 파일의 경로
`output`	`string \\| undefined`	No	생성된 PFX 파일의 출력 경로
`password`	`string \\| undefined`	No	생성된 PFX 파일의 암호
`publisher`	`string \\| undefined`	No	생성된 인증서의 Publisher 이름입니다. 지정하지 않으면 매니페스트에서 유추됩니다.
`validDays`	`number \\| undefined`	No	인증서가 유효한 기간(일)