✨ Update go struct comments that to be generated.

Author: nkmr-jp

src/buildContent.js

@@ -1,4 +1,4 @@
-const {loadYaml} = require("./util");
+const {loadYaml, loadConfig} = require("./common");
 
 function buildPath(url, configFile = "./.api-to-go.yml") {
   const path = _buildPath(url, configFile)
@@ -19,8 +19,7 @@ function buildPath(url, configFile = "./.api-to-go.yml") {
 }
 
 function _buildPath(url, configFile) {
-  const cfg = loadYaml(configFile)
-  const hostCfg = cfg?.[url.hostname]
+  const hostCfg = loadConfig(url, configFile)
   let ret ={
     pathname: url.pathname,
     pathFormat: null,

src/buildPath.js

@@ -46,4 +46,8 @@ exports.isYamlString = str => {
     return false;
   }
   return true;
-};
+};
+
+exports.loadConfig = (url, configFile) => {
+  return this.loadYaml(configFile)?.[url.hostname]
+}

src/util.js renamed to src/common.js

@@ -2,44 +2,70 @@ const fetch = require('node-fetch');
 const fs = require('fs');
 const jsonToGo = require('../vendor/json-to-go.js');
 const buildPath = require('./buildPath');
-const buildContent = require('./buildContent');
-const {loadJsonOrYaml, isJsonString} = require("./util");
+const {loadJsonOrYaml, isJsonString, loadConfig} = require("./common");
+
+
+let configFile = "./.api-to-go.yml"
+
+function run(urlStr, body, cliOpts) {
+  let comment
+  let url
+  let path
+  let cfg
 
-function run(url, body, cliOpts) {
-  const apiUrl = url.replace(/\/$/, '')
   let opts = {}
 
   try {
-    opts = _buildOpts(body, cliOpts)
+    opts = buildOpts(body, cliOpts)
   } catch (e) {
     console.log(e.message);
     return
   }
 
-  // See: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch
-  fetch(apiUrl, opts)
-    .then(res => {
-      console.log(`Status: ${res.status} ${res.statusText}`)
-      return res.json()
-    })
-    .then(json => {
-      const url = new URL(apiUrl);
-      const path = buildPath(url)
-      const res = jsonToGo(JSON.stringify(json), path.struct);
-      const content = buildContent(res.go, path, url)
-      fs.mkdirSync(path.dir, {recursive: true})
-      fs.writeFile(path.jsonFilePath, JSON.stringify(json, null, "\t"), (err) => {
-        if (err) throw err;
-        console.log(`Saved: ${path.jsonFilePath}`)
-      });
-      fs.writeFile(path.goFilePath, content, (err) => {
-        if (err) throw err;
-        console.log(`Generated: ${path.goFilePath}`)
-      });
-    });
+  try {
+    // See: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch
+    fetch(urlStr, opts)
+      .then(res => {
+        console.log()
+        const apiUrl = urlStr.replace(/\/$/, '')
+        url = new URL(apiUrl);
+        cfg = loadConfig(url, configFile)
+        if (cfg?.["docs"] !== undefined) {
+          console.log(`Docs: ${cfg?.["docs"]}`)
+        }
+        path = buildPath(url)
+        console.log(`Request: (${opts.method}) ${url}`)
+        console.log(`Response: ${res.status} ${res.statusText}`)
+
+        comment = buildComment(url, path, opts.method, res)
+        return res.json()
+      })
+      .then(json => {
+        const struct = jsonToGo(JSON.stringify(json), path.struct);
+        const content = buildContent(struct.go, path, comment)
+        write(json, path, content)
+      })
+    ;
+  } catch (e) {
+    console.log(e.message);
+  }
 }
 
-function _buildOpts(body, cliOpts) {
+function write(json, path, content) {
+  fs.mkdirSync(path.dir, {recursive: true})
+  fs.writeFile(path.jsonFilePath, JSON.stringify(json, null, "\t"), (err) => {
+    if (err) throw err;
+  });
+  fs.writeFile(path.goFilePath, content, (err) => {
+    if (err) throw err;
+  });
+  console.log()
+  console.log("Saved:")
+  console.log(`    ${path.jsonFilePath}`)
+  console.log(`    ${path.goFilePath}`)
+}
+
+function buildOpts(body, cliOpts) {
   const opts = {}
   if (cliOpts?.method) opts.method = cliOpts?.method
   if (cliOpts?.headers) {
@@ -65,7 +91,33 @@ function _buildOpts(body, cliOpts) {
       console.error()
     }
   }
+  if (!opts?.method) opts.method = "GET"
   return opts
 }
 
+function buildContent(struct, path, comment) {
+  let content = `// Code generated by api-to-go (https://github.com/nkmr-jp/api-to-go).\n\n`
+  content += `package ${path.pkg}\n\n`
+  if (struct.indexOf('time.') !== -1) {
+    content += `${content}import "time"\n\n`
+  }
+  content += comment
+  content += struct
+  return content
+}
+
+function buildComment(url, path, method, res) {
+  let comment = `// ${path.struct} is the go struct of api's payload.\n//`
+  const cfg = loadConfig(url, configFile)
+  if (cfg?.["docs"] !== undefined) {
+    comment += `\n//  Docs: ${cfg?.["docs"]}`
+  }
+  if (path.path.pathFormat) {
+    comment += `\n//  Format: ${path.path.pathFormat}`
+  }
+  comment += `\n//  Request: (${method}) ${url.href}`
+  comment += `\n//  Response: ${res.status} ${res.statusText}`
+  return `${comment}\n//\n`
+}
+
 module.exports = run;