npm 모듈을 많이 개발하는 사람이라면 잘 알수도 있지만 의외로 모르는 사람이 많다.

보통 사용하는건 dependencies, devDependencies 두가지 일 것이고, Peer dependency의 존재를 모르거나 왜 쓰는지 잘 모르는 사람이 많은데, 제대로 알고 사용할 수 있도록 정리해본다.

특징

dependencies

코드 실행 시 반드시 필요한 패키지의 이름과 버전을 표시한다.
- 즉, tsc/webpack/parcel 등의 transpiler/bundler를 통해 빌드되어 순수한 자바스크립트 코드를 실행할 때 필요한 패키지는 모두 dependencies에 속해야 한다.
npm install 시 표기된 패키지가 node_modules 디렉터리에 없으면 표시된 버전의 패키지를 설치한다.

코드 실행 시가 아닌 개발 또는 빌드 환경에서 필요한 패키지의 이름과 버전을 표시한다.
- typescript/webpack/eslint/prettier 등의 개발 및 빌드 환경에서만 필요한 패키지가 해당될 수 있다.
- 실질적으로 코드를 실행할 때 필요하지 않은 패키지라면 모두 devDependencies에 해당될 수 있다.
npm install 시 표기된 패키지가 node_modules 디렉터리에 없으면 표시된 버전의 패키지를 설치한다.

코드가 호환 가능한 패키지의 이름과 버전을 표시한다.
- "호환" 가능할 것으로 예상된 패키지의 버전을 표시 하는것 이므로 dependencies와 다르게 가능한 관대하게 표시하는것이 권장된다.
- 예를 들어, Semantic Version(semver)를 따르는 패키지라면 대체로 major 버전이 바뀌지 않는다면 동작이 보장되는걸 기대할 수 있으므로 ^1.0 처럼 마이너 버전까지는 모두 포함할 수 있도록 표기하는게 바람직하다. (semver 참고)
- 반대로 minor 버전만 바뀌어도 기능이나 인터페이스가 바뀔 수 있는 패키지라면 위 예시처럼 관대하게 표기하면 안된다.
npm install 시 표기된 패키지가 node_modules 디렉터리에 없더라도 아무것도 설치하지 않는다.
- 대신, peerDependencies에 있는 패키지를 node_modules 디렉터리에서 찾을 수 없다는 경고문을 표시한다. (npm v3 이후부터 해당)
- 이 경고문을 마주하면 호환되는 버전의 패키지를 직접 설치해야 한다.
코드와 함께 동작할 수 있는 프레임워크나 개발자가 패키지의 버전을 선택적으로 사용할 수 있게 해주므로 패키지를 작성할 때에는 사용하는것을 고려하는게 바람직하다.