코딩 컨벤션

개요

이 문서는 Econo-recruit 팀의 코딩컨벤션을 작성한 문서입니다.

컴포넌트(Component)

컴포넌트 명명

• 컴포넌트 명에는 불필요한 postfix를 붙이지 않는다.

// good
const RadioButton = () => {
  // ...
}

// bad
const RadioButtonComponent = () => {
  // ...
}

컴포넌트 타입 정의

• 컴포넌트는 화살표 함수로 작성한다.
• (권장) Props Type은 가능하다면 interface 로 선언한다.
• Props Type은 Props postfix를 붙인다.
• 컴포넌트 props(parameter)에만 타입을 선언한다.

interface SomeComponentProps {
 // ...
}

const SomeComponent = ({}:SomeComponentProps) => {
 // ...
}

export default SomeComponent;

• 한 파일에 여러 개의 컴포넌트가 있다면, props type은 최상단에 모두 작성한다.

// good
interface RadioGroupProps { }
interface RadioProps { }
const RadioGroup = () => {}
const Radio = () => {}
// bad
interface RadioGroupProps { }
const RadioGroup = () => {}
interface RadioProps { }
const Radio = () => {}

훅(Hook)

• 기본적으로 Rules of Hooks를 따른다.