nodejs 프로젝트용 .env 파일 문서화

원본 게시물은 내 블로그mrsauravsahu에 게시됩니다.

참고: 실제로 이 프로젝트를 빌드하고 npmjs에 배포하는 비디오 버전이 있습니다. https://youtu.be/4N1lwa6w6HA

모든 종류의 문서화는 그 당시에는 오버헤드처럼 보이지만 장기간 유지해야 하는 프로젝트, 팀이 변경될 때, 새 구성원을 온보딩할 때 및 기타 여러 가지에 대해 정말 좋은 성과를 거두었습니다.

nodejs 프로젝트의 경우 애플리케이션 구성은 일반적으로 process.env 에서 읽습니다. 이는 차례로 ENVIRONMENT 변수와 같은 위치 또는 .env 와 같은 구성 파일에서 가져옵니다. 개발 중에 이 패키지dotenv는 환경 변수를 설정하는 훌륭한 도구입니다.

문서화가 핵심

더 큰 팀이 있는 대규모 프로젝트의 경우 코드 기반이 지속적으로 변경되고 구성도 변경됩니다. 따라서 문서는 나중에 코드 기반을 사용하는 사람을 유지하는 데 중요합니다.

일반적인.env 파일은 다음과 같습니다(키=값 쌍의 모음).

# The Node environment
NODE_ENV=development

# Url to a third party service
API_SERVICE_URL=https://mrsauravsahu.tech/posts/41/file

값에 민감한 정보가 포함될 수 있으므로 이를 문서화하려면 각 키=값 쌍에서 값을 이상적으로 생략하고 이 템플릿을 소스 제어에 추가해야 합니다. 이 템플릿은 아래 예와 유사합니다.

# The Node environment
NODE_ENV=

# Url to a third party service
API_SERVICE_URL=

내가 무엇을 지었습니까?

gen-env-template 이라는 실제 .env 파일에서 이러한 템플릿.env 파일을 생성하는 npm 패키지를 만들었습니다.
이것은 개발 도구이므로 devDependency로 설치할 수 있습니다.

# Use your favorite package manager to install this. (You can use npx to run directly as well)
npm i -D gen-env-template

이제 패키지가 있으므로 사용 중인 .env 파일과 outfile 파일의 경로를 전달할 수 있습니다. 예를 들어 이것이 입력 파일인 경우 -

➜ cat .env
# The Node environment
NODE_ENV=

# Url to a third party service
API_SERVICE_URL=

이 명령으로 템플릿 파일을 생성할 수 있습니다.

➜ ./node_modules/.bin/gen-env-template .env template.env

이제 생성된 템플릿 파일을 얻습니다.

➜ cat template.env
# The Node environment
NODE_ENV=

# Url to a third party service
API_SERVICE_URL=

이제 이 template.env 파일은 모든 비밀이 생략되었으므로 소스 제어에 안전하게 커밋할 수 있습니다. 이 프로젝트에 대한 Github 저장소는 여기에서 찾을 수 있습니다 - mrsauravsahu/gen-env-template on Github