chore: flag translateLanguage is changed to flag reviewLanguage

mattzcarey · Oct 31, 2024 · 761a38d · 761a38d
1 parent 215a72a
commit 761a38d
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 22 deletions.
diff --git a/action.md b/action.md
@@ -31,7 +31,7 @@ jobs:
           GITHUB_TOKEN: ${{ github.token }}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           MODEL: 'gpt-4o'
-          TRANSLATE_LANGUAGE: 'English'
+          REVIEW_LANGUAGE: 'English'
 ```
 
 ### Workflow yml option 2: Add a code review bot
@@ -61,7 +61,8 @@ jobs:
       - name: Code Review GPT
         uses: mattzcarey/[email protected]
         with:
+          GITHUB_TOKEN: ${{ github.token }}
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           MODEL: 'gpt-4o'
-          GITHUB_TOKEN: ${{ github.token }}
+          REVIEW_LANGUAGE: 'English'
 ```
diff --git a/action.yml b/action.yml
@@ -6,7 +6,7 @@ inputs:
     description: 'The GPT model to use'
     required: true
     default: 'gpt-4o'
-  TRANSLATE_LANGUAGE:
+  REVIEW_LANGUAGE:
     description: 'Target natural language for translation'
     required: false
     default: 'English'
@@ -31,11 +31,11 @@ runs:
 
     - name: Run Code Review GPT
       shell: bash
-      run: npx code-review-gpt review --ci=github --model=$MODEL --translateLanguage=$TRANSLATE_LANGUAGE
+      run: npx code-review-gpt review --ci=github --model=$MODEL --reviewLanguage=$REVIEW_LANGUAGE
 
       env:
         MODEL: ${{ inputs.MODEL }}
-        TRANSLATE_LANGUAGE: ${{ inputs.TRANSLATE_LANGUAGE }}
+        REVIEW_LANGUAGE: ${{ inputs.REVIEW_LANGUAGE }}
         OPENAI_API_KEY: ${{ inputs.OPENAI_API_KEY }}
         BASE_SHA: ${{ github.event.pull_request.base.sha }}
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}

diff --git a/packages/code-review-gpt/README.md b/packages/code-review-gpt/README.md
@@ -105,7 +105,7 @@ You can now run `code-review-gpt review` in the root directory of any git-enable
 
 - `--reviewType` - Used with the 'review' command. The options are --reviewType=("changed" | "full" | "costOptimized). Defaults to "changed" if no option is specified. Specifies whether the review is for the full file or just the changed lines. costOptimized limits the context surrounding the changed lines to 5 lines.
 
-- `--translateLanguage` - Specifies the target natural language for translation, such as "German", "Spanish", or "French". Use this parameter to set the language in which the utility will provide output.
+- `--reviewLanguage` - Specifies the target natural language for translation, such as "German", "Spanish", or "French". Use this parameter to set the language in which the utility will provide output.
 
 - `--remote` - Used with the 'review' command. Usage `--remote=mattzcarey/code-review-gpt#96`. Review a remote GitHub Pull Request.
 

diff --git a/packages/code-review-gpt/package.json b/packages/code-review-gpt/package.json
@@ -17,7 +17,7 @@
     "start": "ts-node ./src/index.ts",
     "review": "ts-node ./src/index.ts review",
     "configure": "ts-node ./src/index.ts configure",
-    "test": "ts-node ./src/index.ts test",
+    "test": "ts-node ./src/index.ts test --reviewLanguage=Korean",
     "test-unit": "dotenv -e .env jest",
     "build": "node ./utils/build.js",
     "postbuild": "node ./utils/shebang.js && chmod +x ./dist/index.js",

diff --git a/packages/code-review-gpt/src/args.ts b/packages/code-review-gpt/src/args.ts
@@ -58,7 +58,7 @@ export const getYargs = async (): Promise<ReviewArgs> => {
       type: "string",
       default: "changed",
     })
