Vue Code Style | 253eosam notes

📖 들어가기

Vue.js 프레임워크를 조금더 깔끔하고 제대로 사용하기 위해서 Vue API에서 제공하는 코드 스타일을 해석해서 기록하면 공부해볼 예정이다.

필수적으로 지켜줘야하는 것들과 매우추천, 추천, 주의 정도의 강도로 요구된다.

필수 규칙

컴포넌트 이름에 합성어 사용

Vue에서 제공되는 빌트인 컴포넌트를 제외하고 컴포넌트 이름은 항상 합성어를 사용해야한다.

모든 HTML 엘리먼트의 이름은 한 단어이기 때문에 합성어를 사용해서 충돌을 방지한다.

컴포넌트 데이터

컴포넌트의 data는 반드시 함수여야 한다.

data의 값이 오브젝트일 경우, 컴포넌트의 모든 인스턴스가 공유된다. 이말은즉슨 다른 곳에서 컴포넌트를 재사용한다면 data객체를 참조하므로 데이터가 변경된다는 뜻이다.
각 컴포넌트는 자체 data만을 관리하기를 원하기 때문에 이같은 문제가 발생하지 않기 위해서는 고유한 data 객체를 생성해야 한다.

Props 정의

Prop은 가능한 상세하게 정의되어야한다.

컴포넌트의 API를 문서화하므로 컴포넌트의 사용 방법을 쉽게 알 수 있는 장점이 있다.
Vue는 타입을 정의할 수 있는 기능이 내장되어 있는데 이를 어기면 경고 메시지를 표시하여 잠재적 오류를 막을 수 있도록 도와준다.

`v-for`에 `key` 지정

v-for는 key와 항상 함께 사용

에니메이션의 객체 불변성과 같은 예측 가능한 행동을 유지하는것
Vue는 가상 DOM 방식을 체택하고 있으며 가능한 적은 DOM을 움직여서 렌더링을 최적화하는데 key값을 설정하므로써 Vue의 움직임을 예측 가능하게 합니다.

`v-if`와 `v-for`를 동시에 사용하지말자

v-for가 사용된 엘리먼트에 절대 v-if를 사용하지 말자.

Bad

리스트 목록을 필터링하기 위해서 아래와 같은 방법을 사용한다.

<div v-for="user in users" v-if="user.isActive"></div>

이 경우 computed 속성을 사용해서 필터링된 목록으로 대체해서 사용해야한다.

리스트의 내용을 숨기기 위해서는 아래와 같은 방법을 사용한다.

<div v-for="user in users" v-if="shouldShowUsers"></div>

이 경우 v-if를 컨테이너 엘리먼트로 옮겨 사용한다.

Good

필터링된 목록은 변경 사항이 있는 경우에만 계산되므로 필터링 효율성을 높일 수 있다.
v-for="user in activeUsers"를 사용하면 렌더링 중에 활성 사용자만 반복되므로 렌더링 효율성이 증가한다.
로직이 계층에서 분리되므로 유지 관리(확장성)이 쉬워진다.

컴포넌트 스타일 스코프

최상위 APP 구성 요소와 레이아웃 구성 요소의 스타일이 전역적일 수 있지만 다른 구성의 컴포넌트의 경우 범위는 항상 지정되어야 한다.

싱글 파일 컴포넌트의 경우 style영역에 scoped를 속성을 통해 해당 컴포넌트에서만 사용되도록 스타일을 지정할 수 있다.

대형 프로젝트나 다른 개발자와 함께 작업할 때 scoped 설정은 스타일의 충돌을 최소화 할 수 있다.

Private 속성 이름

플러그인, mixin 등에서 커스텀 사용자 private 프로퍼티는 항상 접두사 $_를 사용하는 것을 권장.
다른 사람의 코드와 충돌을 피하려면 named scope를 사용.

Vue 에서는 접두사로 _와 $를 사용중이기 때문에 이를 혼합한 $_를 사용하여 private 속성을 구분하는 사용할 수 있다.

var myGreatMixin = {
  // ...
  methods: {
    $_myGreatMixin_update: function () {
      // ...
    },
  },
}

// Even better!
var myGreatMixin = {
  // ...
  methods: {
    publicMethod() {
      // ...
      myPrivateFunction()
    },
  },
}

function myPrivateFunction() {
  // ...
}

export default myGreatMixin

매우 추천함 (가독성 향상을 위함)

컴포넌트 파일

컴포넌트 파일을 이용하여 파일 시스템 환경의 연결을 쉽게하고 빠르게 찾을 수 있게 한다.

Bad

Vue.component('TodoList', {
  // ...
})
Vue.component('TodoItem', {
  // ...
})

Good

components/
|- TodoList.vue
|- TodoItem.vue

싱글 파일 컴포넌트 이름 규칙 지정(casing)

싱글 파일 컴포넌트의 이름을 지정할땐 PascalCase 또는 kebab-case을 사용한다.

베이스 컴포넌트 이름

기본 컴포넌트에 컨벤션으로 prefix Base, App, V를 사용하여 구분한다. 컨벤션을 이용하여 전역 컴포넌트로 등록하여 사용가능하다.

Example

components\
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue

components\
|- AppButton.vue
|- AppTable.vue
|- AppIcon.vue

베이스 컴포넌트 전역 컴포넌트로 등록

