Deprecation

지원 중지(Deprecation) 가이드

이 문서는 프로젝트의 지원 중지 처리 방식에 관해 설명합니다.

지원 중지 처리

호환되지 않는 변경 사항이 있을 때마다 공개 API에 영향을 미치지 않도록 먼저 지원 중지 처리를 하고, 다음 주 버전에서 실제 변경 사항을 적용합니다.

컴포넌트 및 속성 제거

기존 동작은 유지한 채, 우선 지원 중지 처리를 합니다. 필요하다면 다음 주 버전에서 제거할 것이라는 경고 메시지를 콘솔에 출력하세요. 그리고 다음 주 버전에서 지원을 중단하고 제거합니다.

속성의 타입 변경

기존 타입을 확장합니다. 사용하지 않는 타입은 지원 중지 처리를 합니다. 마찬가지로 필요하다면 다음 주 버전에서 기존 속성의 타입을 변경할 것이라는 경고 메시지를 콘솔에 출력하세요. 그리고 다음 주 버전에서 기존 속성의 타입을 변경합니다.

공개된 함수 및 믹스인에 대한 처리도 동일한 방식으로 진행합니다.

예시

JSDoc @deprecated 태그

/**
 * @deprecated since version 2.0.0
 * Use AlphaButton instead
 */
function Button(props) {
  /* ... */
}

경고 메시지 콘솔 출력

console.warn('
  Deprecation: `IconName` as a value for the `leftContent` property of a `Button` has been deprecated. Use the Icon of bezier-icons instead.
')