update build config

minhlucvan · minhlucvan · commit 78c8e35723e0 · 2023-03-31T12:41:23.000+07:00
diff --git a/config/.crgpt.yml b/config/.crgpt.yml
@@ -1,3 +1,52 @@
+output: 'console'
 openai:
+  endpoint: "https://api.openai.com/v1/chat/completions"
+  apiKey: "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"
 bitbucket:
-code:
+  apiBaseUrl: "https://api.bitbucket.org/2.0/repositories"
+  owner: "busker-media"
+  projectKey: "BUS"
+  apiKey: "ATATT3xFfGF0D5CT_V-f5syiMzYP4Wqpe1fjcYohmNnuUme3Kf2CKpB555uRCqBbnJYT2ntpnNpu5_eK5anqdUimEGL4_VoDL1RG7JmtHQO4SCzTaPuQQ-YsAMFu3ki_e_PJ2VVd8yIxjeOPqIOdhcWZE2BQrmdyObrwT5hTofnuIVW_YeWh1t0=030F1CE0"
+  accessToken: "ATCTT3xFfGN0oxLuIA7sR3WQ5EJoR4IzhZdBS0fJU_Ngp4uek3r9UoDc9KjJ38RPFKHlbHLjPRFwCIPYjtOcXtLKl4EV3CapwQQ50zO8l3FkKa9sYVJA1GUQrxQrMXFiViYRI0gfk0O2HvXvHctWfAZRcE3QwNqtrB686wFitgRotrmeAi7goME=325FBD69"
+  repoSlug: "busker-server"
+  # username: "minhlvqs"
+  username: "ccode-review"
+  password: "ATBBnxahHvckTy76rNF4JxjBSueNE5057365"
+codeReview:
+  prompt: |
+    Your task is to act as a code reviewer and review a pull request by summarizing the changes made, identifying potential issues related to logic and runtime, and creating a bullet list of action items needed before the change can be approved. The output should focus on items mentioned in the given code review checklist.
+    Instructions:
+    - Review the output of git diff for the pull request
+    - Summarize the overview of the changes made
+    - Identify potential issues related to logic and runtime
+    - Output as a markdown document, with the following sections:
+        {output}
+    - If there are no issues, output "None"
+    - If there are no action items, output "None"
+    - Create a bullet list of action items needed before the change can be approved
+    - The response sentences are no longer than 16 words each
+    - Keep the response sentences as short as possible
+    - Focus on items mentioned in the given code review checklist:
+        {checklist}
+  output: |
+      #### Overview of changes:
+        - Summarize the overview of the changes made
+      #### issues:
+        - Identify potential issues related to logic and runtime
+        - Identify issues mentioned in the code review checklist
+      #### Action items:
+        - Action items needed before the change can be approved
+  checklist: |
+      Code Structure
+        - Is the codebase organized according to NestJS' recommended project structure?
+        - Are there any unnecessary files, folders, or code modules?
+        - Does the code follow the Single Responsibility Principle (SRP) and Don't Repeat Yourself (DRY) principle?
+      Error Handling
+        - Are all error scenarios covered in the code?
+        - Are the error messages clear and helpful?
+        - Is the code handling errors gracefully?
+      Security
+        - Are sensitive data and credentials stored securely?
+        - Are all external libraries and packages up-to-date?
+        - Is the code protected against common security vulnerabilities such as SQL injection and cross-site scripting (XSS)?
+
diff --git a/package.json b/package.json
@@ -2,15 +2,23 @@
   "name": "crgpt",
   "version": "1.0.0",
   "description": "CLI tool that leverages ChatGPT API to perform code reviews and providing suggestions for improving code quality.",
-  "keywords": ["code-review", "code-quality", "chatgpt", "chatbot", "code-review-bot", "code-quality-bot"],
+  "keywords": [
+    "code-review",
+    "code-quality",
+    "chatgpt",
+    "chatbot",
+    "code-review-bot",
+    "code-quality-bot"
+  ],
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "crgpt": "crgpt",
+    "crgpt": "node ./dist/cli/crgpt.js",
+    "build:clean": "tsc --build --clean",
     "build": "tsc"
