Merge pull request #16 from jaychang99/release/v0.3.0-beta

Release/v0.3.0 beta

Author: jaychang99

package-lock.json

@@ -76,7 +76,7 @@
     "@actions/core": "^1.10.1",
     "@slack/web-api": "^7.3.1",
     "markdown-it": "^14.1.0",
-    "openapi-diff-node": "^1.0.1"
+    "openapi-diff-node": "1.1.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",

package.json

@@ -22,5 +22,9 @@ export const LOCALE_EN_US: Locale = {
 
   repository: 'Repository',
 
-  'exception.missing-description': 'No description provided. Please add one'
+  'exception.missing-description': 'No description provided. Please add one',
+
+  description: 'description',
+  required: 'required',
+  example: 'example'
 }

src/locale/en-us.ts

@@ -22,5 +22,9 @@ export const LOCALE_KO_KR: Locale = {
 
   repository: '저장소',
 
-  'exception.missing-description': '설명이 없습니다. 추가해주세요'
+  'exception.missing-description': '설명이 없습니다. 추가해주세요',
+
+  description: '설명',
+  required: '필수여부',
+  example: '예시'
 }

src/locale/ko-kr.ts

@@ -237,34 +237,104 @@ export class Slack {
         ]
       }
 
+      let required = ''
+      if (param.required === true) {
+        required = translate('required.required')
+      } else if (param.required === false) {
+        required = translate('required.optional')
+      } else {
+        required = param.required
+      }
+
+      const descriptionElements: RichTextList['elements'] = []
+
+      if (param.description) {
+        descriptionElements.push({
+          type: 'rich_text_section',
+          elements: [
+            {
+              type: 'text',
+              text: `${translate('description')}: ${param.description}`
+            }
+          ]
+        })
+      }
+
+      if (required !== 'N/A') {
+        descriptionElements.push({
+          type: 'rich_text_section',
+          elements: [
+            {
+              type: 'text',
+              text: `${translate('required')}: ${required}`
+            }
+          ]
+        })
+      }
+
+      if (param.example !== 'N/A') {
+        descriptionElements.push({
+          type: 'rich_text_section',
+          elements: [
+            {
+              type: 'text',
+              text: `${translate('example')}: ${param.example}`
+            }
+          ]
+        })
+      }
+
+      if (param.enum.length > 0) {
+        const enumElementList: RichTextElement[] = []
+
+        for (const e of param.enum) {
+          const isFirstIteration = enumElementList.length === 0
+
+          enumElementList.push({
+            type: 'text',
+            text: isFirstIteration ? 'ENUM: ' : ', '
+          })
+          enumElementList.push({
+            type: 'text',
+            text: e,
+            style: {
+              code: true
+            }
+          })
+        }
+
+        descriptionElements.push({
+          type: 'rich_text_section',
+          elements: enumElementList
+        })
+      }
+
+      if (param.changeLogs.length > 0) {
+        const changeLogElementList: RichTextElement[] = []
+
+        for (const changeLog of param.changeLogs) {
+          const { field, oldValue, newValue } = changeLog
+
+          changeLogElementList.push({
+            type: 'text',
+            text: `${field} ${translate(
+              'status.modified'
+            )}: ${oldValue} -> ${newValue}`
+          })
+        }
+
+        descriptionElements.push({
+          type: 'rich_text_section',
+          elements: changeLogElementList
+        })
+      }
+
       const description: RichTextList = {
         type: 'rich_text_list',
         style: 'bullet',
         indent: 0,
         border: 1,
-        elements: [
-          {
-            type: 'rich_text_section',
-            elements: [
-              {
-                type: 'text',
-                text:
-                  param.description ||
-                  translate('exception.missing-description')
-              }
-            ]
-          },
-
-          {
-            type: 'rich_text_section',
-            elements: [
-              {
-                type: 'text',
-                text: param.required ? 'Required' : 'Optional'
-              }
-            ]
-          }
-        ]
+        elements: descriptionElements
       }
 
       const newline: RichTextSection = {

src/services/slack.ts

@@ -21,4 +21,8 @@ export interface Locale {
   repository: string
 
   'exception.missing-description': string
+
+  description: string
+  required: string
+  example: string
 }