코드 표준

노드를 빌드할 때 지켜야 할 코드 표준과 모범 사례에 대해 설명합니다.

노드를 빌드할 때 정의된 코드 표준을 따르면 코드를 더 읽기 쉽고 유지 관리하기 쉽게 만들 수 있으며, 오류를 방지하는 데 도움이 됩니다. 이 문서는 노드 빌드를 위한 좋은 코드 관행에 대한 가이드를 제공합니다. 코드 세부 사항에 중점을 둡니다. UI 표준 및 UX 가이드에 대해서는 노드 UI 디자인 을 참고하세요. 린터 사용 # n8n 노드 린터는 많은 노드 빌드 표준에 대한 자동 검사를 제공합니다. 노드를 게시하기 전에 린터의 검사를 통과하는지 확인해야 합니다. 자세한 내용은 n8n 노드 린터 문서를 참고하세요. n8n-node 도구 사용 # n8n은 노드를 빌드하고 테스트하는 데 n8n-node CLI 도구 를 사용할 것을 권장합니다. 특히 노드를 검증용으로 제출 할 계획이라면 이는 중요합니다. 이렇게 하면 노드가 올바른 구조를 가지고 커뮤니티 노드 요구 사항을 따르도록 보장됩니다. 또한 린팅 및 테스트가 간소화됩니다. TypeScript로 작성 # 모든 n8n 코드는 TypeScript입니다. TypeScript로 노드를 작성하면 개발 속도를 높이고 버그를 줄일 수 있습니다. 노드 작성을 위한 상세 가이드라인 # 이 가이드라인은 여러분이 빌드하는 모든 노드에 적용됩니다. 리소스와 작업 # 노드가 여러 작업을 수행할 수 있는 경우, 작업을 설정하는 매개변수의 이름을 Operation 으로 지정하세요. 노드가 둘 이상의 리소스에 대해 이러한 작업을 수행할 수 있는 경우 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' , // Only show these operations for Resource One displayOptions : { show : { resource : [ 'resourceOne' ] } }, options : [ { name : 'Create' , value : 'create' , description : 'Create an instance of Resource One' } ] } ] } } 내부 매개변수 이름 재사용 # n8n 노드의 모든 리소스 및 작업 필드에는 두 가지 설정이 있습니다: name 매개변수로 설정하는 표시 이름과, value 매개변수로 설정하는 내부 이름