📝 Update Comments

Author: nkmr-jp

bin/api-to-go.js

@@ -11,7 +11,7 @@ program
   .description(packageJson.description)
   .argument('<url>', 'URL (required)')
   .argument('[body]', 'HTTP request body. specify by json string or file(json|yml).')
-  .option('-H, --headers <string|file>', 'http request headers. specify by json string or file(json|yml).')
+  .option('-H, --headers <string>', 'http request headers. specify by json string or file(json|yml).')
   .option('-X, --method <string>', 'specify request method to use.')
   .option('-D, --debug', 'enable debug mode')
   .action(run)

src/buildContent.js

@@ -1,18 +1,27 @@
-function buildContent(struct, path, url) {
+const {loadYaml} = require("./util");
+
+function buildContent(struct, path, url, configFile = "./.api-to-go.yml") {
   let content = `package ${path.pkg}\n\n`
   if (struct.indexOf('time.') !== -1) {
     content = `${content}import "time"\n\n`
   }
-  let comment = `// ${path.struct} is the go struct of api's payload.`
-  if (path.path.pathFormat) {
-    comment += `\n//\n// url: ${url.origin}${path.path.pathFormat}`
-    comment += `\n// example: ${url.href}`
-  } else {
-    comment += `\n//\n// url: ${url.href}`
-  }
+  const comment = _buildComment(path, url, configFile)
   content = `${content}${comment}\n//\n${struct}`
   return content
 }
 
+function _buildComment(path, url, configFile) {
+  const cfg = loadYaml(configFile)?.[url.hostname]
+  let comment = `// ${path.struct} is the go struct of api's payload.\n//`
+  if (path.path.pathFormat) {
+    comment += `\n//  Format: ${path.path.pathFormat}`
+  }
+  comment += `\n//  URL: ${url.href}`
+  if (cfg?.["docs"] !== undefined) {
+    comment += `\n//  Docs: ${cfg?.["docs"]}`
+  }
+  return comment
+}
+
 
 module.exports = buildContent;

src/buildPath.js

@@ -62,7 +62,7 @@ function _replacePath(pathname, format) {
   if (replacedArr.length === 0) return
 
   const replacedPath = replacedArr.join("/")
-  console.log(`format:    ${format}`)
+  console.log(`Format: ${format}`)
   return {
     pathname: pathname,
     pathFormat: format,

src/buildPath.test.js

@@ -16,7 +16,7 @@ test('build path', () => {
   }
   const received = buildPath(
     new URL("https://api.github.com/users/github/repos"),
-    "./.api-to-go.test.yaml"
+    "./.api-to-go.test.yml"
   )
   expect(received).toEqual(expected);
 });
@@ -30,7 +30,7 @@ test('build path without format setting', () => {
   }
   const received = buildPath(
     new URL("https://api.github.com/organizations"),
-    "./.api-to-go.test.yaml"
+    "./.api-to-go.test.yml"
   )
   expect(received.path).toEqual(expected);
 });

src/run.js

@@ -6,9 +6,6 @@ const buildContent = require('./buildContent');
 const {loadJsonOrYaml, isJsonString} = require("./util");
 
 function run(url, body, cliOpts) {
-  if (cliOpts?.verbose) {
-    console.log("url: " + url)
-  }
   const apiUrl = url.replace(/\/$/, '')
   let opts = {}
 
@@ -22,7 +19,7 @@ function run(url, body, cliOpts) {
   // 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}`)
+      console.log(`Status: ${res.status} ${res.statusText}`)
       return res.json()
     })
     .then(json => {
@@ -33,11 +30,11 @@ function run(url, body, cliOpts) {
       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}`)
+        console.log(`Saved: ${path.jsonFilePath}`)
       });
       fs.writeFile(path.goFilePath, content, (err) => {
         if (err) throw err;
-        console.log(`generated: ${path.goFilePath}`)
+        console.log(`Generated: ${path.goFilePath}`)
       });
     });
 }