[DevTools] direnv로 폴더마다 다른 node 버전 적용하기 / 전역 gitignore

프로젝트마다 사용하는 Node 버전이 다르다면 nvm을 이용해서 버전을 변경할 수 있다. 하지만 매번 수동으로 노드 버전을 바꿔주는 것은 번거로운 일이다. direnv를 활용하면 프로젝트 폴더를 바꿀 때마다 노드 버전이 자동으로 바뀌도록 설정할 수 있다. direnv는 폴더별로 환경을 관리해주는 도구다.

 

설치

---

❶ direnv 설치

brew install direnv # homebrew로 direnv 설치

 

❷ direnv hook 설정(폴더 이동시 해당 폴더의 .envrc 파일 자동 실행). 

oh-my-zsh를 사용한다면 `.zshrc` 파일 `plugins` 배열에 `direnv`를 추가하면 자동으로 설정된다.

# ~/.zshrc
plugins=(... direnv)

 

oh-my-zsh를 사용하지 않는다면 아래 코드를 `.zshrc` 파일에 추가한다.

# ~/.zshrc
eval "$(direnv hook zsh)"

 

❸ shell 다시 시작

source ~/.zshrc

 

설정

---

이제 폴더를 이동할 때마다 direnv hook이 현재 및 부모 폴더에 .envrc 설정 파일이 있는지 확인하고, 있다면 해당 디렉토리만을 위한 설정(.envrc 파일에 입력한 환경변수 등)을 로드한다. 디렉토리를 빠져나오면 이 설정들이 언로드된다. 이렇게 direnv를 사용하면 폴더별로 노드 버전이나 환경변수를 관리할 수 있기 때문에, 모든 환경 변수를 ~/.zshrc 파일에 몰아넣지 않아도 되는 장점이 있다.

 

.nvmrc 파일 생성

💡 .nvmrc 파일은 개별 프로젝트를 위한 설정파일로, 해당 프로젝트가 사용하는 노드 버전 명시한다.

 

❶ 프로젝트 최상위 폴더에 .nvmrc 파일 생성

touch .nvmrc

 

❷ .nvmrc 파일에 사용하고 싶은 node 버전 입력

# .nvmrc
16.13.1

 

참고로 .nvmrc 파일이 있는 폴더에서 nvm use 명령어를 실행하면, .nvmrc 파일에 입력한 노드 버전으로 교체된다(nvm use 16.13.1 명령어를 입력한 것과 동일).

nvm use
# Found... .nvmrc' with version <16.13.1>
# Now using node v16.13.1 (npm v8.1.2)

 

.envrc 파일 생성

💡 폴더를 이동할 때마다 direnv hook이 현재 및 부모 폴더에 .envrc 설정 파일이 있는지 확인하고, 있다면 해당 디렉토리만을 위한 설정을 로드한다.

 

❶ 프로젝트 최상위 폴더에 .envrc 파일 생성 (.nvmrc 파일을 생성한 동일한 경로)

touch .envrc

 

❷.envrc is blocked... 경고 문구가 나오면 direnv allow 명령어로 현재 디렉토리의 .envrc 파일 권한을 허용해준다. 권한 허용 메시지는 .envrc 파일을 수정할 때마다 나온다.

direnv allow

 

❸ .envrc 파일에 아래 내용 추가한다. 그럼 해당 프로젝트 폴더로 이동할 때마다 .nvmrc 파일에 입력한 node 버전으로 자동 변경된다.

# .envrc
NVM_DIR=$HOME/.nvm # NVM_DIR 변수에 ~/.nvm 디렉토리 지정

# 조건문 [[ -e FILE ]] -> FILE이 존재하면
# 조건문 [[ -s FILE ]] -> FILE 사이즈가 0 바이트보다 크면
if [ -s $NVM_DIR/nvm.sh ]; then
  source $NVM_DIR/nvm.sh # 스크립트 실행(서브 쉘을 생성하지 않고 현재 쉘에서 실행)
  nvm use
fi

Stack OverFlow의 다른 세팅 코드. 결과는 동일하다.

