로컬 개발 환경 반복 작업 자동화: Makefile, Justfile, npm scripts 완벽 활용 가이드

로컬 개발 환경에서 반복되는 지루한 작업을 Makefile, Justfile, npm scripts로 효율적으로 자동화하는 방법을 소개합니다. 개발 생산성을 극대화하는 실용적인 전략을 확인하세요.

로컬 개발 환경 반복 작업 자동화: Makefile, Justfile, npm scripts 완벽 활용 가이드

개발자님의 소중한 시간, 혹시 반복적이고 지루한 작업에 낭비하고 계시지는 않나요? 😩 프로젝트 빌드, 테스트 실행, 서버 시작, 데이터베이스 마이그레이션… 이런 작업들을 매번 수동으로 입력하거나 복잡한 명령어를 찾아보고 계시다면, 개발 생산성을 확 끌어올릴 기회를 놓치고 계신 겁니다!

로컬 개발 환경에서 반복되는 작업들을 자동화하는 것은 단순히 시간을 절약하는 것을 넘어, 개발 워크플로우를 표준화하고 오류를 줄이며, 무엇보다 개발자님의 정신 건강까지 지켜주는 마법 같은 일인데요. 우리는 개발자잖아요? 반복은 기계에게 맡기고, 우리는 더 창의적이고 중요한 일에 집중해야 하지 않을까요?

이 글에서는 로컬 개발 환경에서 반복 작업을 자동화하는 데 널리 사용되는 세 가지 강력한 도구, Makefile, Justfile, 그리고 npm scripts의 활용 전략을 심도 있게 다룰 겁니다. 각 도구의 특징과 장점, 그리고 실용적인 코드 예시들을 통해 개발자님의 워크플로우를 한 단계 업그레이드할 수 있는 방법을 함께 탐구해 보시죠! 💪

📑 목차

• 1. 개발자의 시간은 소중하죠! 왜 로컬 환경 자동화가 필요할까요?
• 2. Makefile, 오래된 친구의 강력함
• 2.1. 기본 문법과 활용 예시
• 2.2. 실전 Makefile 스크립트 작성 팁
• 3. Justfile, Makefile의 친근한 대안
• 3.1. Justfile의 특징과 장점
• 3.2. Makefile vs Justfile 비교
• 4. npm scripts, 프론트엔드/Node.js 개발의 만능 도구
• 4.1. package.json과 스크립트 정의
• 4.2. 고급 활용: 여러 스크립트 연결하기
• 5. 세 가지 도구, 언제 무엇을 선택할까요?
• 6. 결론: 자동화로 개발 워크플로우를 혁신하세요!

Image by KVNSBL on Pixabay

1. 개발자의 시간은 소중하죠! 왜 로컬 환경 자동화가 필요할까요?

상상해 보세요. 새로운 동료가 프로젝트에 합류했습니다. 프로젝트를 시작하기 위해 몇 시간 동안 빌드 스크립트를 찾고, 필요한 의존성을 설치하고, 서버를 실행하는 방법을 헤매고 있다면 어떨까요? 혹은 내가 맡은 프로젝트인데도, 오랜만에 다시 작업을 시작하려니 어떤 명령어를 쳐야 할지 가물가물하다면요? 😅

이런 상황은 비단 개인의 문제가 아니라 팀 전체의 생산성 저하로 이어질 수 있습니다. 로컬 개발 환경 자동화는 이런 비효율을 해결하고 다음과 같은 핵심적인 이점들을 제공합니다.

