dev: move file link a level up (#128)

* dev: init link to file template

* dev: add file link to lvl up

* dev: add relative file path

* dev: fix test

Author: tianhaoz95

__tests__/report.test.ts

@@ -19,8 +19,9 @@ describe("Report test suite", () => {
       en: [],
       fileContent: "test full context",
       filename: "test filename",
+      relativePath: "test relative path",
     });
-    expect(reportContent).toContain("test filename");
+    expect(reportContent).toContain("test relative path");
     expect(reportContent).toContain("English Language Report");
   });
 

package-lock.json

@@ -10,6 +10,7 @@ import * as util from "./util";
 export function composeReportMetadataToParagraph(reportMetadata): string {
   let reportContent = "";
   const reportTemplate = util.loadTemplate("langReport");
+  const fileLinkTemplate = util.loadTemplate("linkToFile");
   const suggestionTemplate = util.loadTemplate("langSuggestion");
   const filename = reportMetadata.filename;
   const owner = util.getGitHubRepoOwner();
@@ -30,20 +31,23 @@ export function composeReportMetadataToParagraph(reportMetadata): string {
     const suggestionRenderContent = {
       index: suggestionIndex,
       offset: suggestionOffset,
-      owner,
-      path: relativePath,
-      ref: "master", /** TODO(tianhao95): get this programmatically */
-      repo,
       snippet: snippetContent,
       suggestion: suggestionContent,
     };
     const suggestionEntryContent = mustache.render(suggestionTemplate, suggestionRenderContent);
     reportContent += suggestionEntryContent;
     reportContent += "\n\n";
   }
+  const link = mustache.render(fileLinkTemplate, {
+    owner,
+    path: relativePath,
+    ref: "master", /** TODO(tianhao95): get this programmatically */
+    repo,
+  });
   const finalReport = mustache.render(reportTemplate, {
     content: reportContent,
-    filename,
+    filename: relativePath,
+    link,
   });
   return finalReport;
 }

src/report.ts

@@ -220,6 +220,7 @@ export function loadTemplate(template: string) {
  */
 export function sanitizeMarkdown(rawText) {
   /** Clean out unicode */
-  const sanitizedMarkdown = rawText.replace(/`/gi, "`");
+  let sanitizedMarkdown = rawText.replace(/`/gi, "`");
+  sanitizedMarkdown = sanitizedMarkdown.replace(/\n/gi, "");
   return sanitizedMarkdown;
 }

src/util.ts

@@ -1,8 +1,10 @@
 <details>
   <summary>
-    English Language Report for {{{filename}}}
+    English Language Report for <code>{{{filename}}}</code>
   </summary>
 
+{{{link}}}
+
 {{{content}}}
 
 </details>

template/langReport.md

@@ -1,8 +1,6 @@
 <details>
   <summary>Suggestion for snippet @ index:{{{index}}} & offset:{{{offset}}}</summary>
 
-[go to file](https://github.com/{{{owner}}}/{{{repo}}}/blob/{{{ref}}}/{{{path}}})
-
 ...
 
 {{{snippet}}}

template/langSuggestion.md

@@ -0,0 +1 @@
+[go to file](https://github.com/{{{owner}}}/{{{repo}}}/blob/{{{ref}}}/{{{path}}})