prettier-eslint는 Prettier의 강력한 코드 스타일 교정 능력과 ESLint의 정적 분석 및 자동 수정(Auto-fix) 기능을 결합한 도구입니다. 이 도구는 원본 소스 코드를 시각적으로 아름답게 만들 뿐만 아니라, 프로젝트의 코딩 컨벤션을 엄격히 준수하도록 돕습니다. 본 아티클에서는 prettier-eslint의 핵심 소스 코드를 바탕으로 내부 작동 방식과 설정 추론 과정을 심층 분석합니다.
핵심 메커니즘: 포맷팅과 린팅의 결합
prettier-eslint의 본질은 코드를 먼저 Prettier로 포맷팅한 후, 그 결과물을 ESLint의 --fix 옵션을 통해 다시 한번 정제하는 데 있습니다. 이 프로세스는 주로 src/index.ts 파일에 정의된 format 함수와 analyze 함수를 통해 수행됩니다.
format 함수는 라이브러리의 주요 진입점 역할을 하며, 사용자 옵션을 받아 최종적으로 포맷팅된 문자열을 반환합니다. 내부적으로는 analyze 함수를 호출하여 포맷팅 결과물과 함께 ESLint에서 발생한 메시지 등의 상세 데이터를 함께 처리합니다.
진입 함수 분석: format과 analyze의 상호작용
기본적인 실행 구조는 매우 직관적입니다. format 함수는 실행 결과를 래핑하는 인터페이스 역할을 합니다.
export async function format(options: FormattingOptions): Promise<string> {
const { output } = await analyze(options);
return output;
}
실질적인 비즈니스 로직은 analyze 함수에서 이루어지며, 다음과 같은 단계별 워크플로우를 가집니다.
- 전달받은 옵션의 유효성 검사 및 병합
- 대상 파일의 확장자 확인 및 적절한 Parser 선택
- Prettier 실행을 통한 1차 스타일 교정
- ESLint 실행을 통한 2차 규칙 위반 자동 수정
- 최종 결과물 및 진단 정보 반환
지능형 설정 추론 시스템
prettier-eslint가 개발자들에게 편리한 이유는 프로젝트 내의 환경 설정 파일을 스스로 찾아내고 병합하는 지능형 추론 엔진을 갖추고 있기 때문입니다. 이는 getESLintConfig와 getPrettierConfig 같은 유틸리티 함수들의 협업으로 완성됩니다.
const resolvedEslintSettings = Object.assign(
{},
inputOptions.eslintConfig,
await fetchEslintConfig(filePath, eslintPath, inputOptions.eslintConfig || {})
);
const basePrettierSettings = filePath ? { filepath: filePath } : { parser: 'typescript' };
const finalPrettierSettings = {
...basePrettierSettings,
...(await fetchPrettierConfig(filePath, prettierPath)),
...inputOptions.prettierOptions,
};
위 코드 예시와 같이, 사용자 정의 옵션이 있을 경우 이를 최우선으로 하되 프로젝트 루트에 존재하는 .eslintrc나 .prettierrc 설정을 자동으로 로드하여 병합합니다. 이를 통해 별도의 복잡한 설정 없이도 프로젝트 고유의 스타일을 유지할 수 있습니다.
다양한 언어 및 확장자 처리
현대적인 웹 개발 환경에서는 JavaScript뿐만 아니라 TypeScript, Vue, Svelte 등 다양한 파일 형식을 지원해야 합니다. prettier-eslint는 파일 확장자에 따라 적절한 파서를 동적으로 할당합니다.
const resolveParser = async (extension: string, config: any) => {
if (config.languageOptions?.parser) return;
const parserLibraryMap: Record<string, string> = {
'.ts': '@typescript-eslint/parser',
'.tsx': '@typescript-eslint/parser',
'.vue': 'vue-eslint-parser',
'.svelte': 'svelte-eslint-parser',
};
const targetParser = parserLibraryMap[extension];
if (targetParser) {
config.languageOptions.parser = await loadExternalModule(targetParser);
}
};
이러한 구조 덕분에 사용자가 명시적으로 파서를 지정하지 않아도 .vue 파일은 Vue 파서로, .ts 파일은 TypeScript 파서로 안전하게 처리됩니다.
포맷팅 파이프라인 단계
전체적인 데이터 흐름을 요약하면 다음과 같은 파이프라인을 거칩니다.
- Input Stage: 원본 코드 문자열과 파일 경로를 입력받습니다.
- Configuration Stage: 해당 경로의 상위 디렉토리를 탐색하며 린팅 및 스타일 가이드를 추론합니다.
- Prettier Stage: 공백, 세미콜론, 따옴표 등 시각적 스타일을 일차적으로 적용합니다.
- ESLint Stage: 미사용 변수 제거, 선언 순서 변경 등 로직에 근거한 코드 수정을 진행합니다.
- Output Stage: 모든 정제가 끝난 최종 코드를 반환합니다.
이때 prettierLast 옵션을 통해 실행 순서를 제어할 수 있는데, 기본값은 Prettier를 먼저 실행한 후 ESLint를 실행하는 것입니다. 이는 Prettier가 수정한 내용이 ESLint의 규칙을 어길 가능성을 최소화하기 위한 설계입니다.
내부 유틸리티 함수의 역할
복잡한 메인 로직을 뒷받침하기 위해 src/utils.ts에는 여러 헬퍼 함수들이 존재합니다. getESLint 인스턴스 생성기나 모듈을 동적으로 가져오는 importModule, 경로에서 확장자를 추출하는 함수 등이 포함되어 코드의 재사용성과 가독성을 높입니다.
마치며: 효율적인 도구 활용을 위한 제언
prettier-eslint의 설계 철학은 '설정보다 관례(Convention over Configuration)'에 가깝습니다. 이 도구를 가장 효율적으로 사용하는 방법은 프로젝트 루트에 표준적인 ESLint와 Prettier 설정 파일을 배치하고, 도구가 이를 자연스럽게 찾아내도록 맡기는 것입니다. 또한, 특정 파일에서 포맷팅 이슈가 발생할 경우 로그 레벨을 조정하여 내부 설정 추론 과정을 모니터링함으로써 문제를 빠르게 진단할 수 있습니다.