n8n-node 도구 사용#

모든 검증된 커뮤니티 node 작성자는 패키지를 생성하고 확인하기 위해 n8n-node 도구를 사용해야 합니다. 이는 n8n이 다음을 통해 품질과 일관성을 보장하는 데 도움이 됩니다:

• 예상되는 패키지 파일 구조 생성
• package.json 파일에 필요한 메타데이터 및 구성 추가
• n8n의 표준에 맞게 코드를 린트하기 쉽게 함
• 로컬 n8n 인스턴스에서 node를 로드하여 테스트 가능

Node 유형#

• node는 기존 node가 아니어야 합니다. 기존 node를 반복하는 경우 대신 pull request를 생성합니다.
• n8n은 현재 로직 또는 흐름 제어 node를 수락하지 않습니다.

패키지 소스 검증#

• npm 패키지 저장소 URL이 예상 GitHub 저장소와 일치하는지 확인합니다.
• 패키지 작성자/유지 관리자가 npm과 저장소 간에 일치하는지 확인합니다.
• npm의 git 링크가 작동하고 저장소가 공개되어 있는지 확인합니다.
• 패키지에 적절한 문서가 있는지 확인합니다(README, 사용 예시 등).
• 패키지 라이선스가 MIT인지 확인합니다.
• 패키지는 GitHub 액션에서 게시되어야 하며 provenance를 포함해야 합니다.

외부 종속성 없음#

• 패키지를 가볍고 유지 관리하기 쉽게 유지하기 위해 외부 종속성을 포함하지 않아야 합니다.

적절한 문서#

• GitHub의 README 또는 관련 API 문서에 대한 링크 등 명확한 문서를 제공합니다.
• 사용 지침, 예시 워크플로, 필요한 인증 세부 정보를 포함합니다.

환경 변수 또는 파일 시스템 접근 없음#

• 코드는 환경 변수와 상호 작용하거나 파일 읽기/쓰기를 시도하면 안 됩니다.
• node 파라미터를 통해 필요한 모든 데이터를 전달합니다.

n8n 모범 사례 따르기#

• 명확하고 일관된 코딩 스타일을 유지합니다.
• TypeScript를 사용하고 n8n의 node 개발 가이드라인을 따릅니다.
• 적절한 오류 처리와 유효성 검사를 보장합니다.
• 린터가 통과하는지 확인합니다(즉, npx @n8n/scan-community-package n8n-nodes-PACKAGE를 실행하여 통과하는지 확인합니다).

영어만 사용#

• node 인터페이스와 모든 문서는 영어로만 작성해야 합니다.
• 파라미터 이름, 설명, 도움말 텍스트, 오류 메시지 및 README 콘텐츠가 포함됩니다.