n8n 노드 린터#

n8n의 노드 린터, eslint-plugin-n8n-nodes-base는 공식 저장소 및 커뮤니티 패키지에서 n8n 노드와 자격 증명의 소스 코드를 정적으로 분석("린트")합니다. 린터는 문제를 감지하고 자동으로 수정하여 모범 사례를 따를 수 있도록 도와줍니다.

eslint-plugin-n8n-nodes-base는 노드 파일(*.node.ts), 리소스 설명 파일(*Description.ts), 자격 증명 파일(*.credentials.ts), 및 커뮤니티 패키지의 package.json에 대한 규칙 모음을 포함합니다.

설정#

n8n 노드 스타터를 사용하고 있다면: 스타터 프로젝트에서 npm install을 실행하여 모든 종속성을 설치하세요. 설치가 완료되면 린터를 사용할 수 있습니다.

VS Code를 사용하는 경우, ESLint VS Code 확장 프로그램을 설치하세요. 다른 IDE를 사용하는 경우, 해당 ESLint 통합 기능을 참조하세요.

구성 파일을 수정하지 마세요

.eslintrc.js에는 eslint-plugin-n8n-nodes-base에 대한 구성이 포함되어 있습니다. 이 파일을 수정하지 마세요.

사용법#

커뮤니티 패키지나 주요 n8n 저장소에서 린터를 사용할 수 있습니다.

린팅#

커뮤니티 패키지에서 린터는 종속성을 설치한 후 및 npm에 패키지를 게시하기 전에 자동으로 실행됩니다. 주요 n8n 저장소에서는, PR을 푸시할 때마다 GitHub Actions를 사용하여 린터가 자동으로 실행됩니다.

두 경우 모두에서, VS Code는 프로젝트 작업 중에 배경에서 린팅을 수행합니다. 감지된 문제에 마우스를 올려놓으면 린팅의 전체 설명과 추가 정보에 대한 링크를 볼 수 있습니다.

린터를 수동으로 실행할 수도 있습니다:

npm run lint를 실행하여 린팅을 수행하고 콘솔에서 감지된 문제를 확인하세요.
npm run lintfix를 실행하여 린팅을 수행하고 문제를 자동으로 수정하세요. 린터는 자동으로 수정할 수 있는 규칙 위반 사항을 수정합니다.

두 명령 모두 커뮤니티 패키지의 루트 디렉토리나 주요 저장소의 /packages/nodes-base/에서 실행할 수 있습니다.

예외#

규칙 위반을 수정하는 대신, 예외를 두어 린터가 이를 표시하지 않도록 할 수 있습니다.

VS Code에서 린트 예외를 두려면: 문제 위에 마우스를 올리고 Quick fix를 클릭(또는 macOS의 cmd+.)하고 Disable {rule} for this line을 선택하세요. 합당한 이유가 있는 줄에 대해서만 규칙을 비활성화하세요. 린터가 문제를 잘못 보고하고 있다고 생각되면, 린터 저장소에 보고하세요.

단일 파일에 린트 예외를 추가하려면 코드 주석을 추가하세요. 특히, TSLint 규칙은 VS Code에 나타나지 않을 수 있으며 코드 주석을 사용하여 끄는 작업이 필요할 수 있습니다. 더 많은 지침은 TSLint 문서를 참조하세요.