Code Convention - dnd-side-project/dnd-8th-1-frontend GitHub Wiki

변수명은 기본적으로 camelCase를 사용한다.

boolean 형을 갖는 변수는 앞에 is를 붙인다.

css는 기본적으로 kebab-case를 사용한다.

타입 이름은 type은 ~Types로 한다.

인터페이스 이름은 props type은 ~Props로 한다.

• API : 응답 ~Response, ~Request

• 예시 코드

  //댓글 조회
  export interface CommentReadResponse extends BaseResponse {
    data?: PaginationResponse<CommentProps>;
  }

  // base
  export interface BaseResponse {
    message?: string;
    status?: number;
    code?: string;
  }
  
  export interface PaginationResponse<T> {
    content: T[];
    numberOfElements: number; //content의 요소가 몇개인지
    offset: number; // 현재 페이지에서 시작하는 요소의 index 번호
    pageNumber: number; //페이지 넘버
    pageSize: number; //페이지 사이즈
    totalElements: number; // 전체 요소 수
    totalPage: number;
  }

props로 받는 className string은 styleClass로 통일한다.

• className 여러 개 사용하는 컴포넌트는 컴포넌트 + style로 통일한다.

• import Layout from ‘@components’
• export {Layout, Layout2...}

• export { default as Layout } from './Layout';
• export { default as Layout2 } from './Layout2';