VShell 도구용 Git 리베이스 및 코드 리팩토링

이번 주에는 VShell 도구의 코드베이스를 리팩토링하면서 git rebase 사용 방법을 자세히 알아볼 기회가 있었습니다. 나의 주요 작업은 코드를 더 읽기 쉽고, 유지 관리하기 쉽고, 디버깅하기 쉽게 만드는 데 필수적인 DRY(Don't Repeat Yourself) 원칙을 준수하면서 코드의 구조와 유지 관리성을 개선하는 것이었습니다. 또한 함수 추출, 클래스 추출, 변수 이름 바꾸기 등 리팩토링 카탈로그에 설명된 다양한 리팩토링 패턴을 따랐습니다.

리팩토링 작업을 자세히 살펴보기 전에 이 강력한 Git 기능에 아직 익숙해지고 있는 개발자를 위해 git rebase 프로세스에 대한 개요를 제공하겠습니다.

Git 리베이스 개요

기본 명령:

• git rebase : 이 명령은 현재 브랜치의 커밋을 지정된 브랜치 위로 이동하여 현재 브랜치를 효과적으로 리베이스합니다.

• git rebase : 이 명령은 토픽 브랜치를 먼저 확인할 필요 없이 토픽 브랜치를 기본 브랜치로 리베이스합니다.
  예: 일반적으로 토픽 브랜치를 확인하고 git rebase를 실행하지만 이 명령을 사용하면 기본 브랜치를 유지하면서 리베이스를 수행할 수 있습니다.

충돌 처리:

• git rebase --abort: 리베이스를 취소하고 브랜치를 이전 상태로 복원합니다.
• git add : 병합 충돌을 해결한 후 해결된 충돌을 준비 영역에 추가합니다.
• git rebase --continue: 충돌이 해결된 후 리베이스 프로세스를 계속합니다.

대화형 리베이스:

• git rebase -i 를 사용하세요. 여러 커밋을 하나로 압축합니다.
• 리베이스가 성공적으로 완료되면 모든 변경 사항이 통합되므로 주제 브랜치를 삭제할 수 있습니다. git Branch -d 를 사용하세요. 브랜치를 제거합니다.

중요 사항::

• 다른 공동작업자에게 영향을 미치므로 기본 분기를 리베이스하지 마세요.
• 푸시하기 전에 작업을 정리하려면 주제 브랜치에만 리베이스하세요.

→ 작업을 정리하기 위해 푸시하기 전에 로컬 변경 사항을 리베이스하되 어딘가에 푸시한 내용은 절대 리베이스하지 마세요.

리팩토링 프로세스

1. 리팩토링 브랜치 생성
   현재 작업 중인 코드가 손상되는 것을 방지하기 위해 메인 브랜치를 기반으로 별도의 리팩토링 브랜치를 만들었습니다. 이를 통해 안전하게 변경 사항을 실험할 수 있었습니다.

2. 코드 분석 및 리팩토링
   처음에는 VShell 코드에 모듈식 패턴을 적용했지만 더 큰 모듈을 분할하고 더 읽기 쉬운 코드 흐름을 만들기 위해서는 추가 개선이 필요했습니다.

   • 소스/서버:
     • 반복되는 로깅 로직을 handlerDebugMessage() 함수로 리팩터링하여 stderr 스트림을 통해 중앙 집중식 로깅을 허용했습니다.
     • 또한 구성 .toml 파일 처리를 처리하기 위해 ConfigHandler.js에 새 ConfigHandler 클래스를 만들었습니다. getTomlFiles() 및 loadConfig() 메서드는 설정을 모듈식으로 처리하기 위해 이 클래스에 캡슐화되었습니다.

• ai_config/grogConfig.js:

  • chatCompletion AI에서 응답을 반환하는 두 가지 방법이 토큰 사용량 검색에서 중복되었습니다. 이 로직을 getTokenUsage() 함수로 추출하여 readStream() 및 PromptGroq() 모두 재사용할 수 있도록 했습니다.
  • 추가로, PromptGroq()의 오타를 수정하고 명확성을 높이기 위해 온도 변수 이름을 바꿨습니다.

• src/ai.js:

  • 향후 재사용이 가능하도록 handlerOutput() 함수를 moduleOutputFile()로 옮겼습니다.

• src/getFileContent.js:

  • 여기에서는 최소한의 변경이 필요했습니다. 가독성과 명확성을 높이기 위해 파일 경로와 변수 이름만 바꿨습니다.

리팩토링 후 Git 리베이스

리팩토링 과정에서 11개의 커밋을 만든 후 이를 통합해야 했습니다. 커밋 기록을 깨끗하게 유지하기 위해 다음을 사용하여 대화형 리베이스를 수행했습니다.

git rebase main -i

내 Git 편집기로 구성된 VSCode에서 커밋을 스쿼시하라는 메시지가 표시되었습니다. 스쿼시 후에는 관련된 모든 변경 사항이 포함된 단일 커밋을 수행했습니다. 그런 다음 메인 브랜치에 병합하기 전에 새 커밋을 생성하는 대신 git commit --amend를 사용하여 커밋 메시지를 업데이트했습니다.

결론

이번 주의 git rebase 경험은 나에게 귀중한 통찰력을 제공했습니다. Rebase는 불필요한 병합 없이 깨끗하고 선형적인 커밋 기록을 유지하기 위한 필수 도구입니다. git rebase를 마스터함으로써 이제 커밋 메시지를 효율적으로 구성하고 혼란을 최소화하며 간소화된 개발 워크플로를 보장할 수 있습니다.

리팩토링 노력으로 VShell 코드베이스의 구조와 유지 관리성이 향상되었습니다. 함수 및 클래스 추출과 같은 주요 디자인 패턴을 적용하여 코드베이스를 더욱 모듈화하고 재사용 가능하며 앞으로 작업하기 쉽게 만들었습니다.

위 내용은 VShell 도구용 Git 리베이스 및 코드 리팩토링의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!