• 시간 절약 및 생산성 향상: 매번 길고 복잡한 명령어를 입력할 필요 없이, 짧고 직관적인 명령 하나로 모든 작업을 처리할 수 있습니다. 예를 들어, make build 또는 npm run test처럼요. 하루에 10분씩만 절약해도 한 달이면 꽤 많은 시간을 벌 수 있겠죠?
• 오류 감소 및 일관성 유지: 수동 작업은 오타나 순서 오류로 이어지기 쉽습니다. 자동화된 스크립트는 항상 동일한 방식으로 작업을 수행하여 휴먼 에러를 줄이고, 팀원들 간의 개발 환경을 일관되게 유지하는 데 큰 도움을 줍니다.
• 온보딩 프로세스 간소화: 신규 팀원이 프로젝트에 빠르게 적응할 수 있도록 돕습니다. "make setup 한 번이면 개발 준비 완료!" 라고 말할 수 있다면 얼마나 멋질까요?
• 문서화 및 지식 공유: 스크립트 자체가 일종의 실행 가능한 문서 역할을 합니다. 프로젝트의 빌드, 테스트, 배포 과정을 스크립트를 통해 명확하게 이해하고 공유할 수 있습니다.

결국, 반복 작업 자동화는 개발자님의 에너지를 아끼고, 중요한 문제 해결에 더 집중할 수 있도록 돕는 가장 강력한 방법 중 하나입니다. 이제 어떤 도구들을 활용할 수 있는지 자세히 살펴볼까요?

2. Makefile, 오래된 친구의 강력함

Makefile은 사실 아주 오래된 도구인데요. 1970년대에 유닉스 시스템에서 C/C++ 프로젝트를 컴파일하고 빌드하는 과정을 자동화하기 위해 탄생했습니다. 하지만 그 유연성 덕분에 프로젝트 빌드, 테스트 실행, 배포 스크립트 등 다양한 용도로 활용되며 지금까지도 많은 개발 환경에서 사랑받고 있답니다. 특히 복잡한 시스템 작업이나 여러 언어가 섞인 모노레포 환경에서 그 진가를 발휘하죠.

2.1. 기본 문법과 활용 예시

Makefile은 규칙(rule) 기반으로 작동합니다. 각 규칙은 타겟(target), 의존성(dependencies), 그리고 명령(commands)으로 구성되는데요. 기본적인 구조는 다음과 같아요.

target: dependencies
    command 1
    command 2
    ...

여기서 중요한 점은 명령(commands) 앞에는 반드시 탭(Tab) 문자가 와야 한다는 겁니다. 스페이스가 아니라 탭이에요! ⚠️ 이 부분을 실수해서 많이들 고생하시곤 하죠.

간단한 예시를 한번 볼까요? 파이썬 프로젝트에서 테스트를 실행하고, 가상 환경을 정리하는 Makefile을 만들어 봅시다.

# Makefile

.PHONY: test clean venv

venv:
    python3 -m venv .venv
    ./.venv/bin/pip install -r requirements.txt

test: venv
    ./.venv/bin/pytest

clean:
    rm -rf .venv
    find . -name "__pycache__" -exec rm -rf {} +
    echo "Cleaned up project."

help:
    @echo "Available commands:"
    @echo "  make venv     - Create and install virtual environment"
    @echo "  make test     - Run tests"
    @echo "  make clean    - Clean up project files"
    @echo "  make help     - Show this help message"

위 Makefile을 사용하면,

• make venv: 가상 환경을 만들고 필요한 패키지를 설치합니다.
• make test: 가상 환경을 먼저 만들고 테스트를 실행합니다. venv가 test의 의존성이거든요.
• make clean: 생성된 가상 환경과 파이썬 캐시 파일들을 삭제합니다.
• make help: 사용 가능한 명령 목록을 보여줍니다. @echo는 명령어를 실행하지 않고 단순히 출력만 할 때 사용합니다.

.PHONY는 실제 파일이 아닌 가상의 타겟임을 명시하여, 파일 이름과 타겟 이름이 겹쳐서 발생하는 문제를 방지하고 성능 최적화에도 도움을 줍니다. 항상 습관처럼 넣어주는 게 좋답니다.

2.2. 실전 Makefile 스크립트 작성 팁

Makefile을 더 효율적으로 사용하기 위한 몇 가지 팁을 알려드릴게요.

