feat(reporting): add backlog issues report

Author: MikaelVallenet

reporting/output.go

@@ -19,69 +19,74 @@ func jsonFormat(data string) string {
 	return out.String()
 }
 
-func createOutputDir() error {
+func createOutputFile() (*os.File, error) {
 	if _, err := os.Stat(opts.outputPath); os.IsNotExist(err) {
 		err = os.MkdirAll(opts.outputPath, os.ModePerm)
 		if err != nil {
-			return err
+			return nil, err
 		}
 	}
-	return nil
-}
-
-func writeChangelog(data string) error {
-	err := createOutputDir()
+	outputFile, err := os.Create(opts.outputPath + "report.md")
 	if err != nil {
-		return err
+		return nil, err
 	}
+	return outputFile, nil
+}
+
+func writeChangelog(data string, outputFile *os.File) error {
 	if opts.format == "json" {
 		data = jsonFormat(data)
 	}
-	err = os.WriteFile(opts.outputPath+"changelog.json", []byte(data), 0644)
+	_, err := outputFile.WriteString(data)
 	if err != nil {
 		return err
 	}
 	return nil
 }
 
-func writeBacklog(data string) error {
-	err := createOutputDir()
-	if err != nil {
-		return err
-	}
-	if opts.format == "json" {
-		data = jsonFormat(data)
+func writeBacklog(issues []*github.Issue, outputFile *os.File) error {
+	var issuesTable [][]string
+	for _, issue := range issues {
+		issuesTable = append(issuesTable, []string{issue.GetTitle(), issue.GetURL(), issue.GetUser().GetLogin()})
 	}
-	err = os.WriteFile(opts.outputPath+"backlog.json", []byte(data), 0644)
+
+	markdownTable, err := markdown.NewTableFormatterBuilder().
+		Build("Title", "Link to Body", "Assignee").
+		Format(issuesTable)
 	if err != nil {
 		return err
 	}
-	return nil
-}
+	result := fmt.Sprintf("# Backlog\n\nThere is **%d new open issues** in gnolang/gno since %s\n\n%s", len(issues), opts.since, markdownTable)
 
-func writeCuration(issues []*github.Issue) error {
-	err := createOutputDir()
+	_, err = outputFile.WriteString(result)
 	if err != nil {
 		return err
 	}
+	return nil
+}
 
+func writeCuration(issues []*github.Issue, outputFile *os.File) error {
 	var issuesTable [][]string
 	for _, issue := range issues {
-		issuesTable = append(issuesTable, []string{fmt.Sprintf("%d", *issue.Number), *issue.Title, *issue.HTMLURL})
+		issuesTable = append(issuesTable, []string{issue.GetTitle(), issue.GetURL(), issue.GetUser().GetLogin()})
 	}
-	err = os.WriteFile(opts.outputPath+"curation.json", []byte("data"), 0644)
+
+	markdownTable, err := markdown.NewTableFormatterBuilder().
+		Build("Title", "Link to Body", "Assignee").
+		Format(issuesTable)
 	if err != nil {
 		return err
 	}
-	return nil
-}
+	result := fmt.Sprintf("# Curation\n\nThere is **%d new issues** in gnolang/awesome-gno since %s\n\n%s", len(issues), opts.since, markdownTable)
 
-func writeTips(data string) error {
-	err := createOutputDir()
+	_, err = outputFile.WriteString(result)
 	if err != nil {
 		return err
 	}
+	return nil
+}
 
+func writeTips(data string, outputFile *os.File) error {
 	// Format at Markdown format
 	var table [][]string
 	var tweets TweetSearch
@@ -92,7 +97,7 @@ func writeTips(data string) error {
 		authors[user.Id] = user.Username
 	}
 	for _, tweet := range tweets.Data {
-		table = append(table, []string{authors[tweet.AuthorId], strings.Replace(tweet.Text, "\n", "", -1), tweet.CreatedAt})
+		table = append(table, []string{authors[tweet.AuthorId], strings.Replace(tweet.Text, "\n", " ", -1), tweet.CreatedAt})
 	}
 
 	//Maybe build our own table formatter
@@ -102,9 +107,9 @@ func writeTips(data string) error {
 	if err != nil {
 		return err
 	}
-	result := fmt.Sprintf("# Tips\n\nThere is **%d new tweet** about gno since %s\n\n%s", tweets.Meta.ResultCount, opts.since, markdownTable)
+	result := fmt.Sprintf("# Tips\n\nThere is **%d new tweet** about gnotips since %s\n\n%s", tweets.Meta.ResultCount, opts.since, markdownTable)
 
-	err = os.WriteFile(opts.outputPath+"report.md", []byte(result), 0644)
+	_, err = outputFile.WriteString(result)
 	if err != nil {
 		return err
 	}

reporting/reporting.go

@@ -84,19 +84,20 @@ func runMain(args []string) error {
 					}
 				}
 				githubClient := initGithubClient()
-				err = fetchChangelog(githubClient, since)
+				outputFile, err := createOutputFile()
+				err = fetchChangelog(githubClient, since, outputFile)
 				if err != nil {
 					return err
 				}
-				err = fetchBacklog(githubClient, since)
+				err = fetchBacklog(githubClient, since, outputFile)
 				if err != nil {
 					return err
 				}
-				err = fetchCuration(githubClient, since)
+				err = fetchCuration(githubClient, since, outputFile)
 				if err != nil {
 					return err
 				}
-				err = fetchTips()
+				err = fetchTips(outputFile)
 				if err != nil {
 					return err
 				}
@@ -108,7 +109,7 @@ func runMain(args []string) error {
 }
 
 // TODO: Fetch changelog recent contributors, new PR merged, new issues closed ...
-func fetchChangelog(client *github.Client, since time.Time) error {
+func fetchChangelog(client *github.Client, since time.Time, outputFile *os.File) error {
 	if !opts.changelog {
 		return nil
 	}
@@ -125,43 +126,43 @@ func fetchChangelog(client *github.Client, since time.Time) error {
 }
 
 // TODO: Fetch backlog from github issues & PRS ...
-func fetchBacklog(client *github.Client, since time.Time) error {
-	if !opts.backlog {
+func fetchBacklog(client *github.Client, since time.Time, outputFile *os.File) error {
+	if !opts.curation {
 		return nil
 	}
 	issues, err := githubFetchIssues(client, &github.IssueListByRepoOptions{State: "open", Since: since}, "gnolang", "gno")
 	if err != nil {
 		return err
 	}
-	_, err = json.Marshal(issues)
+	err = writeBacklog(issues, outputFile)
 	if err != nil {
 		return err
 	}
 	return nil
 }
 
 // TODO: Fetch curation from github commits & issues & PRS in `awesome-gno` repo
-func fetchCuration(client *github.Client, since time.Time) error {
+func fetchCuration(client *github.Client, since time.Time, outputFile *os.File) error {
 	if !opts.curation {
 		return nil
 	}
 	issues, err := githubFetchIssues(client, &github.IssueListByRepoOptions{State: "all", Since: since}, "gnolang", "awesome-gno")
 	if err != nil {
 		return err
 	}
-	_, err = json.Marshal(issues)
+	err = writeCuration(issues, outputFile)
 	if err != nil {
 		return err
 	}
 	return nil
 }
 
-func fetchTips() error {
+func fetchTips(outputFile *os.File) error {
 	if !opts.tips {
 		return nil
 	}
 	ret := twitterFetchTips()
-	err := writeTips(ret)
+	err := writeTips(ret, outputFile)
 	if err != nil {
 		return err
 	}