Skip to content

Coding Convention

류하준 edited this page Nov 11, 2021 · 13 revisions

✔️ Coding Convention

컴포넌트 작성 방식, 네이밍 규칙, 프로젝트 폴더와 파일 구조 등 필요한것들을 정하여 일관성 있게 개발했으면 좋겠어요!

  • ASI를 이용하지 않고 세미콜론을 필수적으로 써준다. (prettier로 관리).

  • 프로토타입 메서드를 제외하고 함수는 화살표 함수로 작성한다. 즉, 함수 컴포넌트도 화살표 함수로 정의해준다.

  • var를 쓰지 않고, const와 let을 사용한다.(단, const를 주로 쓰되 변수의 값 변경이 필요할 경우 let을 쓴다.)

  • image, svg는 kebab-case 사용하여 네이밍한다.(ex. erase-check.svg).

  • 변수명은 camelCase로 작성한다. (issueLabel).

  • .tsx 파일의 파일(폴더)명은 PascalCase를 사용한다. ex) LoginPage.tsx.

  • webpack alias를 이용해서 파일 절대 경로로 import, export 사용한다. src: @, test: # 단, 같은 컨텍스트를 가진 파일이 같은 경로에 존재 할 경우만 상대경로로 import해준다. (예를 들어 컴포넌트의 module.scss같은 스타일 파일)

  • components, container, pages를 export할때는 하나의 파일(ex. index.ts)에 모아서 export한다.

  • 만약 주석이 필요한 경우 // TODO: 해야 할 일 혹은 한 일을 날짜와 함께 적어준다(2021.03.28). 신경써서 사용하기

  • style은 module.scss를 사용한다. hash를 이용하여 관리

  • 명령적인 로직들은 함수로 추상화하여 웬만하면 선언적으로 사용하자.

  • 변수명이 길어도 좋으니 한눈에 봐도 알아볼 수 있는 최대한 명시적인 변수명을 정해준다.

  • z-index는 5단위로 사용해준다.

  • className에 값을 할당해줄때는 무조건 classNames함수를 사용해준다. (1개의 class를 할당하거나 정적인 className을 할당해줄때도)

  • Fragment는 <>/</>가 아닌 <Fragment></Fragment>로 사용해준다.

  • 함수 컴포넌트의 return값은 무조건 추론이 가능하니 생략해준다.

// Bad case
const ExerciseChoice = ({}: Props): ReactElement => {
  return <div />;
}

// Good case
const ExerciseChoice = ({}: Props) => {
  return <div />;
}
  • 이벤트 핸들러를 정의할때 handle + 메서드명로 정의한다.
const DateTypeToggleButton = ({ handleClick }: Props) => {
  return <button onClick={handleClick} />
}

const ModalButton = ({ handleClick }: Props) => {
  return <button onClick={handleClick} />
}

const Calendar = ({}: Props) => {
  const handleClickDateType = () => {};
  const handleModalOpen = () => {};

  return (
    <>
      <DateTypeToggleButton handleClick={handleClickDateType} />
      <ModalButton handleClick={handleModalOpen} />
    </>
  );
};

Clone this wiki locally