ESLint 규칙 중 no-restricted-syntax란?

프로그래머라면 코드의 품질 유지와 버그 방지를 위해 다양한 툴을 사용합니다. 그중 ESLint는 JavaScript 코드의 일정한 문법과 스타일이 지켜지도록 도와주는 유용한 도구입니다. ESLint는 수많은 규칙을 포함하고 있으며, 그 중 no-restricted-syntax는 특정 구문 사용을 제한하는 데 초점을 맞추고 있습니다. 이 글에서는 no-restricted-syntax가 무엇이며, 이 규칙을 어떻게 효과적으로 사용할 수 있는지에 대해 알아보겠습니다.

no-restricted-syntax란?

no-restricted-syntax 규칙은 코드 내에서 특정 구문을 제한할 수 있도록 제공합니다. 이는 특정 구문이 유지보수성을 떨어뜨리거나 코드의 가독성에 좋지 않은 영향을 미칠 때 유용합니다. 예를 들어, 여러분이 팀 내에서 with 문이나 eval() 함수를 사용하지 않기로 결정했다면, no-restricted-syntax를 사용해 이를 확실히 강제할 수 있습니다.

ESLint 공식 문서에서 no-restricted-syntax의 세부 사항을 더 확인해 보세요.

왜 no-restricted-syntax가 필요한가?

코드 품질 유지

코드 리뷰에서 매번 특정 구문 사용에 관한 피드백을 제공하는 대신, no-restricted-syntax는 이를 자동으로 처리해 줍니다. 이것은 코드의 일관성을 유지하고 실수를 줄이는 데 도움을 줍니다.

보안 및 성능

일부 구문은 보안에 위험을 초래하거나 성능을 저하시킬 수 있습니다. 예를 들어, eval() 함수는 외부 입력을 실행할 수 있어 취약점을 노출시킬 수 있습니다. 따라서 팀에서 이런 부분을 원천 차단하고자 할 때 효과적입니다.

코드 가독성

복잡한 구문이나 팀 내 표준과 어긋나는 구문은 프로젝트의 전반적인 가독성을 떨어뜨릴 수 있습니다. no-restricted-syntax를 통해 이러한 구문을 명시적으로 제한하여 읽기 쉬운 코드를 유지할 수 있습니다.

no-restricted-syntax의 설정 방법

이 규칙을 사용하기 위해서는 .eslintrc 설정 파일에서 설정할 수 있습니다. 아래 예시는 no-restricted-syntax를 설정하는 예시입니다.

{
  "rules": {
    "no-restricted-syntax": [
      "error",
      "WithStatement",
      {
        "selector": "CallExpression[callee.name='eval']",
        "message": "eval 함수의 사용을 피하세요."
      }
    ]
  }
}

위 설정은 with 문과 eval() 함수의 사용을 제한합니다. 개발자가 이러한 구문을 사용하려고 시도하면 ESLint는 오류 메시지를 표시하게 됩니다.

사용 예시

제한할 구문의 선택

프로젝트의 필요에 따라 제한할 구문을 선정합니다. 다음은 다양한 구문을 제한하는 방법입니다.

WithStatement: JavaScript에서의 with 구문은 가독성을 해치고 디버깅을 어렵게 합니다.
BinaryExpression[operator='in']: in 연산자를 제한하여, 객체의 프로토타입 체인에 대한 오용을 방지합니다.
FunctionDeclaration[id.name='foo']: 특정 이름의 함수 선언을 제한할 수 있습니다.

설정 파일에 추가하기

프로젝트의 루트에 위치한 .eslintrc 파일에 추가하여 설정을 적용합니다.

{
  "rules": {
    "no-restricted-syntax": [
      "error",
      "WithStatement",
      "BinaryExpression[operator='in']"
    ]
  }
}

이 설정은 with 구문과 in 연산자의 사용을 금지합니다.

모두가 알아야 할 주의사항

책임감과 효율성 두 측면을 모두 고려해야 합니다. 지나치게 많은 구문을 제한하면 개발 속도가 느려지는 문제를 초래할 수 있습니다. 또한, 팀 전원이 동의한 규칙인지 확인하는 것이 중요합니다.

정기적인 검토 또한 필요합니다. 프로젝트 및 팀 구성원이 바뀌거나, 새로운 표준이 도입될 경우 제한 목록 역시 업데이트해야 합니다.

결론

no-restricted-syntax는 코드의 품질을 높이고, 프로젝트의 일관성을 유지하는 데 중요한 도구입니다. 이 규칙을 적절히 사용하여 코드의 유지보수성을 개선하고, 잠재적 버그를 줄일 수 있습니다. 개발팀의 니즈에 맞춰 구문 제한을 적용하고, 효율적인 코드 베이스를 구축해보세요.

적용 도구에 대해 더욱 자세히 알고 싶다면, ESLint의 no-restricted-syntax 문서를 참조하세요.

ESLint 규칙 중 no-restricted-syntax 란?