← Back to rules

eslint/symbol-description Pedantic

작동 방식

심볼 설명을 요구합니다.

왜 좋지 않은가?

Symbol 함수는 옵션 설명을 가질 수 있습니다.

var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);

description을 사용하면 디버깅이 더 쉬워집니다. 심볼을 로그로 출력할 때 설명이 사용됩니다:

var foo = Symbol("some description");

console.log(foo);
// 출력 - Symbol(some description)

예시

이 규칙에 대한 잘못된 코드 예시:

var foo = Symbol();

이 규칙에 대한 올바른 코드 예시:

var foo = Symbol("some description");

사용 방법

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

Config (.oxlintrc.json)

{
  "rules": {
    "symbol-description": "error"
  }
}

CLI

oxlint --deny symbol-description

참고 자료

• 규칙 소스