eslint/no-warning-comments Pedantic

작동 방식

코드 내에서 TODO, FIXME, XXX와 같은 경고 주석을 허용하지 않습니다.

왜 좋지 않은가?

개발자들은 완료되지 않은 작업이나 주의가 필요한 부분을 표시하기 위해 TODO 또는 FIXME와 같은 주석을 추가하는 경우가 많습니다. 개발 과정에서는 유용할 수 있지만, 이러한 주석은 아직 완료되지 않은 코드를 나타내며, 운영 환경에 배포해서는 안 됩니다. 이 규칙은 이러한 주석이 운영 코드로 들어가기 전에 잡아낼 수 있도록 도와줍니다.

예시

이 규칙에 부적절한 코드 예시:

javascript

// TODO: 이 기능 구현해야 함
function doSomething() {}

// FIXME: 이 부분이 깨져 있음
const x = 1;

/* XXX: 임시 해결책 */
let y = 2;

이 규칙에 적절한 코드 예시:

javascript

// 이것은 일반적인 주석입니다
function doSomething() {}

// 참고: 이 부분은 무엇을 설명합니다
const x = 1;

옵션

이 규칙은 다음 기본값을 가진 옵션 객체를 갖습니다:

json

{
  "terms": ["todo", "fixme", "xxx"],
  "location": "start",
  "decoration": []
}

`terms`

매치할 단어 목록입니다. 매칭은 대소문자 구분 없이 수행됩니다.

`location`

단어를 검색할 위치:

"start" (기본값): 단어는 주석 시작 부분에 있어야 합니다(장식 이후).
"anywhere": 단어는 주석 어디에든지 나타날 수 있습니다.

`decoration`

location이 "start"일 때, 주석 시작 부분에서 무시할 문자 배열입니다.
예를 들어, JSDoc 스타일 주석에서 흔히 사용되는 * 같은 공통 주석 장식을 무시하는 데 유용합니다.

사용 방법

이 규칙을 설정 파일이나 명령줄 인터페이스를 통해 활성화하려면 다음을 사용할 수 있습니다:

설정 파일 (.oxlintrc.json)CLI

json

{
  "rules": {
    "no-warning-comments": "error"
  }
}

bash

oxlint --deny no-warning-comments

참조

규칙 소스

작동 방식 ​

왜 좋지 않은가? ​

예시 ​

옵션 ​

terms ​

location ​

decoration ​

사용 방법 ​

참조 ​