Snyk 코드 사용자 지정 규칙에 대한 모범 사례

사용자 지정 규칙의 명명

사용자 지정 규칙을 명명할 때 사용자 지정 규칙임과 쿼리 결과가 반영되는 방식으로 명명하는 것이 중요합니다. 또한 설명에 작성자, 최근 변경 날짜, 질문이 있는 경우 문의할 연락처가 포함되는 것이 좋습니다.

규칙은 코드입니다

사용자 지정 쿼리와 규칙은 코드이므로, 복사하여 붙여넣기, 내보내기 또는 가져오기할 수 있고 이를 어떠한 버전 관리 시스템에 저장할 수 있습니다.

규칙으로 만들기 전에 쿼리를 테스트하세요

쿼리는 실행될 때 특정 시점에서 작동하지만, 규칙은 미래의 모든 경우에 적용되어야 합니다. 미래를 대비하여 규칙을 테스트하여 외부 코드(오픈 소스 프로젝트 등)에 대해 테스트하는 것이 좋습니다. 이렇게 하면 다른 코딩 스타일이나 사용된 라이브러리에 대한 쿼리가 강화됩니다. 이는 비즈니스가 다른 비즈니스를 인수하고 코드베이스를 병합해야하는 경우 유용할 수 있습니다.

객체의 완전한 자격 이름이 구문적 설탕 속에 숨겨져 있을 때가 있습니다

자동 완성을 사용하여 쿼리에서 사용할 수 있는 객체의 이름을 찾거나 전위 및 후위를 커버하는 정규 표현식을 사용하세요(~”.*[object_name].*”).