Suv4o/vscode-copilot-clean-code-setup

vscode-copilot-clean-code-setup은(는) 무엇을 하나요?

Robert C. Martin의 Clean Code 원칙을 적용하는 맞춤형 VS Code Copilot 설정입니다. Copilot 에이전트가 코드 작성 시 이 규칙들을 자동으로 따르며, PR 생성 전에 변경된 파일을 검토하는 사전 PR 리뷰어 스킬을 제공합니다.

개요

이 설정은 다음을 제공합니다:

• 작성 중 규칙 적용: Copilot이 코드를 생성할 때 Clean Code 원칙을 자동으로 준수합니다.
• 사전 PR 리뷰: 풀 리퀘스트를 생성하기 전에 변경된 파일을 검사하여 잠재적인 문제를 식별합니다.

주요 기능

1. Copilot 규칙 설정

VS Code의 settings.json에 다음 구성을 추가하여 Clean Code 원칙을 활성화합니다.

{
  "github.copilot.chat.codeGeneration.useLowercase": true,
  "github.copilot.chat.codeGeneration.instructions": [
    {
      "text": "Robert C. Martin의 Clean Code 원칙을 따르십시오. 의미 있는 이름을 사용하고, 함수는 작게 유지하며, 명확한 오류 처리를 포함하십시오."
    },
    {
      "file": ".github/copilot-instructions.md"
    }
  ]
}

2. 사전 PR 리뷰어 스크립트

변경된 파일을 검사하는 스크립트입니다.

#!/bin/bash
# pre-pr-review.sh
# 이 스크립트는 PR 생성 전에 변경된 파일을 분석합니다.

echo "Clean Code 사전 PR 리뷰를 시작합니다..."

# 변경된 파일 목록 가져오기
CHANGED_FILES=$(git diff --name-only HEAD)

for FILE in $CHANGED_FILES; do
  echo "검토 중: $FILE"
  # 여기에 Clean Code 규칙 검사 로직 추가
done

echo "리뷰 완료."

3. Copilot 지침 파일

.github/copilot-instructions.md 파일에 Clean Code 원칙을 상세히 정의합니다.

# Clean Code Copilot 지침

이 지침은 Copilot이 코드를 생성할 때 Clean Code 원칙을 따르도록 안내합니다.

## 원칙

- **의미 있는 이름**: 변수, 함수, 클래스 이름은 의도를 명확히 드러내야 합니다.
- **작은 함수**: 각 함수는 하나의 일만 수행하며, 20줄을 넘지 않아야 합니다.
- **DRY 원칙**: 코드 중복을 피하고 재사용 가능한 구성 요소를 만듭니다.
- **명확한 오류 처리**: 예외는 무시하지 말고 적절히 처리합니다.
- **주석 최소화**: 코드 자체로 설명이 가능하도록 작성합니다.

사용 방법

1. 이 저장소의 내용을 프로젝트에 복사하거나 참조로 추가합니다.
2. VS Code 설정(settings.json)에 Copilot 규칙을 적용합니다.
3. pre-pr-review.sh 스크립트를 Git 훅 또는 CI/CD 파이프라인에 통합합니다.
4. Pull Request를 생성하기 전에 스크립트를 실행하여 코드 품질을 확인합니다.

지원 환경

• IDE: VS Code
• 확장: GitHub Copilot
• 버전 관리: Git

라이선스

이 프로젝트는 MIT 라이선스 하에 배포됩니다.

기여

버그 수정 또는 개선 사항이 있으면 이슈를 열거나 풀 리퀘스트를 제출해 주세요.