✨ Add feature that to add comment to struct

Author: nkmr-jp

bin/api-to-go.js

@@ -9,28 +9,32 @@ function run(url) {
   fetch(apiUrl)
     .then(res => res.json())
     .then(json => {
-      const path = buildPath(apiUrl)
-      const res = jsonToGo(JSON.stringify(json), path.struct);
-      const content = _buildContent(res.go, path.pkg)
-      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}`)
-      });
+        const path = buildPath(apiUrl)
+        const res = jsonToGo(JSON.stringify(json), path.struct);
+        const content = _buildContent(res.go, path, apiUrl)
+        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}`)
+        });
       }
     );
 }
 
-function _buildContent(struct, packageName) {
-  let content = `package ${packageName}\n\n`
+function _buildContent(struct, path, apiUrl) {
+  let content = `package ${path.pkg}\n\n`
   if (struct.indexOf('time.') !== -1) {
     content = `${content}import "time"\n\n`
   }
-  content = `${content}${struct}`
+  let comment = `// ${path.struct} is struct of API's payload.\n`
+  comment += `// url: ${apiUrl}\n`
+  if (path.path.pathFormat) comment += `// format: ${path.path.pathFormat}\n`
+  comment += `// example: ${path.jsonFilePath}\n`
+  content = `${content}${comment}${struct}`
   return content
 }
 

src/buildPath.js

@@ -28,6 +28,7 @@ function _buildPath(url, configFile) {
     for (let i = 0; i < hostCfg.length; i++) {
       ret = _replacePath(url.pathname, hostCfg[i])
       if (ret) {
+        ret["Url"] = `${url.hostname}${ret.replacedPath}`
         ret["replacedUrl"] = `${url.hostname}${ret.replacedPath}`
         return ret
       }