Node.js에서 cross-env 사용법

1. cross-env란 무엇인가?

cross-env는 환경 변수를 설정하는 명령어를 다양한 운영체제에서도 동일하게 사용할 수 있도록 해주는 NPM 패키지이다. 기본적으로 Unix 계열 운영체제와 Windows에서는 환경 변수를 설정하는 방식이 다르기 때문에, cross-env를 사용하면 각 운영체제에 맞춰 복잡한 설정을 하지 않고도 동일한 명령어로 환경 변수를 설정할 수 있다.

운영체제 간 환경 변수 설정의 차이점

• 환경 변수를 명령어 앞에 설정하는 방식이다.
• set 명령어를 사용하고 &&를 붙여서 환경 변수를 설정해야 한다.

Windows:

set NODE_ENV=production && node app.js

Unix 계열(Linux, macOS):

NODE_ENV=production node app.js

이런 차이 때문에 프로젝트가 다양한 운영체제에서 사용될 경우 환경 변수 설정의 불편함과 호환성 문제가 발생하게 된다. 이를 해결하기 위해 cross-env를 사용할 수 있다.

2. cross-env 설치하기

프로젝트에 cross-env를 설치하기 위해서는 다음의 명령어를 실행하면 된다.

npm install cross-env --save

이 명령어를 통해 cross-env가 의존성으로 프로젝트에 추가된다.

3. cross-env 사용법

3.1 package.json에서의 사용 예

네가 제공한 package.json 파일을 보면 여러 스크립트에 cross-env가 사용되고 있다.

"scripts": {
    "start": "cross-env NODE_ENV=production node app.js",
    "build": "cross-env NODE_ENV=production",
    "nodemon": "nodemon app.js",
    "lint": "npx eslint --ignore-pattern node_modules/ ..."
}

"build" 스크립트:

cross-env NODE_ENV=production

여기서는 빌드 시에도 환경 변수를 설정하고자 cross-env를 사용하고 있다. 이를 통해 프로덕션 환경을 명확히 설정한 후 빌드를 수행할 수 있다.

"start" 스크립트:

cross-env NODE_ENV=production node app.js

이 스크립트는 cross-env를 사용하여 NODE_ENV 환경 변수를 production으로 설정한 후, app.js 파일을 실행하는 역할을 한다. 이렇게 하면 어떤 운영체제에서도 동일한 명령어로 서버를 실행할 수 있다.

3.2. cross-env 명령어 사용 예시

예를 들어, 환경 변수로 데이터베이스 환경 설정을 지정하고 이를 서버에서 사용해야 한다고 가정하자.

• package.json의 "scripts" 섹션에서 cross-env를 사용하여 환경 변수를 설정할 수 있다.

스크립트에서 cross-env 사용

"scripts": {
    "start:dev": "cross-env NODE_ENV=development node app.js",
    "start:prod": "cross-env NODE_ENV=production node app.js"
}

config.js에서 환경 변수 사용

import dotenv from 'dotenv';
dotenv.config();

const config = {
    env: process.env.NODE_ENV,
    db: {
        host: process.env.DB_HOST,
        port: process.env.DB_PORT,
    }
};

console.log(`Running in ${config.env} mode`);

.env 파일에 설정 추가 (예시)

NODE_ENV=development
DB_HOST=localhost
DB_PORT=3306

이제 다음 명령어를 실행하면 운영체제에 상관없이 동일한 환경 변수 설정이 적용된다.

npm run start:dev

이 명령어는 NODE_ENV를 development로 설정하고, app.js를 실행하게 된다.

4. 운영체제별 특이사항

4.1 Windows vs Unix 계열

Windows에서는 환경 변수를 설정할 때 set 명령어를 사용해야 하고, **Unix 계열(Linux, macOS)**에서는 단순히 변수명과 값을 지정하면 된다. 이런 차이 때문에 운영체제별로 별도의 스크립트를 작성해야 할 경우가 발생한다.

예를 들어, NODE_ENV를 설정하는 경우:

• Unix: NODE_ENV=production node app.js
• Windows: set NODE_ENV=production && node app.js

이러한 차이를 해소하기 위해 cross-env를 사용하는 것이다. cross-env를 사용하면 다음과 같이 작성하여 모든 운영체제에서 동일하게 사용할 수 있다.

cross-env NODE_ENV=production node app.js

4.2 cross-env가 없는 경우 발생하는 문제

운영체제별 차이 때문에 cross-env가 없으면 다음과 같은 문제가 발생할 수 있다.

• 팀원 중 일부는 Windows, 일부는 macOS를 사용한다고 가정하면, 같은 명령어를 실행할 수 없기 때문에 매번 환경 변수를 다르게 설정해야 한다.
• 지속적인 통합(CI) 파이프라인에서 운영체제에 따라 스크립트를 다르게 작성해야 하는 문제가 발생할 수 있다.

cross-env는 이처럼 환경 변수를 일관되게 설정하고, 다양한 운영체제에서 동일하게 동작하도록 보장하는 역할을 한다.

5. cross-env를 사용하는 이유와 이점

5.1 운영체제 간 호환성 확보

• cross-env를 사용하면 운영체제와 무관하게 동일한 방식으로 환경 변수를 설정할 수 있다. 이는 개발 팀이 다양한 운영체제를 사용할 때 특히 유용하다.

5.2 코드 유지보수성 향상

• 운영체제에 따라 스크립트를 별도로 관리할 필요 없이 하나의 명령어로 모든 환경에서 동일하게 동작하도록 할 수 있다. 이는 코드의 가독성을 높이고, 유지보수성을 향상시킨다.

5.3 CI/CD 환경에서의 유용성

• 지속적인 통합과 배포 파이프라인에서 동일한 설정을 유지할 수 있다. 예를 들어, 빌드 환경이나 테스트 환경에서 cross-env를 사용하면, 환경 변수를 일관되게 적용할 수 있어 설정 오류를 줄일 수 있다.

6. 결론

Node.js 프로젝트에서 환경 변수 설정은 매우 중요한 부분이다. 특히 운영체제에 따라 환경 변수 설정 방식이 다르기 때문에, 이 문제를 해결하기 위해 cross-env를 사용한다. 네가 작성한 package.json에서는 cross-env를 사용하여 다양한 스크립트에서 환경 변수를 설정하고 있다. 이를 통해 운영체제 간 호환성 문제를 해결하고, 개발 프로세스를 더욱 일관되게 유지할 수 있다.