-  },  
+  },
   "bin": {
-    "crgpt": "dist/cli.js"
+    "crgpt": "dist/cli/crgpt.js"
   },
   "repository": {
     "type": "git",
@@ -28,8 +36,9 @@
     "typescript": "^5.0.2"
   },
   "dependencies": {
+    "@types/node-fetch": "2",
     "commander": "^10.0.0",
     "js-yaml": "^4.1.0",
-    "node-fetch": "^3.3.1"
+    "node-fetch": "2"
   }
 }
diff --git a/src/cli/config.ts b/src/cli/config.ts
@@ -5,7 +5,13 @@ import { Config } from '../lib/types';
 export async function readConfig(configFile: string): Promise<Config> {
     try {
       const fileContents = await fs.readFile(configFile, 'utf8');
-      return yaml.load(fileContents) as Config;
+      const config = yaml.load(fileContents) as Config;
+
+      if (!config) {
+        throw new Error('Config file is empty');
+      }
+
+      return config;
     } catch (error) {
       throw new Error(`Error reading config file`);
     }
diff --git a/src/cli/crgpt.ts b/src/cli/crgpt.ts
@@ -15,6 +15,7 @@ program
       .choices(['init', 'review', 'diff', 'desc'])
       .default('review', 'Code review')
   )
+  .option('-o, --output <output>', 'output method')
   .option('-s, --source <source>', 'Source branch name')
   .option('-t, --target <target>', 'Target branch name')
   .option('-p, --prId [prId]', 'Pull request ID')
