제안된 API 사용

Visual Studio Code에서는 확장 API 호환성을 중요하게 생각합니다. 저희는 API 변경으로 인해 호환성이 깨지는 일을 피하기 위해 최선을 다하며, 확장 작성자는 게시된 확장 프로그램이 계속 작동할 것이라고 기대할 수 있습니다. 그러나 이는 저희에게 큰 제약을 줍니다. API를 도입하면 더 이상 쉽게 변경할 수 없습니다.

제안된 API는 저희의 문제를 해결합니다. 제안된 API는 VS Code에 구현되었지만 안정적인 API처럼 공개되지 않은 불안정한 API 세트입니다. 이 API들은 **변경될 수 있으며**, **인사이더 배포판에서만 사용할 수 있고**, **게시된 확장 프로그램에서는 사용할 수 없습니다**. 그럼에도 불구하고 확장 작성자는 로컬 개발에서 이러한 새 API를 테스트하고 VS Code 팀이 API를 반복하는 데 피드백을 제공할 수 있습니다. 결국 제안된 API는 안정적인 API로 전환되어 모든 확장 프로그램에서 사용할 수 있게 됩니다.

제안된 API 사용

로컬 확장 개발에서 제안된 API를 테스트하는 단계입니다.

인사이더 VS Code 릴리스를 사용하십시오.
package.json에 "enabledApiProposals": ["<proposalName>"]을 추가하십시오.
해당 vscode.proposed.<proposalName>.d.ts 파일을 프로젝트 소스 위치로 복사하십시오.

@vscode/dts CLI 유틸리티를 사용하면 확장 개발을 위한 최신 vscode.proposed.<proposalName>.d.ts를 빠르게 다운로드할 수 있습니다. package.json 파일에 나열된 제안에 따라 정의 파일을 다운로드합니다.

> npx @vscode/dts dev
Downloading vscode.proposed.languageStatus.d.ts
To:   /Users/Me/Code/MyExtension/vscode.proposed.languageStatus.d.ts
From: https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.languageStatus.d.ts
Read more about proposed API at: https://vscode.gisul.kr/api/advanced-topics/using-proposed-api

제안된 API를 사용하는 샘플이 있습니다: proposed-api-sample.

제안된 API 비호환성

메인 브랜치에서 vscode.proposed.<proposalName>.d.ts는 항상 vscode.d.ts와 호환됩니다. 그러나 @types/vscode를 사용하는 프로젝트에 vscode.proposed.<proposal>.d.ts를 추가하면 최신 vscode.proposed.<proposal>.d.ts가 @types/vscode의 버전과 호환되지 않을 수 있습니다.

이 문제를 해결하려면 다음 중 하나를 수행하십시오.

@types/vscode에 대한 종속성을 제거하고 npx @vscode/dts main을 사용하여 microsoft/vscode 메인 브랜치에서 vscode.d.ts를 다운로드하십시오.
@types/vscode@<version>을 사용하고 npx @vscode/dts dev <version>을 사용하여 microsoft/vscode의 이전 브랜치에서 vscode.proposed.<proposal>.d.ts를 다운로드하십시오. 그러나 API가 최신 VS Code 인사이더 버전에서 변경되었을 수 있으므로 주의하십시오.

마켓플레이스에 제안된 API를 사용하는 확장 프로그램을 게시할 수는 없지만, 확장 프로그램을 패키징하고 공유하여 동료와 확장 프로그램을 공유할 수 있습니다.

확장 프로그램을 패키징하려면 vsce package를 실행하여 확장 프로그램의 VSIX 파일을 생성할 수 있습니다. 그런 다음 이 VSIX 파일을 다른 사람과 공유하여 VS Code에 확장 프로그램을 설치할 수 있습니다.

VSIX 파일에서 확장 프로그램을 설치하려면 확장 프로그램 보기로 이동하여 **...** 줄임표 **보기 및 추가 작업** 버튼을 선택하고 **VSIX에서 설치**를 선택하십시오.

VSIX에서 설치 메뉴 항목을 선택하는 것은 아래 짧은 동영상에 표시됩니다.

Demo showing a user going into the Extensions view to find the Install from VSIX menu item

제안된 API를 사용하는 확장 프로그램의 경우, 확장 프로그램을 사용 가능하게 하려면 몇 가지 추가 단계가 필요합니다. VSIX에서 설치한 후에는 VS Code 인사이더를 명령줄에서 code-insiders . --enable-proposed-api=<YOUR-EXTENSION-ID>와 함께 종료하고 다시 시작해야 합니다. 여기서 <YOUR-EXTENSION-ID>는 확장 프로그램의 ID입니다.

제안된 API를 사용하는 확장 프로그램이 VS Code 인사이더의 모든 시작 시 항상 사용 가능하도록 설정하려면 **기본 설정: 런타임 인수 구성** 명령을 실행하여 .vscode-insiders/argv.json 파일을 편집하고 사용 가능한 확장 프로그램 목록을 설정할 수 있습니다.

{
    ...
    "enable-proposed-api": ["<YOUR-EXTENSION-ID>"]
}

12/10/2025

제안된 API 사용

제안된 API 사용

제안된 API 비호환성

제안된 API를 사용하는 확장 프로그램 공유