when 절 컨텍스트

Visual Studio Code는 VS Code UI에서 어떤 요소가 표시되고 활성화되어 있는지에 따라 다양한 컨텍스트 키와 특정 값을 설정합니다. 이러한 컨텍스트를 사용하여 확장 프로그램 명령 및 메뉴, 뷰와 같은 UI 요소를 선택적으로 활성화 또는 비활성화할 수 있습니다.

예를 들어, VS Code는 when 절을 사용하여 명령 키 바인딩을 활성화하거나 비활성화하며, 이는 기본 키 바인딩 JSON(기본 키 바인딩 열기(JSON))에서 볼 수 있습니다.

{ "key": "f5",  "command": "workbench.action.debug.start",
                   "when": "debuggersAvailable && !inDebugMode" },

위에서 내장된 디버깅 시작 명령은 키보드 바로 가기 F5를 가지고 있으며, 이는 적절한 디버거를 사용할 수 있고(컨텍스트 키 debuggersAvailable가 true) 편집기가 디버그 모드가 아닐 때(컨텍스트 키 inDebugMode가 false)만 활성화됩니다.

조건 연산자

when 절은 컨텍스트 키(예: inDebugMode)로 구성되거나 더 미묘한 편집기 상태를 표현하기 위해 다양한 연산자를 사용할 수 있습니다.

논리 연산자

논리 연산자는 다른 논리, 등가, 비교, 일치, in/not in 연산자 또는 괄호로 묶인 표현식을 포함하는 간단한 컨텍스트 키 또는 when 절 표현식을 결합할 수 있습니다.

논리 연산자 우선순위에 대한 참고: 위의 표는 우선순위가 가장 높은 것부터 가장 낮은 것 순서로 연산자를 나열합니다. 예

등가 연산자

컨텍스트 키의 값을 특정 값과 비교하여 등가 여부를 확인할 수 있습니다. 오른쪽은 컨텍스트 키가 아닌 값으로 해석되며 컨텍스트에서 조회되지 않습니다.

참고

• 오른쪽 값이 공백을 포함하는 문자열인 경우, 단일 따옴표로 묶어야 합니다. - "resourceFilename == 'My New File.md'".
• ===는 ==와 동일한 동작을 하며, !==는 !=와 동일한 동작을 합니다.

비교 연산자

컨텍스트 키의 값을 숫자를 기준으로 비교할 수 있습니다. 연산자의 왼쪽과 오른쪽은 공백으로 구분해야 합니다. - foo < 1, foo<1이 아닙니다.

일치 연산자

(이전 이름: 키-값 쌍 일치 연산자)

when 절을 위한 일치 연산자(=~)가 있습니다. key =~ regularExpressionLiteral 표현식은 오른쪽을 정규 표현식 리터럴로 취급하여 왼쪽과 일치시킵니다. 예를 들어, 모든 Docker 파일에 대한 컨텍스트 메뉴 항목을 추가하려면 다음과 같이 사용할 수 있습니다.

   "when": "resourceFilename =~ /docker/"

참고

• =~ 연산자의 오른쪽은 JavaScript의 정규 표현식 리터럴과 동일한 규칙을 따르지만, JSON 문자열 및 정규 표현식 모두에 대한 이스케이프 규칙을 따라야 합니다. 예를 들어, file:// 부분 문자열과 일치하는 정규 표현식 리터럴은 JavaScript에서는 /file:\/\//이지만, when 절에서는 백슬래시가 JSON 문자열에서 이스케이프되어야 하고 슬래시가 정규 표현식 패턴에서 이스케이프되어야 하므로 /file:\\/\\//가 됩니다.
• !=~ 연산자는 존재하지 않지만, 일치 표현식을 부정할 수 있습니다. - !(foo =~ /baz/).

정규 표현식 플래그

정규 표현식 리터럴에 플래그를 사용할 수 있습니다. 예를 들어, resourceFilename =~ /json/i 또는 myContextKey =~ /baz/si.

지원되는 플래그: i, s, m, u.

무시되는 플래그: g, y.

'in' 및 'not in' 조건 연산자

when 절의 in 연산자는 다른 컨텍스트 키의 값 내에서 컨텍스트 키의 값을 동적으로 조회할 수 있습니다. 예를 들어, 특정 유형의 파일(또는 정적으로 알 수 없는 것)을 포함하는 폴더에 컨텍스트 메뉴 명령을 추가하려면 이제 in 연산자를 사용하여 이를 달성할 수 있습니다. not in 연산자를 사용하여 반대 조건을 확인할 수 있습니다.

먼저 명령을 지원해야 하는 폴더를 결정하고 폴더 이름을 배열에 추가합니다. 그런 다음, setContext 명령을 사용하여 배열을 컨텍스트 키로 지정합니다.

vscode.commands.executeCommand('setContext', 'ext.supportedFolders', [
  'test',
  'foo',
  'bar'
]);

// or

// Note in this case (using an object), the value doesn't matter, it is based on the existence of the key in the object
// The value must be of a simple type
vscode.commands.executeCommand('setContext', 'ext.supportedFolders', {
  test: true,
  foo: 'anything',
  bar: false
});

그런 다음 package.json에서 explorer/context 메뉴에 대한 메뉴 기여를 추가할 수 있습니다.

// Note, this assumes you have already defined a command called ext.doSpecial
"menus": {
  "explorer/context": [
    {
      "command": "ext.doSpecial",
      "when": "explorerResourceIsFolder && resourceFilename in ext.supportedFolders"
    }
  ]
}

