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

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

설정#

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

VS Code를 사용하는 경우 ESLint VS Code 확장을 설치합니다. 다른 IDE의 경우 해당 ESLint 통합을 참고하세요.

사용법#

커뮤니티 패키지 또는 n8n 메인 저장소에서 린터를 사용할 수 있습니다.

린팅#

커뮤니티 패키지에서는 종속성 설치 후 자동으로 실행되고 npm에 패키지를 게시하기 전에도 자동으로 실행됩니다. n8n 메인 저장소에서는 pull request에 push할 때마다 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 문서를 참고하세요.