💄 Update Go struct comment.

Author: nkmr-jp

src/run.js

@@ -28,10 +28,11 @@ function run(urlStr, body, options) {
         cfg = loadConfig(url, cliOpts.config)
         path = buildPath(url, cliOpts.config)
 
-        if (cfg?.["docs"] !== undefined) console.log(`Docs:     ${cfg?.["docs"]}`)
-        if (path.path.pathFormat) console.log(`Format:   ${path.path.pathFormat}`)
-        console.log(`Request:  ${opts.method} ${url}`)
-        console.log(`Response: ${res.status} ${res.statusText}`)
+        console.log(`API Info:`)
+        if (cfg?.["docs"] !== undefined) console.log(`    Docs:     ${cfg?.["docs"]}`)
+        if (path.path.pathFormat) console.log(`    Format:   ${path.path.pathFormat}`)
+        console.log(`    Request:  ${opts.method} ${url}`)
+        console.log(`    Response: ${res.status} ${res.statusText}`)
 
         comment = buildComment(url, path, opts.method, res)
         return res.json()
@@ -56,7 +57,7 @@ function write(json, path, content) {
     if (err) throw err;
   });
   console.log()
-  console.log("Saved:")
+  console.log("Generated Files:")
   console.log(`    Struct:  ${path.goFilePath}`)
   console.log(`    Payload: ${path.jsonFilePath}`)
 }
@@ -92,30 +93,35 @@ function buildOpts(body, cliOpts) {
 }
 
 function buildContent(go, path, comment) {
-  let content = `// Code generated by api-to-go (https://github.com/nkmr-jp/api-to-go).\n\n`
+  let content = `// Generated Code But Editable.
+// Format The Code with \`go fmt\` or something and edit it manually to use it.
+//
+// Generated by: api-to-go (https://github.com/nkmr-jp/api-to-go).
+
+`
   content += `package ${path.pkg}\n\n`
   if (go.indexOf('time.') !== -1) {
     content += `${content}import "time"\n\n`
   }
-
-  content += `// ${go.split(" ")[1]} is the go struct of api's payload.\n//`
+  content += `// ${go.split(" ")[1]} represents the response body from an HTTP request.\n//`
   content += comment
   content += go
   return content
 }
 
 function buildComment(url, path, method, res) {
   let comment = ""
+  comment += `\n//\tStatus:  ${res.status} ${res.statusText}`
+  comment += `\n//\tRequest: ${method} ${url.href}`
+
   const cfg = loadConfig(url, cliOpts.config)
-  if (cfg?.["docs"] !== undefined) {
-    comment += `\n//  Docs:     ${cfg?.["docs"]}`
-  }
   if (path.path.pathFormat) {
-    comment += `\n//  Format:   ${path.path.pathFormat}`
+    comment += `\n//\tFormat:  ${path.path.pathFormat}`
+  }
+  if (cfg?.["docs"] !== undefined) {
+    comment += `\n//\tDocs:    ${cfg?.["docs"]}`
   }
-  comment += `\n//  Request:  ${method} ${url.href}`
-  comment += `\n//  Response: ${res.status} ${res.statusText}`
-  return `${comment}\n//\n`
+  return `${comment}\n`
 }
 
 module.exports = run;