-    .option("translateLanguage", {
+    .option("reviewLanguage", {
       description: "Specifies the target natural language for translation",
       type: "string",
     })

diff --git a/packages/code-review-gpt/src/common/types.ts b/packages/code-review-gpt/src/common/types.ts
@@ -42,7 +42,7 @@ export type ReviewArgs = {
   commentPerFile: boolean;
   model: string;
   reviewType: string;
-  translateLanguage: string | undefined;
+  reviewLanguage: string | undefined;
   org: string | undefined;
   remote: string | undefined;
   provider: string;

diff --git a/packages/code-review-gpt/src/review/index.ts b/packages/code-review-gpt/src/review/index.ts
@@ -34,7 +34,7 @@ export const review = async (
   const reviewType = yargs.reviewType;
   const organization = yargs.org;
   const provider = yargs.provider;
-  const translateLanguage = yargs.translateLanguage;
+  const reviewLanguage = yargs.reviewLanguage;
 
   const filteredFiles = filterFiles(files);
 
@@ -56,7 +56,7 @@ export const review = async (
     filteredFiles,
     maxPromptLength,
     reviewType,
-    translateLanguage
+    reviewLanguage
   );
 
   logger.debug(`Prompts used:\n ${prompts.toString()}`);

diff --git a/packages/code-review-gpt/src/review/prompt/constructPrompt/constructPrompt.ts b/packages/code-review-gpt/src/review/prompt/constructPrompt/constructPrompt.ts
@@ -9,7 +9,7 @@ export const constructPromptsArray = (
   files: ReviewFile[],
   maxPromptLength: number,
   reviewType: string,
-  translateLanguage = 'English',
+  reviewLanguage = 'English',
 ): string[] => {
   const maxPromptPayloadLength = maxPromptLength - instructionPrompt.length;
   let promptPayloads: PromptFile[][];
@@ -36,7 +36,7 @@ export const constructPromptsArray = (
 
   const languageToInstructionPrompt = instructionPrompt
       .replace("{ProgrammingLanguage}", getLanguageName(files[0].fileName))
-      .replace("{TranslateLanguage}", translateLanguage);
+      .replace("{ReviewLanguage}", reviewLanguage);
 
   const prompts = promptPayloads.map((payload) => {
     return languageToInstructionPrompt + JSON.stringify(payload);

diff --git a/packages/code-review-gpt/src/review/prompt/prompts.ts b/packages/code-review-gpt/src/review/prompt/prompts.ts
@@ -11,7 +11,7 @@ Do not comment on breaking functions down into smaller, more manageable function
 
 Use markdown formatting for the feedback details. Also do not include the filename or risk level in the feedback details.
 
-Ensure the feedback details are brief, concise, accurate, and in {TranslateLanguage}. If there are multiple similar issues, only comment on the most critical.
+Ensure the feedback details are brief, concise, accurate, and in {ReviewLanguage}. If there are multiple similar issues, only comment on the most critical.
 
 Include brief example code snippets in the feedback details for your suggested changes when you're confident your suggestions are improvements. Use the same programming language as the file under review.
 If there are multiple improvements you suggest in the feedback details, use an ordered list to indicate the priority of the changes.

diff --git a/packages/code-review-gpt/src/test/index.ts b/packages/code-review-gpt/src/test/index.ts
@@ -12,7 +12,7 @@ import { loadOrGenerateCodeSnippets } from "./load/loadTestCodeSnippets";
 import { runTests } from "./run/runTest";
 
 export const test = async (
-  { ci, model, reviewType, translateLanguage }: ReviewArgs,
+  { ci, model, reviewType, reviewLanguage }: ReviewArgs,
   openAIApiKey: string
 ): Promise<void> => {
   const maxPromptLength = getMaxPromptLength(model);
@@ -46,7 +46,7 @@ export const test = async (
     maxPromptLength,
     vectorStore,
     reviewType,
-    translateLanguage,
+    reviewLanguage,
   );
 
   if (ci === PlatformOptions.GITHUB) {

diff --git a/packages/code-review-gpt/src/test/run/runTest.ts b/packages/code-review-gpt/src/test/run/runTest.ts
@@ -19,7 +19,7 @@ import {
  * @param maxPromptLength The maximum prompt length.
  * @param vectorStore The vector store.
  * @param reviewType The review type.
- * @param translateLanguage Target natural language for translation.
+ * @param reviewLanguage Target natural language for translation.
  * @returns The test result.
  */
 const runTest = async (
@@ -29,7 +29,7 @@ const runTest = async (
   maxPromptLength: number,
   vectorStore: MemoryVectorStore,
   reviewType: string,
-  translateLanguage?: string,
+  reviewLanguage?: string,
   // eslint-disable-next-line max-params
 ): Promise<testResult> => {
   if (!testCase.snippet) {
@@ -43,7 +43,7 @@ const runTest = async (
     [testCase.snippet],
     maxPromptLength,
     reviewType,
-    translateLanguage
+    reviewLanguage
   );
 
   const { markdownReport: reviewResponse } = await askAI(
@@ -85,7 +85,7 @@ const runTest = async (
  * @param maxPromptLength The maximum prompt length.
  * @param vectorStore The vector store.
  * @param reviewType The review type.
- * @param translateLanguage Target natural language for translation.
+ * @param reviewLanguage Target natural language for translation.
  * @returns The test results.
  */
 export const runTests = async (
@@ -95,7 +95,7 @@ export const runTests = async (
   maxPromptLength: number,
   vectorStore: MemoryVectorStore,
   reviewType: string,
-  translateLanguage?: string,
+  reviewLanguage?: string,
   // eslint-disable-next-line max-params
 ): Promise<string> => {
   if (testCases.length === 0) {
@@ -116,7 +116,7 @@ export const runTests = async (
         maxPromptLength,
         vectorStore,
         reviewType,
-        translateLanguage
+        reviewLanguage
       );
       testResults[testCase.name] = result;
     } catch (error) {