diff --git a/src/cli/init.ts b/src/cli/init.ts
@@ -5,6 +5,7 @@ import { CrGPTCLIOptions } from './types';
 
 export async function initCRGPT(configPath: string, options: CrGPTCLIOptions): Promise<void> {
   const defaultConfig: Config = {
+    output: 'console',
     openai: {
       endpoint: 'https://api.openai.com/v1/engines/davinci-codex/completions',
       apiKey: options.aiToken || '',
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1 @@
+export * from './lib';
diff --git a/src/lib/crgpt.ts b/src/lib/crgpt.ts
@@ -69,7 +69,8 @@ async function postDiffToEndpoint(
   const apiKey = config.openai.apiKey;
   const promptTml = config.review.prompt;
   const checklist = config.review.checklist;
-  const prompt = promptTml.replace('{checklist}', checklist);
+  const summary = config.review.summary
+  const prompt = promptTml.replace('{checklist}', checklist).replace('{output}', summary);
 
   const response = await fetch(endpointUrl, {
     method: 'POST',
diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -1,4 +1,5 @@
 export type Config = {
+    output: 'console';
     bitbucket?: {
       repoSlug: string;
       accessToken: string;
diff --git a/tsconfig.json b/tsconfig.json
@@ -11,7 +11,7 @@
     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
     /* Language and Environment */
-    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "target": "es5",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
     "lib": ["es6"],                                      /* Specify a set of bundled library declaration files that describe the target runtime environment. */
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
     // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
@@ -55,7 +55,7 @@
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "build",                                   /* Specify an output folder for all emitted files. */
+    "outDir": "dist",                                   /* Specify an output folder for all emitted files. */
     // "removeComments": true,                           /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
diff --git a/yarn.lock b/yarn.lock
@@ -0,0 +1,106 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@types/js-yaml@^4.0.5":
+  version "4.0.5"
+  resolved "https://registry.yarnpkg.com/@types/js-yaml/-/js-yaml-4.0.5.tgz#738dd390a6ecc5442f35e7f03fa1431353f7e138"
+  integrity sha512-FhpRzf927MNQdRZP0J5DLIdTXhjLYzeUTmLAu69mnVksLH9CJY3IuSeEgbKUki7GQZm0WqDkGzyxju2EZGD2wA==
+
+"@types/node-fetch@2":
+  version "2.6.3"
+  resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.6.3.tgz#175d977f5e24d93ad0f57602693c435c57ad7e80"
+  integrity sha512-ETTL1mOEdq/sxUtgtOhKjyB2Irra4cjxksvcMUR5Zr4n+PxVhsCD9WS46oPbHL3et9Zde7CNRr+WUNlcHvsX+w==
+  dependencies:
+    "@types/node" "*"
+    form-data "^3.0.0"
+
+"@types/node@*", "@types/node@^18.15.11":
+  version "18.15.11"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-18.15.11.tgz#b3b790f09cb1696cffcec605de025b088fa4225f"
+  integrity sha512-E5Kwq2n4SbMzQOn6wnmBjuK9ouqlURrcZDVfbo9ftDDTFt3nk7ZKK4GMOzoYgnpQJKcxwQw+lGaBvvlMo0qN/Q==
+
+argparse@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
+  integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
+
+asynckit@^0.4.0:
+  version "0.4.0"
+  resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
+  integrity sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==
+
+combined-stream@^1.0.8:
+  version "1.0.8"
+  resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.8.tgz#c3d45a8b34fd730631a110a8a2520682b31d5a7f"
+  integrity sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==
+  dependencies:
+    delayed-stream "~1.0.0"
+
+commander@^10.0.0:
+  version "10.0.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.0.tgz#71797971162cd3cf65f0b9d24eb28f8d303acdf1"
+  integrity sha512-zS5PnTI22FIRM6ylNW8G4Ap0IEOyk62fhLSD0+uHRT9McRCLGpkVNvao4bjimpK/GShynyQkFFxHhwMcETmduA==
+
+delayed-stream@~1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619"
+  integrity sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==
+
+form-data@^3.0.0:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/form-data/-/form-data-3.0.1.tgz#ebd53791b78356a99af9a300d4282c4d5eb9755f"
+  integrity sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==
+  dependencies:
+    asynckit "^0.4.0"
+    combined-stream "^1.0.8"
+    mime-types "^2.1.12"
+
+js-yaml@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602"
+  integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
+  dependencies:
+    argparse "^2.0.1"
+
+mime-db@1.52.0:
+  version "1.52.0"
+  resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70"
+  integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==
+
+mime-types@^2.1.12:
+  version "2.1.35"
+  resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a"
+  integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==
+  dependencies:
+    mime-db "1.52.0"
+
+node-fetch@2:
+  version "2.6.9"
+  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.9.tgz#7c7f744b5cc6eb5fd404e0c7a9fec630a55657e6"
+  integrity sha512-DJm/CJkZkRjKKj4Zi4BsKVZh3ValV5IR5s7LVZnW+6YMh0W1BfNA8XSs6DLMGYlId5F3KnA70uu2qepcR08Qqg==
+  dependencies:
+    whatwg-url "^5.0.0"
+
+tr46@~0.0.3:
+  version "0.0.3"
+  resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a"
+  integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==
+
+typescript@^5.0.2:
+  version "5.0.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.0.3.tgz#fe976f0c826a88d0a382007681cbb2da44afdedf"
+  integrity sha512-xv8mOEDnigb/tN9PSMTwSEqAnUvkoXMQlicOb0IUVDBSQCgBSaAAROUZYy2IcUy5qU6XajK5jjjO7TMWqBTKZA==
+
+webidl-conversions@^3.0.0:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871"
+  integrity sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==
+
+whatwg-url@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-5.0.0.tgz#966454e8765462e37644d3626f6742ce8b70965d"
+  integrity sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==
+  dependencies:
+    tr46 "~0.0.3"
+    webidl-conversions "^3.0.0"

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ program`
`15`	`15`	`.choices(['init', 'review', 'diff', 'desc'])`
`16`	`16`	`.default('review', 'Code review')`
`17`	`17`	`)`
	`18`	`+ .option('-o, --output <output>', 'output method')`
`18`	`19`	`.option('-s, --source <source>', 'Source branch name')`
`19`	`20`	`.option('-t, --target <target>', 'Target branch name')`
`20`	`21`	`.option('-p, --prId [prId]', 'Pull request ID')`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export type Config = {`
	`2`	`+ output: 'console';`
`2`	`3`	`bitbucket?: {`
`3`	`4`	`repoSlug: string;`
`4`	`5`	`accessToken: string;`