본문 바로가기
WIKI 기술 지식 베이스

새 플러그인 스캐폴드하기

원문 보기 위키 갱신

Backstage 저장소의 루트 디렉터리에서 명령을 실행하고 backend-plugin을 선택하면 새롭고 가장 기본적인(바레본) 백엔드 플러그인 패키지를 만들 수 있어요. 이 글에서는 스캐폴딩 과정과 생성되는 구조를 설명드릴게요.

출처: 문서

본문

yarn new

Backstage 저장소의 루트 디렉터리에서 다음 명령을 실행하고 backend-plugin을 선택하면 새롭고 가장 기본적인 백엔드 플러그인 패키지를 만들 수 있어요:

yarn new

플러그인의 이름을 입력하라는 메시지가 나올 거예요. 이것은 NPM 패키지 이름의 일부가 될 식별자이므로 짧게 만들고, 대시로 구분된 소문자로만 구성해야 해요. 우리 예시에서는 todo를 입력해야 해요. 앞으로 쓸 플러그인의 경우, 이 플러그인이 무엇을 하는지 기억하기 쉬운 표시여야 해요. 예를 들어 Carmen이라는 시스템과의 통합을 추가하는 패키지라면 carmen이라고 이름을 짓고 싶을 거예요.

이것은 다른 플래그와 루트 package.json의 new 명령 설정에 따라 @internal/plugin-carmen-backend 같은 패키지 이름을 가진 새 NPM 패키지를 만들어요. 참고로 추가 플래그와 구성도 지원해요. CLI 문서에서 더 자세히 알아보세요.

플러그인을 만드는 데는 시간이 조금 걸리니 인내심을 가지세요. 문제 없이 실행되면 초기 설치 및 빌드 명령을 실행해서 패키지를 바로 해킹할 준비가 되게 해요!

명령이 완료되면 아래 트리 같은 내용을 가진 새 폴더 plugins/todo-backend를 볼 수 있을 거예요:

/ <- your Backstage app's root directory    /plugins/        /todo-backend/            package.json            README.md            eslintrc.js            /dev/                index.ts            /src/                plugin.ts                index.ts                router.ts                /services/                    /TodoListService/                        TodoListService.ts                        types.ts                        index.ts

FAQ

더 알아보기 (Learn more)