Coding Convention

[ryanking13]

Coding Rules

1. snake_case 사용

NodeJS 권장은 camelCase 이지만, 본 프로젝트에서는 snake_case로 작성합니다. 변수명, 함수명 모두 snake_case로 작성하여주세요.

2. 4 space for indent

인덴트는 기본 스페이스 4개입니다. \t가 삽입되지 않도록 주의하여주세요.

3. let/const for variable type

ES8 문법을 사용하기 때문에 var 대신 let과 const를 이용하여 타입을 지정하여주세요. 오브젝트, 참조형의 경우 const, 일반 변수는 let을 사용하면 됩니다.

---

eslint를 이용한 문법 검사

eslint 설치가 되어있지 않는 경우 npm install로 설치하여주세요.

설치 후, ./node_modules/.bin/eslint --init를 해주어야 합니다. 컨벤션은 google의 것을 사용합니다.

$ ./eslint --config ./.eslintrc <directory or file to check>

--fix 옵션을 붙이면 기본적인 문법 오류는 모두 수정해줍니다.

그러나 변수 타입의 경우 var를 모두 일괄적으로 let으로 고치는 듯하니 주의

---

pre-commit hook

pre-commit 파일을 구글 드라이브에서 복사하여 .git/hook/ 폴더에 복사해 넣어주세요.

넣은 이후

$ chmod +x pre-commit

로, 실행 권한을 부여해주어야 합니다.