CRA + Typescript 절대경로 설정 (w/craco)

CRA + TypeScript에서 절대경로 설정

폴더 구조가 겹겹인 경우, import 경로를 상대경로하면 코드가 너무 길어지고 보기 어렵다.

절대 경로를 사용하기 위해서는 tsconfig.json과 webpack 설정을 바꾸면 되지만, tsconfig.json에서 paths를 수정하고 yarn start를 하면 강제적으로 작성한 paths가 없어진다.

이는 CRA로 만든 프로젝트는 eject를 해서 숨겨진 webpack 설정을 바꾸어야 하는데, 그러기엔 CRA로 만든 장점이 없어지기 때문에 craco를 사용하는 것이 편하다.

Craco란?

Craco(Create React App Configuration Override)는 create-react-app(CRA)을 쉽게 설정하기 위해 만들어졌다.

CRA에서 eject를 하지 않아도, root 폴더에 craco.config.js를 추가함으로 eslint, babel, postcss 등을 쉽게 설정할 수 있다.

CRA 4.*, Yarn, NPM, Lerna, custom react-scripts에서 사용가능하다.


$ yarn add @craco/craco
$ yarn add craco-alias -D

패키지 설치 후, root 폴더에서 아래의 파일을 생성하자.

craco.config.js

const CracoAlias = require('craco-alias')

module.exports = {
  plugins: [
    {
      plugin: CracoAlias,
      options: {
        source: 'tsconfig',
        baseUrl: './src',
        tsConfigPath: './tsconfig.extend.json',
      },
    },
  ],
}

Options 설정

  • source: default 값은 options로, jsconfig, tsconfig 선택 가능
  • baseUrl: default 값은 ./로 root 폴더를 가리킴
  • aliases: alias 이름과 경로, default 값은 {}
  • tsConfigPath: 만약 sourcetsconfig이라면 해당 파일 이름 작성
  • debug: default 값은 false이며, 만약 버그가 생긴다면 해당 값을 true로 바꾸어 console로 내용 확인 가능

tsconfig.extend.json

{
  "compilerOptions": {
    "baseUrl": "./src",
    "paths": {
      // 파일
      "@app": ["./App.tsx"],

      // 폴더
      "@pages/*": ["./pages/*"],
      "@components/*": ["./components/*"],
      "@styles/*": ["./styles/*"]
    }
  }
}

“Can’t parse tsconfig.extend.json.”이라는 에러가 뜬다면, tsconfig.extend.json 마지막 줄에 콤마(,)가 있는지 확인하고 없애야 한다.

ex. "@styles/*": ["./styles/*"],이라면 마지막 ,를 삭제


그리고 tsconfig.json, package.json 파일에서 아래의 항목을 추가/수정 한다.

tsconfig.json

{
  "extends": "./tsconfig.extend.json",
  "compilerOptions": {
    //...
  }
}

package.json

"scripts": {
    "start": "craco start",
    "build": "craco build",
    "test": "craco test",
    "eject": "react-scripts eject"
  },

다 마쳤다면, 다른 곳에서 아래와 같이 import가 가능하다.

import Example from '@pages/Example'

참고


👆@김민정(howdy-mj)
안녕하세요, 공부한 것을 기록하고 공유하는 걸 좋아하는 프론트엔드 개발자 김민정입니다. 회고록, 일상 및 다른 관심사는 티스토리에 기록하고 있습니다.

GitHubTistory