모듈은 자바스크립트 프로그래밍에서 코드를 모듈화하고 재사용 가능한 단위로 구성하기 위해 사용됩니다. 모듈을 사용하면 코드를 조직화하고 유지 관리하기 쉬워지며, 다른 프로젝트에서도 모듈을 재사용할 수 있습니다. 모듈을 작성할 때, 적절한 네이밍 규칙을 따르는 것이 좋습니다.

다음은 모듈 네이밍 규칙에 대한 몇 가지 지침입니다:

1. 파일명

• 모듈 파일의 이름은 간결하고 의미 있는 이름으로 작성되어야 합니다.
• 파일의 확장자는 .js 로 지정되어야 합니다.
• 파일명은 소문자로 작성되어야 하며, 필요에 따라 단어 사이에는 언더스코어(_)를 사용할 수 있습니다.

예시:

calculator.js
string_utils.js

2. 모듈명

• 모듈의 이름은 모듈 파일의 이름과 일치해야 합니다.
• 모듈의 이름은 카멜 케이스(camelCase)로 작성되어야 합니다.
• 모듈의 이름은 해당 모듈이 제공하는 기능이나 역할을 명확하게 나타내야 합니다.

예시:

const calculator = require('./calculator');
const stringUtils = require('./string_utils');

3. 폴더 구조

• 모듈 파일은 적절한 폴더 안에 위치시켜야 합니다.
• 폴더명은 모듈의 기능이나 역할에 따라 명확하게 작성되어야 합니다.

예시:

├─ utils
│   ├─ calculator.js
│   └─ string_utils.js

4. 패키지 이름

• 패키지는 관련된 모듈을 묶어서 제공하는 단위입니다.
• 패키지의 이름은 모두 소문자로 작성되어야 하며, 필요에 따라 언더스코어(_)를 사용할 수 있습니다.
• 패키지의 이름은 해당 패키지에 포함된 모듈들과 관련된 기능이나 역할을 나타내야 합니다.

예시:

const math = require('math');
const stringUtils = require('string_utils');

적절한 모듈 네이밍 규칙을 따르면 코드를 더 쉽게 읽고 유지 관리할 수 있으며, 협업 시에도 혼란을 줄일 수 있습니다. 어떤 프로젝트를 진행하든지 모듈 네이밍 규칙은 중요한 부분이니 항상 신경써서 작성하는 것이 좋습니다.

참고 자료:

• 모듈 패턴(MDN web docs)
• 적절한 모듈 네이밍에 대한 의견(stackoverflow)