nvmrc=~/.nvm/nvm.sh
if [ -e $nvmrc ]; then
  source $nvmrc
  nvm use
fi

 

`direnv edit` 명령어로 현재 폴더의 `.envrc` 파일을 바로 수정할 수도 있다. 이때 `EDITOR` 환경 변수가 설정되어 있지 않다면 텍스트 편집기로 열린다. 다른 편집기로 열고 싶다면 `~/.zsrhc` 파일에 아래 환경 변수를 추가한다.

# ~/.zshrc
export EDITOR="code --wait" # VSCode로 편집기 설정

 

환경 변수 추가

.envrc 파일에 AWS ➊인증 정보 혹은 ➋프로필을 입력해서 해당 디렉토리만의 환경 변수로 저장할 수도 있다. 인증 정보보단 AWS 프로필을 환경 변수로 지정하는 걸 추천.

# AWS 인증 정보를 직접 입력할 때 
export AWS_ACCESS_KEY_ID=ACCOUNT_Y_ACCESS_KEY
export AWS_SECRET_ACCESS_KEY=ACCOUNT_Y_SECRET_KEY
export AWS_DEFAULT_REGION=ap-northeast-1

# AWS 프로필을 환경 변수로 지정할 때 (추천)
export AWS_PROFILE=ACCOUNT_X
export AWS_DEFAULT_REGION=ap-northeast-1

 

.envrc에 추가해둔 AWS 프로필 환경변수를 터미널에 입력해보면 아래처럼 잘 나온다.

echo $AWS_PROFILE
# ACCOUNT_X

 

PATH 추가

.envrc에 원하는 경로를 추가할 수 있다. ~/downloads 경로를 추가할 때, 원랜 아래처럼 입력해야 하지만...

# .envrc
export PATH="~/downloads:$PATH"

 

.envrc 파일에선 PATH_add 경로 만 입력하면 $PATH 변수에 자동으로 추가된다.

# .envrc
PATH_add ~/downloads

echo $PATH
# /Users/uesrname/downloads:/usr/local/opt/sqlite/bin:/Users/uesrname/...

 

전역 .gitignore 설정

.envrc에 민감한 정보가 포함될 수 있으므로 .gitignore 파일에 .envrc .direnv를 추가해둔다.

# .gitignore
.direnv
.envrc

 

하지만 프로젝트마다 매번 .gitignore 파일에 추가하는건 번거롭다. 프로젝트가 많다면 깜빡하고 추가하지 않을 수도 있다. 이땐 전역(global)으로 .gitignore를 만들어서 모든 시스템에 적용되도록 하면 된다. 그럼 매 프로젝트의 .gitignore 파일에 일일이 입력하지 않아도 된다.

# 사용자 홈 폴더에 .gitignore_global 파일 생성
touch ~/.gitignore_global

# ~/.gitignore_global 파일이 core.excludesfile이 되도록 설정 (전역 .gitignore)
git config --global core.excludesfile ~/.gitignore_global

# ~/.gitignore_global 파일에 .envrc와 .direnv 추가
echo '.envrc' >> ~/.gitignore_global # >> 연산자는 append
echo '.direnv' >> ~/.gitignore_global

 

현재 시스템에 설정된 core.excludesfile을 확인하려면 아래 커맨드를 입력한다

git config --get core.excludesfile
# /Users/username/.gitignore_global

~/.gitignore_global ▼

# 모든 시스템에 적용될 .gitignore
# 여기에 명시한 것들은 모든 프로젝트에서 ignore 됨

# direnv files
.direnv
.envrc

# editor specific files and folders
.idea
.vscode

# misc
.DS_Store
.vercel
*.pem

 

레퍼런스

---

• direnv를 사용한 디렉토리(프로젝트) 별 개발환경 구축: 루비, 파이썬, 노드 개발 환경 구축
• A dotfile that will set the default node version on a project using nvm?
• A guide to manage your environment variables in a better way using direnv  

 

---

글 수정사항은 노션 페이지에 가장 빠르게 반영됩니다. 링크를 참고해 주세요