하나의 프로젝트에서 작업자마다 각자 다른 코딩 스타일을 가지고 있고, 그것이 코드에 드러난다면 이 프로젝트를 제 3자가 읽기도 어려워지며, 팀원들끼리도 다른 팀원들이 작성한 코드를 읽고 이해하기가 힘들어진다. 이런 요소들은 결국 생산성 저하를 유발하게 되므로 이를 방지하기 위해서 팀으로 작업을 할 때는 여러 작업자들의 코딩 스타일을 일치시키기 위한 Lintter
와 Code Formatter
를 사용하는 것이 좋다. 이러한 도구들을 사용하게 되면 어떤 형태의 문법을 지향하고 지양할지, 포맷팅은 쌍따옴표를 사용할지, 홑따옴표를 사용할지, 혹은 몇 자마다 줄바꿈을 할지, 문장의 끝에 세미콜론을 사용할지 등의 여부를 고민하지 않고 코드 작성 자체에 집중할 수 있도록 도와준다.
자바스크립트에서는 Linter로 ESLint를, Code Formatter로는 Prettier를 사용하는것이 일반적이다. 앞서 설명한 ESLint는 코드 자체의 문법 교정과 더불어 코드 스타일링 기능도 포함하고 있다. 그러나 Prettier는 자동으로 코드의 스타일을 맞춰주는 보다 강력한 기능을 지원하고 있기 때문에 빈번히 ESLint와 함께 사용되고 있다. 때문에 일반적으로 Lintting 기능은 ESLint에, Code Formatting은 Prettier에 일임하는 방식으로 사용한다.
코딩스타일은 팀에서 정할 수 있다. 다만 이를 개인에게 위임해서 개인이 의식적으로 지키는 것은 쉽지 않고 강제성이 없기에 취약하다. 또한 코딩 스타일 관련된 논쟁이 이어지다보면 상호 코드를 읽고, 리뷰하고, 작성하는데에도 많은 에너지가 소모된다. 이러한 불필요한 에너지 소모를 줄이기 위해서 코딩 스타일 자동화 툴이 필요하다. 따라서 자동화 될 수 없는 컨벤션은 최소화 하는것이 좋고 필요한 경우에는 반드시 문서화 시켜서 논의할 때 문서를 기준으로 의견을 주고받고 수정이 필요한 경우에는 논의결과가 문서에 반영되어야 한다. 이런 자동화 툴들은 아무것도 없이 시작하는 것 보다 초기세팅은 다소 복잡할 수 있지만, 한번 해두면 추후에 적용하기도 쉽고, 무엇보다 초기에 세팅해둔 것이 지속적인 개발 생산성 향상에 도움을 준다.
ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code, with the goal of making code more consistent and avoiding bugs.
Prettier removes all original styling and ensures that all outputted code conforms to a consistent style.
npm install eslint --save-dev
npm install prettier --save-dev
npm install eslint-config-prettier --save-dev
위와 같이 패키지들을 설치하면 이제 eslint와 prettier를 사용할 수 있지만, 아직 완벽하지 않다. 패키지는 사용할 수 있지만 아직 팀원들간의 일관적인 규칙을 적용하지는 않은 상태이므로 팀에 맞게 커스터마이징해서 사용하며, 팀원들간 항상 똑같은 설정을 사용하는 것이 보장되어 있어야 하기에 eslint와 prettier는 프로젝트내에 설정파일을 이용해서 설정을 공유하고 적용하는 방법을 제공해주고 있다.
//.eslintrc
{
"extends": ["react-app", "eslint:recommended"],
"rules": {
"no-var": "error", // var 금지
"no-multiple-empty-lines": "error", // 여러 줄 공백 금지
"no-console": ["error", { "allow": ["warn", "error", "info"] }], // console.log() 금지
"eqeqeq": "error", // 일치 연산자 사용 필수
"dot-notation": "error", // 가능하다면 dot notation 사용
"no-unused-vars": "error" // 사용하지 않는 변수 금지
}
}
.prettierrc.확장자
파일을 통해서 설정할 수 있다. 설정파일의 확장자 형식은 JSON, YAML, JS, TOML 등 다양하게 지원하고 있으며, prettier 설정은 포맷팅에만 관련되어 있어서 비교적 설정 룰이 간단한 편이다.// .prettierrc.js
module.exports = {
printWidth: 100, // printWidth default 80 => 100 으로 변경
singleQuote: true, // "" => ''
arrowParens: "avoid", // arrow function parameter가 하나일 경우 괄호 생략
};
eslint와 prettier를 도입한다고 끝이 아니다. 아무리 패키지를 설치하고, 룰을 설정해도 작업자가 사용을 안하면 효과가 없기 때문이다. 하지만 개인이 매번 확인해서 실행하는 것은 실수가 발생할 여지가 있으며 강제성 또한 없다.
이런 문제를 해결하려면 자동화를 통해서 신경쓰지 않아도 자동으로 적용이 되게하고 특정 상황에서 강제로 적용이 되게 해야한다. commit된 코드는 무조건 formatting이 완료되어야 하고, push된 코드는 무조건 eslint가 pass된 상태에서 push가 되도록 자동화를 구축해야 하는데, 그래서 도입된게 git hook
이다.
git hook?
- git에서 특정 이벤트 발생하기 전,후로 특정 hook 동작을 실행할 수 있게 하는것 (ex. commit, push)
- 하지만 git hook 설정은 까다롭고, 모든 팀원들이 사전에 repo를 클론받고 메뉴얼하게 사전 과정을 수행해야지만 hook의 실행을 보장할 수 있다.
- 실수로라도 사전 과정을 시행하지 않는다면 hook이 실행되지 않는다.
- 해결법은? → husky
husky는 git hook사용을 도와주는 라이브러리다.
가끔씩 ESLint와 Prettier가 확인하지 않은, 오류가 있거나 읽기 어려운 코드가 Git에 공유되는 경우가 있다. Husky를 이용하면 Git에 특정 이벤트(add, commit, push 등)가 일어나기 전 자동으로 ESLint와 Prettier가 작동되어 이런 경우를 사전에 방지할 수 있게 해준다.
설치 : npm install husky --save-dev
실행 : npx husky install
//package.json
"scripts": {
...
"postinstall": "husky install",
..
}