ChatGPT(OpenAI) 를 활용한 Code Review

개요

이 문서는 OpenAI를 사용하여 코드 리뷰 도구를 개발하는 과정을 설명합니다. 이 도구는 주어진 코드에 대한 자동화된 리뷰와 피드백을 생성하여 개발자의 생산성을 향상시키는 데 목적이 있습니다.

1. 코드 리뷰 도구 소개

이 코드 리뷰 도구는 OpenAI의 GPT-3.5를 활용하여 코드에 대한 리뷰와 피드백을 생성합니다. 사용자는 코드를 입력하고 프롬프트를 통해 리뷰를 요청하면, OpenAI 모델이 해당 코드에 대한 리뷰를 생성하여 제공합니다.

2. 주요 구성 요소

openai.js

// openai.js

require('dotenv').config();
const OpenAI = require('openai');
const fs = require('fs');

// Get the file path from the command line.
const filePath = process.argv[2];
if (!filePath) {
  console.error('Please provide a file path.');
  process.exit(1);
}

// Read the file and get the code.
const code = fs.readFileSync(filePath, 'utf-8');

// Set color ansi codes
const reset = '\x1b[0m';
const green = '\x1b[32m';

// Prompt
const prompt = `
당신은 30년차 엔지니어입니다.
아래의 코드를 보고 문제 및 개선사항 그리고 Best Practices 에 대한 충분한 리뷰와 피드백과 잘한 점에 대해 논평을 부탁할게요.

${code}

우리에게 유익한 정보일 경우 당신에게 충분한 보상을 하겠습니다.
`;
if (prompt == null) {
  console.error('Please provide a valid command.');
  process.exit(1);
}

// OpenAI Instance
const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

async function runCodeReview() {
  try {
    const chatCompletion = await openai.chat.completions.create({
      model: 'gpt-3.5-turbo',
      messages: [
        {
          role: 'user',
          content: prompt,
        },
      ],
    });

    const review = chatCompletion.choices[0]?.message?.content;
    console.log(`${green}Review ${filePath}:${reset}\n${review}${reset}\n`);
  } catch (error) {
    console.error(error);
  }
}

runCodeReview();

.env 파일

// .env 파일
// https://platform.openai.com/api-keys 에서 발급받은 API KEY

OPENAI_API_KEY={OPEN_API_KEY}

package.json

// package.json

{
  "name": "openai-codereview",
  "version": "1.0.0",
  "description": "OpenAI를 활용한 코드 리뷰 도구",
  "author": {
    "name": "Seungyoon",
    "url": "https://bokdol2.tistory.com/"
  },
  "private": true,
  "workspaces": {
    "packages": [
      "packages/*"
    ]
  },
  "scripts": {
    "review": "node openai.js"
  },
  "devDependencies": {
    "openai": "^4.26.1",
  },
  "packageManager": "yarn@1.22.19"
}

3. 사용 방법

사용자는 명령줄 인터페이스를 통해 코드 파일의 경로를 지정하여 리뷰를 요청합니다. OpenAI 모델이 해당 코드에 대한 리뷰를 생성하고 콘솔에 출력됩니다.

// run

yarn review {filePath}

 

4. 보안 및 개인 정보 보호

OpenAI API 키를 환경 변수에 저장하여 보안을 유지하고, 개인 정보 보호를 위해 신중하게 다루어야 합니다. 또한, OpenAI의 사용법 및 개인 정보 보호 정책을 숙지하여 안전한 사용을 유지해야 합니다.

5. 추가 정보

• McAfee 블로그: ChatGPT의 프라이버시에 대한 영향 및 보호 방법에 대한 정보를 제공합니다.
• OpenAI 플랫폼 사용량: OpenAI 플랫폼의 사용량 및 관련 정보를 확인할 수 있는 링크입니다.
• Git commit 시 hooks/pre-commit 설정으로 변경된 파일들에 대해서도 Code Review 가능합니다.

이 문서는 OpenAI를 활용하여 코드 리뷰 도구를 구축하는 데 필요한 정보를 제공하며, 개발자들이 코드 품질을 향상시키고 생산성을 향상시킬 수 있도록 지원합니다.