1. 변수 활용: 반복되는 값은 변수로 정의하면 유지보수가 쉬워집니다.

        # Makefile (변수 활용)

        PYTHON := python3
        VENV_DIR := .venv
        PIP := $(VENV_DIR)/bin/pip
        PYTEST := $(VENV_DIR)/bin/pytest

        .PHONY: test clean

        venv:
            $(PYTHON) -m venv $(VENV_DIR)
            $(PIP) install -r requirements.txt

        test: venv
            $(PYTEST)

        clean:
            rm -rf $(VENV_DIR)
            find . -name "__pycache__" -exec rm -rf {} +
            echo "Cleaned up project."
    

이렇게 하면 파이썬 실행 경로가 바뀌거나 가상 환경 디렉토리 이름이 변경되어도, 변수 값만 수정하면 되니 훨씬 편리하죠!

1. 기본 타겟 설정: 아무런 타겟 없이 make만 입력했을 때 실행될 기본 타겟을 설정할 수 있습니다. 보통 help나 build를 기본 타겟으로 많이 설정하죠.

        # Makefile (기본 타겟)

        .DEFAULT_GOAL := help

        help:
            @echo "Use 'make build', 'make test', etc."
    

1. 여러 명령어 연결: 백틱(`` ` ``)을 사용하여 셸 명령을 실행 결과를 변수에 담거나, 파이프라인(|)을 사용하여 여러 명령을 연결할 수도 있습니다.

Makefile은 처음에는 문법이 조금 생소하게 느껴질 수 있지만, 한번 익숙해지면 어떤 환경에서든 강력한 작업 자동화 도구로 활용할 수 있을 겁니다.

3. Justfile, Makefile의 친근한 대안

Justfile은 최근 몇 년간 개발자들 사이에서 인기를 얻고 있는 작업 러너(task runner)인데요. Makefile과 유사한 기능을 제공하지만, 더 간결하고 현대적인 문법을 가지고 있어서 사용자 친화적이라는 평가를 받습니다. 특히 Makefile의 탭 문자 이슈나 복잡한 문법에 지쳐있던 개발자들에게 좋은 대안이 될 수 있죠.

3.1. Justfile의 특징과 장점

Justfile은 Rust로 작성되었으며, just 명령어를 통해 실행됩니다. 주요 특징과 장점은 다음과 같습니다.

• 쉬운 문법: Makefile의 탭 대신 스페이스를 사용할 수 있고, 변수 정의나 함수 사용이 훨씬 직관적입니다.
• 자동 감지 및 실행: just 명령어를 실행하면 현재 디렉토리 또는 상위 디렉토리에서 justfile 또는 .justfile을 자동으로 찾아 실행합니다.
• 도움말 기능 내장: just만 입력하면 정의된 모든 레시피(recipe, Makefile의 타겟과 유사) 목록과 설명을 자동으로 보여줍니다. 이는 별도로 help 레시피를 만들지 않아도 된다는 의미입니다.
• 플랫폼 독립적: 다양한 운영체제에서 동일하게 작동하며, 셸 스크립트 실행에 최적화되어 있습니다.

Makefile 예시를 Justfile로 바꿔볼까요? justfile이라는 이름으로 파일을 생성하고 다음 내용을 넣어보세요.

# justfile

# 변수 정의 (YAML과 유사한 문법)
PYTHON := "python3"
VENV_DIR := ".venv"
PIP := "{{VENV_DIR}}/bin/pip"
PYTEST := "{{VENV_DIR}}/bin/pytest"

# 레시피 정의
venv:
    @echo "Creating virtual environment..."
    {{PYTHON}} -m venv {{VENV_DIR}}
    {{PIP}} install -r requirements.txt
    @echo "Virtual environment created and dependencies installed."

test: venv
    @echo "Running tests..."
    {{PYTEST}}

clean:
    @echo "Cleaning up project..."
    rm -rf {{VENV_DIR}}
    find . -name "__pycache__" -exec rm -rf {} +
    @echo "Project cleaned."

# 기본 레시피 (just만 입력했을 때 실행)
default:
    @just --list

Justfile은 변수를 사용할 때 중괄호 {{VAR_NAME}}를 사용하는 것이 Makefile과 다르죠. @echo는 Makefile과 동일하게 명령어를 출력하지 않고 결과만 보여줄 때 사용합니다. 이제 just test, just clean처럼 실행할 수 있습니다. just만 입력하면 default 레시피에 따라 모든 레시피 목록이 보기 좋게 출력될 겁니다.

3.2. Makefile vs Justfile 비교

두 도구 모두 강력하지만, 어떤 상황에서 어떤 도구를 선택해야 할지 고민될 수 있습니다. 다음 표를 통해 비교해 볼까요?

특징	Makefile	Justfile
탄생 시기	1970년대	2010년대 후반
주요 사용처	C/C++, 시스템 빌드, 복잡한 의존성 관리	일반적인 로컬 작업 자동화, 스크립트 실행
문법	독자적인 문법, 탭(Tab)으로 명령 구분	YAML과 유사, 스페이스 허용, 더 직관적
학습 곡선	중간 ~ 높음 (초기 탭 이슈, 복잡한 기능)	낮음 (간결하고 친숙한 문법)
내장 도움말	직접 help 타겟을 만들어야 함	just 명령 시 자동 생성
의존성 관리	파일 기반 의존성 추적에 강점	레시피 간 의존성 관리에 중점
설치	대부분의 유닉스 시스템에 기본 내장	별도 설치 필요 (Rust 기반)

Makefile은 오래된 프로젝트나 시스템 레벨의 빌드 작업에 여전히 강력한 선택지이고요. 반면, Justfile은 현대적인 프로젝트에서 간결하고 빠르게 작업 자동화를 시작하고 싶을 때 아주 좋은 대안이 될 수 있습니다. 개인적으로는 Justfile의 간결함과 자동 도움말 기능이 개발자 경험을 향상시킨다고 생각합니다.

Image by Pexels on Pixabay

4. npm scripts, 프론트엔드/Node.js 개발의 만능 도구

프론트엔드 개발자나 Node.js 백엔드 개발자라면 npm scripts가 아주 친숙하실 텐데요. package.json 파일 안에 정의된 스크립트 명령어를 통해 프로젝트의 다양한 작업을 실행할 수 있게 해주는 도구입니다. JavaScript 생태계에서는 거의 표준처럼 사용되고 있죠.

4.1. package.json과 스크립트 정의

npm scripts는 프로젝트의 루트에 있는 package.json 파일의 "scripts" 필드에 정의됩니다. 키-값 쌍으로 구성되며, 키가 스크립트 이름, 값이 실행될 셸 명령어입니다.

간단한 React 프로젝트를 예로 들어볼까요?

// package.json

{
  "name": "my-react-app",
  "version": "1.0.0",
  "description": "My awesome React app",
  "main": "index.js",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject",
    "lint": "eslint src/**/*.js",
    "format": "prettier --write src/**/*.js",
    "deploy": "npm run build && firebase deploy"
  },
  "dependencies": {
    "react": "^18.2.0",
    "react-dom": "^18.2.0"
  },
  "devDependencies": {
    "eslint": "^8.0.0",
    "prettier": "^3.0.0",
    "react-scripts": "^5.0.0"
  }
}

위 package.json에서 "scripts" 필드를 주목해 주세요. 여기에는 다음과 같은 스크립트들이 정의되어 있습니다.

• npm run start: 개발 서버를 시작합니다.
• npm run build: 프로덕션용으로 빌드합니다.
• npm run test: 테스트를 실행합니다.
• npm run lint: 코드 린트를 실행합니다.
• npm run format: 코드 포맷팅을 실행합니다.
• npm run deploy: 빌드 후 Firebase에 배포합니다.

start, build, test, eject와 같이 npm이 미리 정의해 둔 몇몇 스크립트 이름은 npm run 없이 npm start처럼 직접 실행할 수도 있습니다. 하지만 일반적으로는 npm run [스크립트 이름] 형태로 실행하는 것이 일반적입니다.

npm scripts의 가장 큰 장점 중 하나는 node_modules/.bin 경로에 있는 실행 파일들을 자동으로 찾아서 실행해 준다는 점입니다. 예를 들어, eslint나 prettier가 devDependencies에 설치되어 있다면, npm run lint나 npm run format을 실행할 때 별도로 경로를 지정해 줄 필요 없이 바로 실행됩니다. 이는 정말 편리하죠! 👍

4.2. 고급 활용: 여러 스크립트 연결하기

npm scripts는 단순히 하나의 명령어를 실행하는 것을 넘어, 여러 스크립트를 연결하여 복합적인 작업을 수행할 수 있습니다. 여기에는 주로 두 가지 방법이 사용됩니다.

1. 순차적 실행 (&&): 앞선 명령어가 성공적으로 완료되면 다음 명령어를 실행합니다.

        // package.json (순차적 실행 예시)

        "scripts": {
            "lint-and-test": "npm run lint && npm run test",
            "predeploy": "npm run build && echo 'Build successful, proceeding to deploy...'",
            "deploy": "npm run predeploy && firebase deploy --project my-app"
        }
    

npm run predeploy는 먼저 npm run build를 실행하고, 성공하면 메시지를 출력한 후 firebase deploy를 실행합니다. npm run lint && npm run test는 린트가 통과해야만 테스트를 실행하게 만들 수 있어 안정적인 워크플로우를 구축하는 데 유용합니다.

1. 병렬 실행 (&): 여러 명령어를 동시에 실행합니다.

        // package.json (병렬 실행 예시)

        "scripts": {
            "dev": "npm run start-frontend & npm run start-backend",
            "start-frontend": "webpack serve --config webpack.dev.js",
            "start-backend": "nodemon server/index.js"
        }
    

npm run dev를 실행하면 프론트엔드 개발 서버와 백엔드 개발 서버가 동시에 시작됩니다. 이는 풀스택 개발 환경에서 아주 유용하게 사용될 수 있습니다.

이 외에도 pre[스크립트 이름]과 post[스크립트 이름] 접두사를 사용하여 특정 스크립트 실행 전후에 자동으로 다른 스크립트를 실행하도록 설정할 수도 있습니다. 예를 들어, pretest 스크립트는 test 스크립트가 실행되기 전에 자동으로 실행됩니다. 이러한 기능들을 활용하면 npm scripts만으로도 복잡한 개발 워크플로우를 효율적으로 관리할 수 있습니다.

Image by geralt on Pixabay

5. 세 가지 도구, 언제 무엇을 선택할까요?

지금까지 Makefile, Justfile, npm scripts 세 가지 반복 작업 자동화 도구를 살펴보았는데요. 각각의 장단점이 명확하므로, 프로젝트의 특성과 팀의 선호도에 따라 적절한 도구를 선택하는 것이 중요합니다. 다음 표를 통해 다시 한번 비교해 보고, 어떤 상황에서 어떤 도구가 최적일지 정리해 봅시다.

특징	Makefile	Justfile	npm scripts
주요 사용 환경	C/C++, Go 등 시스템 레벨 빌드, 복잡한 모노레포, 레거시 프로젝트	어떤 언어든, 간결한 작업 자동화, 현대적인 프로젝트, Makefile 대체	JavaScript/TypeScript 기반 프로젝트 (프론트엔드, Node.js 백엔드)
문법 및 사용성	독자적 문법, 탭 강제, 학습 곡선 다소 높음	간결하고 직관적, 스페이스 허용, 내장 도움말, 학습 곡선 낮음	JSON 기반, 셸 스크립트, JS 생태계 친화적, 학습 곡선 낮음
의존성 관리	파일 기반 의존성 추적에 최적화 (재빌드 여부 판단)	레시피 간 의존성 명시 (선행 작업 정의)	스크립트 체인(&&, &), pre/post 훅 활용
설치 용이성	대부분 유닉스 시스템 기본 내장	별도 설치 필요 (cargo install just 등)	Node.js 설치 시 기본 제공 (npm)
언어 통합성	어떤 언어든 셸 명령어 실행 가능	어떤 언어든 셸 명령어 실행 가능	JavaScript/TypeScript 프로젝트에 가장 적합

선택 가이드라인:

• Makefile:
  • 복잡한 C/C++/Go 프로젝트 빌드 시스템을 관리해야 할 때.
  • 여러 언어가 섞인 모노레포 환경에서 통합된 빌드 시스템이 필요할 때.
  • 파일의 변경 여부에 따라 선택적으로 빌드해야 하는 정교한 의존성 관리가 필요할 때.
  • 레거시 프로젝트를 다루거나, 이미 Makefile이 광범위하게 사용되고 있는 환경에 익숙할 때.
• Justfile:
  • Makefile의 복잡한 문법이나 탭 이슈에 지쳤을 때.
  • 어떤 언어 기반의 프로젝트든 간결하고 직관적인 작업 자동화가 필요할 때.
  • 팀원들이 빠르게 학습하고 사용할 수 있는 쉬운 도구를 찾을 때.
  • 내장된 도움말 기능으로 프로젝트의 사용 가능한 명령을 자동으로 문서화하고 싶을 때.
• npm scripts:
  • JavaScript/TypeScript 기반의 프론트엔드(React, Vue, Angular), Node.js 백엔드 프로젝트를 개발할 때.
  • 이미 package.json을 통해 의존성 관리를 하고 있고, 추가적인 도구 설치 없이 작업을 자동화하고 싶을 때.
  • CLI 도구들이 node_modules/.bin에 설치되어 있어, 별도 경로 설정 없이 바로 실행하고 싶을 때.
  • 프리/포스트 훅 기능을 활용하여 특정 스크립트의 전후 처리를 자동화하고 싶을 때.

물론, 한 프로젝트에서 여러 도구를 함께 사용하는 것도 가능합니다. 예를 들어, 전체 시스템 빌드는 Makefile로 관리하고, 개별 서비스의 JavaScript 관련 작업은 npm scripts로 관리하는 식이죠. 중요한 것은 팀의 개발 생산성을 가장 효과적으로 높일 수 있는 방법을 찾는 것입니다.

6. 결론: 자동화로 개발 워크플로우를 혁신하세요!

개발자님의 로컬 개발 환경에서 반복되는 작업을 자동화하는 것은 단순히 '귀찮은 일'을 줄이는 것을 넘어, 개발 생산성을 극대화하고, 코드 품질을 향상시키며, 궁극적으로는 개발자님의 만족도를 높이는 핵심 전략입니다.

우리는 오늘 Makefile, Justfile, npm scripts라는 세 가지 강력한 도구를 살펴보았습니다. 각각의 도구는 고유한 장점과 활용 사례를 가지고 있으며, 프로젝트의 특성과 팀의 필요에 따라 유연하게 선택하고 조합하여 사용할 수 있다는 점을 기억해 주세요.

길고 복잡한 명령어를 외우거나 매번 찾아보는 대신, 짧고 직관적인 명령어 하나로 모든 작업을 처리하는 자동화된 워크플로우를 구축해 보세요. 분명 개발자님의 업무가 훨씬 효율적이고 즐거워질 겁니다. 🚀

이 글에서 다룬 내용이 개발자님의 로컬 환경 자동화에 큰 도움이 되었으면 좋겠습니다. 혹시 이 외에 다른 자동화 팁이나 사용하고 계신 유용한 도구가 있다면 댓글로 자유롭게 공유해 주세요! 함께 더 나은 개발 문화를 만들어나가요! 👇

📌 함께 읽으면 좋은 글

• [생산성 자동화] 터미널, 셸 스크립트, CLI 도구로 개발 워크플로우 자동화: 반복 작업 효율 극대화 전략
• [AI 머신러닝] MLflow MLOps 파이프라인 구축: 모델 실험 관리와 배포 실전 가이드
• [이슈 분석] AI 시대 개발자 윤리: 기술 발전과 책임 사이의 현명한 선택

이 글이 도움이 되셨다면 공감(♥)과 댓글로 응원해 주세요!
궁금한 점이나 다루었으면 하는 주제가 있다면 댓글로 남겨주세요.