Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@lofty87/prettier-config

lofty8735MIT1.0.8

Lofty87 Project Code Convention (Prettier)

lofty87, prettier, prettier-config, convention, code-convention

readme

@lofty87/prettier-config


TypeScript 기반 React, Next, Expo 프로젝트에서 사용할 수 있는 Code Convention (Prettier) 입니다. Code Convention 을 잡고 프로젝트를 진행하게 되면, 나 또는 팀원들이 모두 일관성 있는 코드를 작성하게 되어 코드 관리가 쉽고 유지 보수에 용이하다는 장점이 있습니다. 또 코드가 통일성 있고 깔끔하게 되어 코드의 품질을 올릴 수 있습니다.

아래와 같이 프로젝트를 설정할 경우, 파일 저장만으로 자동 Prettier Formatting 이 가능해집니다.


1. Prerequisite (required)

  • VSCode Extensions
    • Prettier - Code formatter

2. Installation

# npm
npm install @lofty87/prettier-config --save-dev

# yarn
yarn add @lofty87/prettier-config --dev

3. Configuration

프로젝트 폴더(root)에 .prettierrc.json 파일을 생성하고 아래 내용을 추가합니다.

"@lofty87/prettier-config"

VSCode Preferences 의 Settings 안에 아래 내용을 추가합니다.

{
  "[javascript]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[javascriptreact]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescript]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescriptreact]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

자, 이제 파일을 저장하면 자동으로 Prettier Formatting 이 가능합니다.