feat: support --format=json options

Author: azu

.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "require": [
+    "ts-node-test-register"
+  ]
+}

README.md

@@ -16,7 +16,7 @@ Install with [npm](https://www.npmjs.com/):
       $ github-actions-badge
 
     Options
-      --format "markdown"
+      --format "markdown", "json"
 
     Examples
       # Copy GitHub Action as Markdown format

package.json

@@ -55,16 +55,16 @@
   },
   "devDependencies": {
     "@types/glob": "^7.1.1",
-    "@types/hosted-git-info": "^2.7.0",
+    "@types/hosted-git-info": "^3.0.0",
     "@types/js-yaml": "^3.12.1",
     "@types/meow": "^5.0.0",
-    "@types/mocha": "^5.2.7",
-    "@types/node": "^12.12.12",
-    "cross-env": "^6.0.3",
-    "husky": "^3.1.0",
-    "lint-staged": "^9.4.3",
-    "mocha": "^6.2.2",
-    "prettier": "^1.19.1",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^14.0.13",
+    "cross-env": "^7.0.2",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.11",
+    "mocha": "^8.0.1",
+    "prettier": "^2.0.5",
     "rimraf": "^3.0.0",
     "ts-node": "^8.5.2",
     "ts-node-test-register": "^8.0.1",
@@ -76,6 +76,6 @@
     "hosted-git-info": "^3.0.2",
     "js-yaml": "^3.13.1",
     "markdown-escape": "^1.1.0",
-    "meow": "^5.0.0"
+    "meow": "^7.0.1"
   }
 }

src/cli.ts

@@ -1,12 +1,12 @@
-const meow = require("meow");
+import meow from "meow";
 import { fetchRepositoryInfo, generate } from "./github-actions-badge";
 
 const cli = meow(`
     Usage
       $ github-actions-badge
  
     Options
-      --format "markdown"
+      --format "markdown", "json"
  
     Examples
       # Copy GitHub Action as Markdown format
@@ -24,6 +24,9 @@ const cli = meow(`
 export const run = async () => {
     const { repo, owner } = await fetchRepositoryInfo();
     const format = cli.flags.format || "markdown";
+    if (format !== "json" && format !== "markdown") {
+        throw new Error(`${format} is unknown format`);
+    }
     const cwd = process.cwd();
     return generate({ cwd, repo, owner, format });
 };

src/github-actions-badge.ts

@@ -11,7 +11,7 @@ export interface generateOptions {
     owner: string;
     repo: string;
     cwd: string;
-    format: "markdown"
+    format: "markdown" | "json"
 }
 
 export const fetchRepositoryInfo = (): Promise<{ owner: string; repo: string }> => {
@@ -39,15 +39,31 @@ export const generate = (options: generateOptions): string => {
     const ymlList = glob.sync(path.join(options.cwd, ".github/workflows/*"), {
         dot: true
     });
-    return ymlList.map(filePath => {
+    const items = ymlList.map(filePath => {
         const content = yaml.safeLoad(fs.readFileSync(filePath, "utf-8"));
         if (!content.name) {
             throw new Error(`${filePath} does not define name`);
         }
         return content.name;
     }).map(workflowName => {
-        // --format "markdown"
-        // https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_NAME>/badge.svg
-        return `[![Actions Status: ${encodeMarkdownTitle(workflowName)}](https://github.com/${options.owner}/${options.repo}/workflows/${encodeURIComponent(workflowName)}/badge.svg)](https://github.com/${options.owner}/${options.repo}/actions?query=workflow%3A"${encodeWorkflowNameQuery(workflowName)}")`;
-    }).join("\n");
+        // --format "json"
+        if (options.format === "json") {
+            return {
+                name: workflowName,
+                actionBadgeUrl: `https://github.com/${options.owner}/${options.repo}/workflows/${encodeURIComponent(workflowName)}/badge.svg`,
+                workflowUrl: `https://github.com/${options.owner}/${options.repo}/actions?query=workflow%3A"${encodeWorkflowNameQuery(workflowName)}`
+            };
+        } else if (options.format === "markdown") {
+            // --format "markdown"
+            // https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_NAME>/badge.svg
+            return `[![Actions Status: ${encodeMarkdownTitle(workflowName)}](https://github.com/${options.owner}/${options.repo}/workflows/${encodeURIComponent(workflowName)}/badge.svg)](https://github.com/${options.owner}/${options.repo}/actions?query=workflow%3A"${encodeWorkflowNameQuery(workflowName)}")`;
+        }
+        return;
+    });
+    if (options.format === "json") {
+        return JSON.stringify(items);
+    } else if (options.format === "markdown") {
+        return items.join("\n");
+    }
+    return "";
 };