// main.js
let requireComponent = require.context('./src/components', false, /^Base[A-Z].(vue|js|ts)$/)
requireComponent.keys().forEach(fileName => {
  let baseComponentConfig = requireComponent(fileName)
  baseComponentConfig = baseComponentConfig.default || baseComponentConfig
  let baseComponentName = baseComponentConfig.name || fileName.replace(/^.+\//, '').replace(/\.\w+$/, '')
  Vue.component(baseComponentName, baseComponentConfig)
})

싱글 인스턴스 컴포넌트 이름

인스턴스가 하나만 있어야하는 구성 요소의 접두사The로 시작한다. 하나만 있음을 나타낸다.

한페이지당 한번만 사용되는 요소
props를 허용하지 않는 요소
props를 추가해야하지만 한번만 사용되는 재사용 가능한 요소

Bad

components/
|- Heading.vue
|- MySidebar.vue

Good

components/
|- TheHeading.vue
|- TheSidebar.vue

강한 연관성을 가진 컴포넌트 이름

상위 구성 요소와 긴밀하게 연결된 하위 구성 요소는 상위 구성 요소 이름을 접두사로 포함해야한다.

예시를통해 위말을 풀어보면..
보통은 패키지 관리를 할땐 아래와 같은 방식으로 상위 구성 요소의 이름을 딴 디렉토리에 하위 구성요소를 중첩해서 사용할 것이다.

components/
|- TodoList/
  |- Item/
    |- index.vue
    |- Button.vue
  |- index.vue

components/
|- TodoList/
  |- Item/
    |- Button.vue
  |- Item.vue
|- TodoList.vue

하지만 이런 방법을 추천하지 않는다.

비슷한 이름을 가진 파일들이 많아지며, 편집기에서 신속한 파일전환이 불편하다.
중첩된 여러 하위 디렉토리는 편집기의 사이드바의 뎁스를 늘리고 검색에 불리하다는 것이다.

이러한 이유로 구셩요소의 이름에 관계를 명확하게 나타내는 방법을 추천하는데, 편집기에서는 일반적으로 파일을 알파벳 순으로 구성하므로 관련 파일도 보관하기도 편리하다.

Bad

component/
|- TodoList.vue
|- TodoItem.vue
|- TodoButton.vue

components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue

Good

components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue

components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue

사실 이 부분은 취향차이가 생길 수 있다. 사용하고 있는 IDE가 얼마나 지원하는가에 따라서 가독성이나 컴포넌트를 찾는 쉬움 정도가 다르기 때문이다. 하지만 나도 같은 이유로 불편함을 느끼던차라 추천해주는 방식을 이용해서 개발에 적용해볼까한다.

컴포넌트 이름의 단어 순서 정렬

구성요소 이름은 최상위 수준 단어로 시작하고 설명 단어로 끝내야한다.

위에서 언급했던 강한 연관성을 가진 컴포넌트 이름과 같은 이유로 추천됩니다.

Bad

components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue

Good

components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingCheckboxLaunchOnStartup.vue

셀프 클로징 컴포넌트

컨텐츠가 없는 구성 요소는 단일 파일 구성 요소, 문자열 템플릿 및 JSX에서 자체 닫아야한다. - 그러나 DOM 템플릿은 닫지 않는다.

추가적으로 html 템플릿을 사용하는 경우 PascalCase도 지원하지만 kebab-case로도 사용이 가능하다. html 태그는 대소문자 구분이 없기때문에 개인적으로는 kebab-case를 선호한다.

Good

<!-- In single-file components, string template, and JSX -->
<MyComponent />

<!-- In DOM templates -->
<my-component></my-component>

Prop 이름 규칙 지정(casing)

prop 이름은 선언 중에서 항상 camelCase를 사용해야한다. 또 HTML 템플릿 및 JSX에서는 kebab-case를 사용한다.

Good

props: {
  greetingText: String
}

<WelcomeMessage greeting-text="hi" />

다중 속성 엘리먼트

여러 속성을 가진 요소는 한줄에 하나의 속성을 가진 여러 줄로 확장되어야 한다.

Good

<img src="https://..." alt="Vue Logo" />

템플릿에서 단순한 표현식

구성 요소 템플릿에는 더 복잡한 표현식이 계산된 속성(computed) 또는 메서드(method)로 리펙터링된단순한 표현식만 포함해야한다.

단순한 계산된 속성

참고

https://kr.vuejs.org/v2/style-guide/

📖 들어가기

필수 규칙

컴포넌트 이름에 합성어 사용

컴포넌트 데이터

Props 정의

v-for에 key 지정

v-if와 v-for를 동시에 사용하지말자

Bad

Good

컴포넌트 스타일 스코프

Private 속성 이름

매우 추천함 (가독성 향상을 위함)

컴포넌트 파일

Bad

Good

싱글 파일 컴포넌트 이름 규칙 지정(casing)

베이스 컴포넌트 이름

Example

베이스 컴포넌트 전역 컴포넌트로 등록

싱글 인스턴스 컴포넌트 이름

Bad

Good

강한 연관성을 가진 컴포넌트 이름

Bad

Good

컴포넌트 이름의 단어 순서 정렬

Bad

Good

셀프 클로징 컴포넌트

Good

Prop 이름 규칙 지정(casing)

Good

다중 속성 엘리먼트

Good

템플릿에서 단순한 표현식

단순한 계산된 속성

`v-for`에 `key` 지정

`v-if`와 `v-for`를 동시에 사용하지말자