feat: Use gfm mode (#54)

* Use `gfm` mode by default * Add tests
yusukebe · Jul 30, 2024 · dd62f13 · dd62f13
1 parent 4864d65
commit dd62f13
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 4 deletions.
diff --git a/cmd/app.go b/cmd/app.go
@@ -44,7 +44,7 @@ func findReadme(dir string) (string, error) {
 }
 
 func toHTML(markdown string) (string, error) {
-	sout, _, err := gh("api", "-X", "POST", "/markdown", "-f", fmt.Sprintf("text=%s", markdown))
+	sout, _, err := gh("api", "-X", "POST", "/markdown", "-f", fmt.Sprintf("text=%s", markdown), "-f", "mode=gfm")
 	if err != nil {
 		return "", err
 	}

diff --git a/cmd/app_test.go b/cmd/app_test.go
@@ -85,3 +85,54 @@ func TestToHTML(t *testing.T) {
 		t.Errorf("got %v\n want %v", actual, expected)
 	}
 }
+
+func TestGfmCheckboxes(t *testing.T) {
+	string, err := slurp("../testdata/gfm-checkboxes.md")
+	if err != nil {
+		t.Errorf(err.Error())
+	}
+	html, err := toHTML(string)
+	if err != nil {
+		t.Errorf(err.Error())
+	}
+	actual := strings.TrimSpace(html)
+
+	checkBoxes := 0
+	checkedCheckBoxes := 0
+	uncheckedCheckBoxes := 0
+	for _, line := range strings.Split(actual, "\n") {
+		if strings.Contains(line, "<input type=\"checkbox\"") {
+			checkBoxes++
+			if strings.Contains(line, "checked") {
+				checkedCheckBoxes++
+			} else {
+				uncheckedCheckBoxes++
+			}
+		}
+	}
+	if checkBoxes != 2 {
+		t.Errorf("got %v checkboxes, want 2", checkBoxes)
+	}
+	if checkedCheckBoxes != 1 {
+		t.Errorf("got %v checked checkboxes, want 1", checkedCheckBoxes)
+	}
+	if uncheckedCheckBoxes != 1 {
+		t.Errorf("got %v unchecked checkboxes, want 1", uncheckedCheckBoxes)
+	}
+}
+
+func TestGfmAlerts(t *testing.T) {
+	string, err := slurp("../testdata/gfm-alerts.md")
+	if err != nil {
+		t.Errorf(err.Error())
+	}
+	html, err := toHTML(string)
+	if err != nil {
+		t.Errorf(err.Error())
+	}
+	actual := strings.TrimSpace(html)
+
+	if strings.Contains(actual, "<blockquote") {
+		t.Error("got blockquote tag instead of alerts")
+	}
+}
diff --git a/cmd/template.html b/cmd/template.html
@@ -4,11 +4,11 @@
     <title>{{ .Title }}</title>
     <link rel="icon" type="image/svg+xml" href="https://github.githubassets.com/favicons/favicon.svg">
     {{ $cssURL :=
-    "https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.0.0/github-markdown.min.css" }} {{
+    "https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.6.1/github-markdown.min.css" }} {{
     if eq .Mode "dark" }} {{ $cssURL =
-    "https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.0.0/github-markdown-dark.min.css"
+    "https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.6.1/github-markdown-dark.min.css"
     }} {{ else if eq .Mode "light" }} {{ $cssURL =
-    "https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.0.0/github-markdown-light.min.css"
+    "https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/5.6.1/github-markdown-light.min.css"
     }}{{ end }}
     <link rel="stylesheet" href="{{ $cssURL }}" />
     <style>

diff --git a/testdata/gfm-alerts.md b/testdata/gfm-alerts.md
@@ -0,0 +1,14 @@
+> [!NOTE]
+> Useful information that users should know, even when skimming content.
+
+> [!TIP]
+> Helpful advice for doing things better or more easily.
+
+> [!IMPORTANT]
+> Key information users need to know to achieve their goal.
+
+> [!WARNING]
+> Urgent info that needs immediate user attention to avoid problems.
+
+> [!CAUTION]
+> Advises about risks or negative outcomes of certain actions.
diff --git a/testdata/gfm-checkboxes.md b/testdata/gfm-checkboxes.md
@@ -0,0 +1,2 @@
+- [ ] Not done
+- [x] Done