이 예제에서는 resourceFilename(이 경우 폴더 이름)의 값을 가져와 ext.supportedFolders의 값 내에 존재 여부를 확인합니다. 존재하면 메뉴가 표시됩니다. 이 강력한 연산자를 통해 메뉴, 뷰 등 when 절을 지원하는 더 풍부한 조건부 및 동적 기여를 할 수 있습니다.

사용 가능한 컨텍스트 키

아래는 부울 true/false로 평가되는 사용 가능한 컨텍스트 키 중 일부입니다.

이 목록이 완전하지는 않으며, 키 바인딩 편집기(키 바인딩 열기)에서 검색 및 필터링하거나 기본 키 바인딩 JSON 파일(기본 키 바인딩 열기(JSON))을 검토하여 다른 when 절 컨텍스트를 찾을 수 있습니다. 또한 컨텍스트 키 검사 유틸리티를 사용하여 관심 있는 컨텍스트 키를 식별할 수 있습니다.

참고: "config." 접두사를 사용하여 부울 값으로 평가되는 모든 사용자 또는 작업 영역 설정을 여기에 사용할 수 있습니다.

표시/포커스 뷰 when 절 컨텍스트

특정 뷰가 표시되거나 포커스되었는지 확인하는 when 절을 가질 수 있습니다.

뷰 식별자

• workbench.explorer.fileView - 파일 탐색기
• workbench.explorer.openEditorsView - 열린 편집기
• outline - 개요 뷰
• timeline - 타임라인 뷰
• workbench.scm - 소스 제어
• workbench.scm.repositories - 소스 제어 리포지토리
• workbench.debug.variablesView - 변수
• workbench.debug.watchExpressionsView - 감시
• workbench.debug.callStackView - 호출 스택
• workbench.debug.loadedScriptsView - 로드된 스크립트
• workbench.debug.breakPointsView - 중단점
• workbench.debug.disassemblyView - 역어
• workbench.views.extensions.installed - 설치된 확장
• extensions.recommendedList - 추천 확장
• workbench.panel.markers.view - 문제
• workbench.panel.output - 출력
• workbench.panel.repl.view - 디버그 콘솔
• terminal - 통합 터미널
• workbench.panel.comments - 주석

표시 뷰 컨테이너 when 절 컨텍스트

특정 뷰 컨테이너가 표시되는지 확인하는 when 절을 가질 수 있습니다.

뷰 컨테이너 식별자

• workbench.view.explorer - 파일 탐색기
• workbench.view.search - 검색
• workbench.view.scm - 소스 제어
• workbench.view.debug - 실행
• workbench.view.extensions - 확장
• workbench.panel.markers - 문제
• workbench.panel.output - 출력
• workbench.panel.repl - 디버그 콘솔
• terminal - 통합 터미널
• workbench.panel.comments - 주석

특정 뷰 컨테이너에 포커스가 있을 때만 활성화되는 when 절을 원하면, activeViewlet 또는 activePanel 또는 activeAuxiliary 컨텍스트 키와 함께 sideBarFocus 또는 panelFocus 또는 auxiliaryBarFocus를 사용하십시오.

예를 들어, 아래의 when 절은 파일 탐색기에 포커스가 있을 때만 true입니다.

"sideBarFocus && activeViewlet == 'workbench.view.explorer'"

when 절에서 설정 확인

when 절에서 config. 접두사를 사용하여 설정 값에 참조할 수 있습니다. 예를 들어 config.editor.tabCompletion 또는 config.breadcrumbs.enabled.

사용자 지정 when 절 컨텍스트 추가

자신만의 VS Code 확장을 작성 중이고 when 절 컨텍스트를 사용하여 명령, 메뉴 또는 뷰를 활성화/비활성화해야 하지만 기존 키가 요구 사항을 충족하지 않는 경우, setContext 명령으로 자체 컨텍스트 키를 추가할 수 있습니다.

아래 첫 번째 예는 myExtension.showMyCommand 키를 true로 설정하며, 이는 명령 활성화 또는 when 속성과 함께 사용할 수 있습니다. 두 번째 예는 2개보다 많은 흥미로운 열린 항목 수를 확인하는 when 절과 함께 사용할 수 있는 값을 저장합니다.

vscode.commands.executeCommand('setContext', 'myExtension.showMyCommand', true);

vscode.commands.executeCommand('setContext', 'myExtension.numberOfCoolOpenThings', 4);

컨텍스트 키 검사 유틸리티

런타임에 현재 활성화된 모든 컨텍스트 키를 보려면 명령 팔레트(⇧⌘P (Windows, Linux Ctrl+Shift+P))에서 개발자: 컨텍스트 키 검사 명령을 사용할 수 있습니다. 컨텍스트 키 검사는 VS Code 개발자 도구 콘솔 탭(도움말 > 개발자 도구 토글)에 컨텍스트 키와 해당 값을 표시합니다.

개발자: 컨텍스트 키 검사를 실행하면 커서가 VS Code UI의 요소를 강조 표시하고 요소를 클릭하면 현재 컨텍스트 키와 해당 상태가 객체로 콘솔에 출력됩니다.

활성 컨텍스트 키 목록은 방대하며 설치한 확장의 사용자 지정 컨텍스트 키를 포함할 수 있습니다.

참고: 일부 컨텍스트 키는 VS Code 내부 용이며 향후 변경될 수 있습니다.