node_modules 와 package.json

 

🎯 Goals

• node_modules 한 프로젝트 내에 여러개 있으면 좋을까?
• package.json 한 프로젝트 내에 여러개 있으면 좋을까?
• 각 파일(모듈)이 패키지를 찾아가는 원리를 파악한다.

 

node_modules

이런 구조를 갖는다고 해보자.

실제 라이브러리가 설치되는 디렉토리
모듈이 경로를 명시하지 않고 패키지 이름만 덩그러니 명시하면 이 파일 내에서 불러온다.

// orchestration.ts

// [CASE I] 패키지명만 명시
import axios from 'axios';

// [CASE II] 상대경로 지정
import requestConfig from '../../config/axiosRequestConfig.json';

// (생략)

CASE I

현재 파일의 한 단계 상위디렉토리(src/node_modules) 에서 node_modules 를 찾는다. => Not found

없으면 한 단계 상위디렉토리로 더 올라간다. (typescript_test/node_modules) => Success

찾을 때 까지 재귀적으로 상위디렉토리에서 node_modules 를 찾는다.

 

 

⚠️ 파일 확장자를 생략해야한다.
ex) 'axios'

CASE II

상대경로를 지정한 경우에는 현재 파일의 위치에 맞게 rootDir 내에서 파일을 찾는다.

(rootDir 보다 상위디렉토리로 갈 경우 permission denied 된다.)

⚠️ 파일 확장자를 명시해야한다.
ex) '../../sum.js'

 

package.json

패키지 목록과 프로젝트 기본 정보 및 빌드방식 담는 파일

실제 의존성 패키지는 dependencies

개발용 패키지는 devDependencies 에 리스팅한다.

여기에 리스팅된 파일은 node_modules 에 설치되어야 한다는 뜻으로

 

# 현재 디렉토리의 package.json 에 담긴
# 모든 의존성 패키지를 설치
$ npm install

 

 

tsconfig.json

타입스크립트 컴파일러 옵션, 프로젝트 대상 파일을 명세하는 파일

 

⚠️ ts-node 로 실행할 때 다른 디렉토리 파일을 성공적으로 import 하지 못한다.

 

이 문제를 해결하기위해 tsconfig-paths 라이브러리를 사용하는 방법이 있지만

ts-node 타입스크립트 컴파일러는 매번 컴파일 / 실행하기 때문에 퍼포먼스가 저하된다는 이슈가있다.

--transpile-only  같은 옵션을 통해 커버가 가능하다해도 이도 완벽한 솔루션이 아니라 추후에 조사가 필요하다.

 

다음과 같이 tsconfig.json 을 작성해볼 수 있다.

 

 

애초에 production 제품을
ts-node 로 실행하는 것이 좋은 선택이 아니다.

📝 타입스크립트는 어디까지나 개발용이다.
실제 제품에는 트랜스파일된 .js 파일을 실행키자.

 

 

Node.js + Typescript Tip

Node.js 버전에 따라서 호환되는 ECMAScript 버전을 tsconfig.json 에 적절한 버전으로 명시해야한다.

타입스크립트는 어찌됐든 자바스크립트로 트랜스파일된 후에 실행되기 때문에

트랜스파일 대상 자바스크립트 문법 버전 (ECMAScript version) 을 설정할 수 있다.

 

tsconfig.json example

 

구버전 node.js 를 사용할 경우 최신 ECMAScript 문법을 인식하지 못하기 때문에

개발 환경에 맞는 버전 명시가 필요하다.

 

 

---

🔗 Reference

How can I make multiple projects share node_modules directory?

GitHub - dividab/tsconfig-paths: Load node modules according to tsconfig paths, in run-time or via API.

GitHub - microsoft/TypeScript: TypeScript is a superset of JavaScript that compiles to clean JavaScript output.