dev: get ready for v1 (#133)

* dev: add reason sanitizer

* dev: sanitize newline out of reason

* dev: clean report text

* dev: add todo for adding closed issue test

Author: tianhaoz95

__tests__/octo.test.ts

@@ -52,6 +52,7 @@ describe("octo test suite", () => {
       .get(IssueScope).reply(200, [
         {
           number: 1,
+          state: "open",
           title: "test title",
         },
       ]);
@@ -72,8 +73,8 @@ describe("octo test suite", () => {
       .reply(200, { token: "test" });
     nock(GitHubEndpoint)
       .get(IssueScope).reply(200, [
-        { title: "test title 1", number: 0 },
-        { title: "test title 2", number: 1 },
+        { title: "test title 1", number: 0, state: "open" },
+        { title: "test title 2", number: 1, state: "open" },
       ]);
     return expect(octo.matchIssueTitle(
       "test title 1",
@@ -88,8 +89,8 @@ describe("octo test suite", () => {
       .reply(200, { token: "test" });
     nock(GitHubEndpoint)
       .get(IssueScope).reply(200, [
-        { title: "test title 1", number: 0 },
-        { title: "test title 2", number: 1 },
+        { title: "test title 1", number: 0, state: "open" },
+        { title: "test title 2", number: 1, state: "open" },
       ]);
     return expect(octo.matchIssueTitle(
       "test title 1",
@@ -107,8 +108,8 @@ describe("octo test suite", () => {
       .reply(200, { token: "test" });
     nock(GitHubEndpoint)
       .get(IssueScope).reply(200, [
-        { title: "test title 1", number: 0 },
-        { title: "test title 2", number: 1 },
+        { title: "test title 1", number: 0, state: "open" },
+        { title: "test title 2", number: 1, state: "open" },
       ]);
     return expect(octo.matchIssueTitle(
       "test title no match",
@@ -119,4 +120,6 @@ describe("octo test suite", () => {
       issueNumber: -1,
     });
   });
+
+  // TODO(tianhaoz95): add test for closed issues
 });

__tests__/report.test.ts

@@ -5,11 +5,20 @@ describe("Report test suite", () => {
     expect(() => {
       report.composeReportMetadataToParagraph({
         en: [
-          "test suggestion 1",
-          "test suggestion 2",
+          {
+            index: 10,
+            offset: 5,
+            reason: "test rocks!",
+          },
+          {
+            index: 20,
+            offset: 3,
+            reason: "ahhh I am hungry...",
+          },
         ],
         fileContent: "test full context",
         filename: "test filename",
+        relativePath: "test relative path",
       });
     }).not.toThrow();
   });
@@ -22,7 +31,7 @@ describe("Report test suite", () => {
       relativePath: "test relative path",
     });
     expect(reportContent).toContain("test relative path");
-    expect(reportContent).toContain("English Language Report");
+    expect(reportContent).toContain("Report for");
   });
 
   it("generate report lang entry", () => {

__tests__/util.test.ts

@@ -212,4 +212,14 @@ describe("Utility test suite", () => {
   it("test file ref parser block invalid ref", () => {
     expect(util.parseFileLinkRef("i/am/not/a/ref")).toBe("not supported");
   });
+
+  it("test reason sanitizer no crash", () => {
+    expect(() => {
+      util.sanitizeReason("this test\nhas newline");
+    }).not.toThrow();
+  });
+
+  it("test reason sanitizer replaces newline", () => {
+    expect(util.sanitizeReason("this test\nhas newline")).toBe("this test has newline");
+  });
 });

package-lock.json

@@ -29,7 +29,7 @@ export async function lintWorkspace() {
         reportsMetadata.push(reportEntry);
       }
     }
-    let finalReport = "final report";
+    let finalReport = "";
     for (const reportMetadata of reportsMetadata) {
       const reportEntry = report.composeReportMetadataToParagraph(reportMetadata);
       // TODO(tianhaoz95): let the compose take the responsibility of decisiding

src/lint.ts

@@ -24,7 +24,7 @@ export async function matchIssueTitle(
   });
   for (const issue of allIssues.data) {
     const issueTitle = issue.title;
-    if (title === issueTitle) {
+    if (title === issueTitle && issue.state === "open") {
       return {
         found: true,
         issueNumber: issue.number,

src/octo.ts

@@ -17,7 +17,7 @@ export function composeReportMetadataToParagraph(reportMetadata): string {
   const repo = util.getGitHubRepoId();
   const relativePath = reportMetadata.relativePath;
   for (const suggestion of reportMetadata.en) {
-    const suggestionContent = suggestion.reason;
+    const suggestionContent = util.sanitizeReason(suggestion.reason);
     const suggestionIndex = suggestion.index;
     const suggestionOffset = suggestion.offset;
     const fullText = reportMetadata.fileContent;

src/report.ts

@@ -224,3 +224,12 @@ export function sanitizeMarkdown(rawText) {
   sanitizedMarkdown = sanitizedMarkdown.replace(/\n/gi, "");
   return sanitizedMarkdown;
 }
+
+/**
+ * This function sanitizes the reason output
+ */
+export function sanitizeReason(rawReason: string): string {
+  let sanitizedReason = rawReason;
+  sanitizedReason = sanitizedReason.replace(/\n/ig, " ");
+  return sanitizedReason;
+}

src/util.ts

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

template/langReport.md

@@ -1,11 +1,2 @@
-<details>
-  <summary>Suggestion for snippet @ index:{{{index}}} & offset:{{{offset}}}</summary>
-
-...
-
-{{{snippet}}}
-
-...
-</details>
-
-> suggestion: {{{suggestion}}}
+Suggestion: {{{suggestion}}}
+> @ index:{{{index}}} & offset:{{{offset}}}