코드 표준

n8n node 빌드를 위한 코드 표준에 대해 알아보세요.

node를 빌드할 때 정의된 코드 표준을 따르면 코드가 더 읽기 쉽고 유지 관리 가능해지며 오류를 방지하는 데 도움이 됩니다. 이 문서는 node 빌드를 위한 좋은 코드 관행에 대한 안내를 제공합니다. 코드 세부 사항에 초점을 맞춥니다. UI 표준 및 UX 안내는 node UI 디자인 을 참고하세요. 린터 사용 # n8n node 린터는 node 빌드 표준의 많은 부분을 자동으로 확인합니다. 게시하기 전에 node가 린터 검사를 통과하는지 확인해야 합니다. 자세한 내용은 n8n node 린터 문서를 참고하세요. n8n-node 도구 사용 # n8n은 node를 빌드하고 테스트하기 위해 n8n-node CLI 도구 를 사용하는 것을 권장합니다. 특히 검증을 위해 node를 제출 할 계획이라면 중요합니다. 이것은 node가 올바른 구조를 갖추고 커뮤니티 node 요건을 따르도록 보장합니다. 또한 린팅과 테스트를 단순화합니다. TypeScript로 작성 # 모든 n8n 코드는 TypeScript입니다. TypeScript로 node를 작성하면 개발 속도를 높이고 버그를 줄일 수 있습니다. node 작성을 위한 상세 가이드라인 # 이 가이드라인은 빌드하는 모든 node에 적용됩니다. 리소스와 작업 # node가 여러 작업을 수행할 수 있는 경우, 작업을 설정하는 파라미터를 Operation 으로 부릅니다. node가 하나 이상의 리소스에서 이러한 작업을 수행할 수 있는 경우, Resource 파라미터를 만듭니다. 다음 코드 예시는 기본 리소스 및 작업 설정을 보여줍니다: export const ExampleNode implements INodeType { description : { displayName : 'Example Node' , ... properties : [ { displayName : 'Resource' , name : 'resource' , type : 'options' , options : [ { name : 'Resource One' , value : 'resourceOne' }, { name : 'Resource Two' , value : 'resourceTwo' } ], default : 'resourceOne' }, { displayName : 'Operation' , name : 'operation' , type : 'options' , // Resource One에만 이 작업들을 표시 displayOptions : { show : { resource : [ 'resourceOne' ] } }, options : [ { name : 'Create' , value : 'create' , description : 'Create an instance of Resource One' } ] } ] } } 내부 파라미터 이름 재사용 # n8n node의 모든 리소스 및 작업 필드에는 두 가지 설정이 있습니다: name 파라미터를 사용하여 설정하는 표시 이름과 value 파라미터를 사용하여 설정하는 내부 이름. 필드의 내부 이름을