RIDI Style Guide

JavaScript 코딩 스타일

Style Guide

Airbnb의 자바스크립트 스타일 가이드를 기반으로 하되, 우리 상황에 맞게 일부 규칙을 오버라이딩하여 사용하고 있다. 변경된 규칙은 이곳에서 확인할 수 있다.

ES2015+

권장되는 최소 자바스크립트 버전은 ES6(ECMAScript 2015)이다. 하위 호환이 필요한 경우에는 Babel 트랜스파일러를 통하여 지원하되, 가능한 최신(latest) 문법을 활용할 것. ES6에 대해 들어본 적이 없다면, 간략한 소개와 ES6 In Depth 시리즈 소개글을 읽어볼 것.

Linting

정적 분석기로는 ESLint를 사용한다. “왜 ESLint 인가?”에 대해서는 JSLint, JSHint(현재 grunt에서 사용), JSCS 와 비교글 참고.

npm 을 사용한다면 @ridi/eslint-config 패키지를 통해 미리 설정된 규칙을 손쉽게 사용할 수 있다.

WebStorm, PhpStorm 설정

Preference 메뉴에서 Editor > Code Style > Javascript 선택

• Tab and Indents 탭
  • Use Tab character 체크 해제
  • Indent 2

ESLint 설정하기

Languages & Frameworks > Javascript > Code Quality Tools > ESLint 선택

• Enable 체크
• ESLint 패키지 위치 지정
• (선택) .eslintrc 위치 지정

패키지 관리 (npm)

• 패키지 이름(package.json의 name 필드)은 ridi 스코프를 사용한다.
  • e.g. "name": "@ridi/my-package"
• 패키지 버전(package.json의 version 필드)은 Semantic Versioning을 따른다.
• 패키지 배포시 npm을 이용한다.
  • 현재는 공개 배포만 가능하므로 npm publish --access public 명령으로 배포한다.
  • npm에 한번 배포된 버전은 삭제되어도 같은 버전으로 재배포가 불가능하다. 따라서 배포 전 로컬 설치를 통해 정상적으로 파일들이 포함되는지 확인할 것.
• 배포 권한이 없을 경우 @ridi/performance팀에 요청하여 ridi organization에 계정을 등록한다.