TypeScript에서 Import 문 간소화
대규모 TypeScript 또는 JavaScript 프로젝트에서 작업할 때, 특히 단일 모듈에서 여러 멤버를 가져올 때 긴 import 문을 접하는 것이 일반적입니다. 이 선은 처음에는 무해해 보일 수 있지만 쉽게 초과할 수 있습니다. 더 예뻐요 구성 인쇄 너비 설정하면 코드를 읽고 유지하기가 더 어려워집니다.
코드를 깔끔하고 읽기 쉽게 유지하려면 이러한 가져오기의 형식을 자동화하는 것이 중요합니다. 다음과 같은 도구 더 예뻐요 그리고 ESLint 긴 import 문을 여러 줄로 자동 분할하도록 사용자 정의할 수 있습니다. 이렇게 하면 설정한 형식 지정 규칙을 준수하면서 코드가 깔끔하고 일관되게 유지됩니다.
그러나 import 문 형식을 원하는 대로 자동으로 지정하도록 이러한 도구를 구성하는 것은 까다로울 수 있습니다. Prettier와 ESLint의 기본 설정은 많은 형식 문제를 처리하지만 여러 줄에 걸쳐 긴 import 문을 분할하는 경우 종종 부족합니다.
이 가이드에서는 TypeScript 프로젝트에서 import 문 형식을 올바르게 지정하기 위해 Prettier 및 ESLint를 구성하는 방법을 살펴보겠습니다. 코드베이스 전체에서 일관성을 유지하면서 여러 줄 가져오기를 수행하는 데 필요한 설정을 살펴보겠습니다.
명령 | 사용예 |
---|---|
prettier.format | 이 Prettier 함수는 구성된 규칙(예: printWidth, SingleQuote)에 따라 코드 블록의 형식을 지정하는 데 사용됩니다. 코드 문자열을 처리하고 형식화된 출력을 반환하므로 코드 스타일 일관성을 보장하는 데 이상적입니다. |
eslint.RuleTester | ESLint에 특정한 이 명령을 사용하면 개발자는 사용자 정의 ESLint 규칙을 테스트할 수 있습니다. 규칙 테스터에 샘플 코드를 제공함으로써 가져오기가 여러 줄로 분할되는지 확인하는 등 규칙이 올바르게 적용되는지 여부를 검증합니다. |
prettier-plugin-organize-imports | 가져오기를 자동으로 구성하도록 설계된 Prettier 플러그인입니다. import 문이 정렬되도록 보장하고 printWidth와 같은 Prettier 규칙과 결합하면 긴 가져오기를 여러 줄로 나눌 수 있습니다. |
jest.describe | 관련 테스트를 그룹화하는 Jest 기능입니다. 이러한 맥락에서 ESLint 및 Prettier 구성이 긴 import 문을 여러 줄로 나누어 올바르게 처리하는지 확인하는 테스트를 그룹화합니다. |
import/order | 이는 import 문 순서에 대한 규칙을 적용하는 eslint-plugin-import의 특정 ESLint 규칙입니다. 또한 서로 다른 가져오기 그룹(예: 내장, 외부 패키지) 사이에 줄바꿈을 추가하도록 강제할 수도 있습니다. |
alphabetize | ESLint 가져오기/주문 규칙 내에서 이 옵션을 사용하면 가져온 멤버가 사전순으로 정렬됩니다. 이는 특히 여러 가져오기를 수행하는 대규모 프로젝트에서 코드 가독성을 향상시킵니다. |
jest.it | 이 Jest 함수는 단일 단위 테스트를 정의하는 데 사용됩니다. 이 예에서는 구성된 Prettier 및 ESLint 규칙에 따라 긴 가져오기가 여러 줄로 올바르게 분할되었는지 확인합니다. |
newlines-between | ESLint 규칙 가져오기/주문에 대한 구성 옵션입니다. 가져오기 그룹(예: 외부 및 내부 가져오기) 사이에 줄바꿈을 강제로 적용하여 코드를 더욱 구조화하고 탐색하기 쉽게 만듭니다. |
TypeScript에서 여러 줄 가져오기를 위한 Prettier 및 ESLint 구성
위 스크립트의 주요 목표는 다음을 구성하는 것입니다. 더 예뻐요 그리고 ESLint TypeScript 프로젝트의 여러 줄에 걸쳐 긴 import 문 형식을 자동으로 지정합니다. Prettier 구성은 작은따옴표 및 후행 쉼표와 같은 코딩 스타일을 정의하고 다음을 사용하여 코드를 래핑하는 방법을 관리하도록 설정됩니다. 인쇄 너비 규칙. 줄이 설정된 너비(이 경우 80자 또는 120자)를 초과하면 Prettier는 코드를 더 쉽게 읽을 수 있도록 자동으로 코드 형식을 지정합니다. 을 사용하여 더 예쁜 플러그인-구성-수입 플러그인을 사용하면 import 문이 논리적으로 분할되고 정렬되는지 확인합니다.
ESLint 구성에서는 수입/주문 ~로부터 통치하다 eslint-플러그인-가져오기 플러그인은 가져오기 구성 방법을 제어하는 데 필수적입니다. 여기서 목표는 다양한 그룹(예: 내장 모듈, 외부 패키지, 내부 모듈)에서 가져온 항목을 줄바꿈으로 구분하는 일관된 가져오기 구조를 적용하는 것입니다. 또한 동일한 그룹 내의 가져오기는 가독성을 높이기 위해 알파벳순으로 정렬됩니다. 이러한 규칙은 특히 여러 파일에서 가져온 많은 수의 멤버를 처리할 때 가져오기가 복잡해지는 것을 방지합니다.
ESLint 설정의 또 다른 중요한 측면은 개행 사이 옵션을 사용하면 각 가져오기 그룹이 빈 줄로 구분됩니다. 이렇게 하면 특히 대규모 코드베이스에서 코드가 더욱 시각적으로 구성됩니다. 와 결합 알파벳순 규칙에 따라 전체 가져오기 블록이 구조화되고 유지 관리가 더 쉬워집니다. Visual Studio Code에 저장 시 코드 형식이 지정되면 이러한 설정이 자동으로 적용되므로 수동 조정 없이 전체 프로젝트에서 일관된 가져오기 형식이 보장됩니다.
마지막으로 이 구성을 테스트하는 것은 올바르게 작동하는지 확인하는 데 중요합니다. 그만큼 농담 단위 테스트는 Prettier 및 ESLint 구성이 예상대로 가져오기 분할 및 형식화를 처리하는지 확인하도록 설계되었습니다. 예를 들어 긴 import 문이 제공되면 테스트에서는 여러 줄로 적절하게 분할되었는지 확인합니다. 이 접근 방식을 통해 개발자는 형식 지정 규칙 테스트를 자동화하여 향후 코드 변경이 동일한 가져오기 구조 지침을 준수하도록 할 수 있습니다.
TypeScript에서 긴 Import 문을 분할하기 위해 Prettier 및 ESLint 구성
이 스크립트는 Prettier 및 ESLint를 활용하여 TypeScript 프로젝트에서 여러 줄 가져오기 문의 형식을 구성합니다. Visual Studio Code를 사용한 프런트 엔드 개발에 중점을 두고 있습니다.
module.exports = {
semi: false,
singleQuote: true,
trailingComma: 'all',
printWidth: 80,
plugins: ['prettier-plugin-organize-imports'],
}
// Prettier configuration setup for import splitting
ESLint 플러그인 가져오기로 가져오기 형식 지정에 ESLint 사용
이 백엔드 스크립트는 가져오기 플러그인으로 ESLint를 구성하여 여러 줄 가져오기 규칙을 적용합니다. 최적화된 코드 모듈성을 보장합니다.
module.exports = {
"extends": ["eslint:recommended", "plugin:import/errors", "plugin:import/warnings"],
"rules": {
"import/order": [
"error", {
"groups": ["builtin", "external", "internal"],
"newlines-between": "always",
"alphabetize": { "order": "asc", "caseInsensitive": true }
}],
"max-len": ["error", { "code": 80 }],
}
}
// ESLint rule setup to organize imports into multiple lines and ensure alphabetical order
가져오기 형식 지정 구성 테스트를 위한 예제 스크립트
이 스크립트는 Prettier 및 ESLint 구성의 적용을 보여줍니다. 이는 긴 가져오기가 여러 줄로 분할되는 프런트엔드 예시 역할을 합니다.
import {
longFunctionNameOne,
longFunctionNameTwo,
longFunctionNameThree
} from '@example/long-module-name';
import {
shortFunctionNameOne,
shortFunctionNameTwo
} from '@example/short-module-name';
// Example of formatted import statements following the configured rules
가져오기 형식 설정에 대한 단위 테스트
이 백엔드 스크립트는 Jest를 사용하여 Prettier 및 ESLint 구성이 다양한 환경에서 예상대로 작동하는지 확인하는 단위 테스트를 제공합니다.
const eslint = require('eslint');
const prettier = require('prettier');
const { describe, it } = require('@jest/globals');
describe('Import Formatting', () => {
it('should split long imports into multiple lines', () => {
const code = `import { a, b, c, d } from '@example/package';`;
const formatted = prettier.format(code, { printWidth: 80 });
expect(formatted).toMatch(/import { a, b }/);
});
});
// Unit test to check if long imports are split into multiple lines using Jest
더 예쁜 ESLint 가져오기 형식으로 코드 가독성 향상
더 큰 코드베이스를 처리할 때 일관된 가져오기 구조를 유지하는 것은 코드 가독성과 팀 협업을 모두 향상시키는 데 중요합니다. 개발자가 직면하는 일반적인 문제 중 하나는 특히 단일 모듈의 많은 요소가 포함된 경우 import 문이 파일 상단을 복잡하게 만드는 시간입니다. 이것은 다음과 같은 도구가 있는 곳입니다. 더 예뻐요 그리고 ESLint 여러 줄에 걸쳐 가져오기 분할을 자동화할 수 있습니다. 일반적으로 import 문이 정의된 너비를 준수하는지 확인합니다. 인쇄 너비 설정을 사용하면 가로 스크롤을 방지하고 코드를 쉽게 스캔할 수 있습니다.
또 다른 중요한 측면은 수입품 자체의 조직적 패턴입니다. 사용하여 수입/주문 ESLint에서 제공하는 규칙을 사용하면 내장 라이브러리, 타사 종속성 또는 내부 모듈 등 원본을 기준으로 가져오기를 그룹화할 수 있습니다. 이러한 그룹은 줄 바꿈으로 분할될 수 있으므로 개발자가 종속성을 더 쉽고 빠르게 식별할 수 있습니다. 이 방법은 구조화된 가져오기를 촉진하며, 이를 통해 알파벳순 정렬과 결합됩니다. 알파벳순 옵션을 사용하면 코드베이스 전반에 걸쳐 명확성과 일관성이 더욱 향상됩니다.
또한 개발자는 다음과 같은 도구를 활용하고 싶을 수도 있습니다. 더 예쁜 플러그인-구성-수입 가져오기가 올바르게 분할될 뿐만 아니라 논리적으로 재배열되도록 합니다. 이러한 도구는 Visual Studio Code와 같은 편집기에 파일이 저장될 때마다 원하는 가져오기 구조를 자동으로 적용합니다. 이를 통해 개발자는 import 문을 수동으로 조정할 필요가 없으며 더 깔끔하고 유지 관리하기 쉬운 코드를 작성하는 데 집중할 수 있습니다.
Prettier 및 ESLint를 사용한 가져오기 형식 지정에 대한 일반적인 질문
- 최고는 무엇입니까 ESLint 수입품 정리 규칙?
- 그만큼 import/order ~로부터 통치하다 eslint-plugin-import 수입품 정리에 이상적입니다. 이를 통해 가져오기를 일관되게 그룹화, 정렬 및 구조화할 수 있습니다.
- 다음을 사용하여 import 문을 여러 줄로 나눌 수 있습니까? Prettier 홀로?
- Prettier는 다음과 같은 경우 긴 import 문을 여러 줄로 나눌 수 있습니다. printWidth 규칙이 초과되었습니다. 그러나 ESLint와 결합하면 더 많은 사용자 정의가 가능합니다.
- 무엇을 하는가? alphabetize 옵션은?
- 그만큼 alphabetize 옵션 import/order import 멤버와 명령문이 알파벳순으로 정렬되어 코드 가독성이 향상됩니다.
- 저장 시 가져오기 형식이 자동으로 지정되도록 하려면 어떻게 해야 합니까?
- 두 가지 모두 보장 Prettier 그리고 ESLint 일반적으로 다음의 설정을 통해 편집기에 저장할 때 실행되도록 구성됩니다. Visual Studio Code 또는 유사한 IDE.
- 왜 사용합니까? prettier-plugin-organize-imports?
- 이 플러그인은 가져오기를 여러 줄로 분할할 뿐만 아니라 논리적으로 정렬 및 그룹화하여 코드 유지 관리성을 더욱 향상시킵니다.
Prettier 및 ESLint 구성에 대한 최종 생각
import 문의 자동 형식화를 위해 Prettier 및 ESLint를 설정하는 것은 프로젝트의 유지 관리성을 향상시키는 강력한 방법입니다. 긴 가져오기가 논리적으로 분할, 정렬 및 구성되도록 보장합니다.
이러한 도구를 플러그인과 결합하면 TypeScript 파일 전반에 걸쳐 일관성이 보장됩니다. 이렇게 하면 코드가 깔끔하게 유지될 뿐만 아니라 가져오기 구조가 균일하게 유지되므로 팀 내 협업이 향상됩니다.
Prettier 및 ESLint 구성을 위한 참조 및 유용한 소스
- Prettier 구성에 대한 공식 문서는 다음을 참조하세요. 더 예쁜 문서 .
- ESLint 및 가져오기/주문 규칙에 대한 자세한 내용은 다음에서 확인할 수 있습니다. eslint-플러그인-가져오기 GitHub .
- 다음과 같은 Prettier 플러그인을 사용하는 방법을 알아보려면 더 예쁜 플러그인-구성-수입, 방문하다 더 예쁜 플러그인-구성-수입 GitHub .
- 저장 시 자동으로 포맷되도록 Visual Studio Code를 구성하는 방법에 대한 포괄적인 가이드를 보려면 다음을 확인하세요. Visual Studio 코드 설정 .