feat: Redesign review commenting as upload of JSON artifact

__tests__/suggestions.test.ts

@@ -43,6 +43,12 @@ const VIOLATION_2184_SUGGESTION: PatchSuggestion = {
 \`\`\``
 };
 
+const PATCH_SUGGESTIONS = [
+  VIOLATION_1118_SUGGESTION,
+  VIOLATION_1854_SUGGESTION,
+  VIOLATION_2184_SUGGESTION
+];
+
 jest.setTimeout(20 * 1000);
 
 /**
@@ -150,6 +156,45 @@ async function testGeneratePatchSuggestions(
   expect(patchSuggestions).toEqual(expectedSuggestions);
 }
 
+test('toCommentsJSON produces JSON output containing all suggestions', async () => {
+  const jsonOutput = await suggestions.toCommentsJSON(PATCH_SUGGESTIONS);
+
+  for (const ps of PATCH_SUGGESTIONS) {
+    const encodedSuggestion = ps.suggestion.replace(/\n/g, '\\n');
+    expect(jsonOutput).toContain(encodedSuggestion);
+  }
+});
+
+test('toCommentsJSON produces JSON output containing all violation specifiers', async () => {
+  const jsonOutput = await suggestions.toCommentsJSON(PATCH_SUGGESTIONS);
+
+  for (const ps of PATCH_SUGGESTIONS) {
+    expect(jsonOutput).toContain(ps.violationSpec);
+  }
+});
+
+test('toCommentsJSON does not include start_line when linesToReplace range is single line', async () => {
+  const singleLinePatchSuggestion = {
+    ...VIOLATION_1118_SUGGESTION
+  };
+  singleLinePatchSuggestion.linesToReplace = {start: 1, end: 2}; // note: exclusive at end
+
+  const jsonOutput = await suggestions.toCommentsJSON([singleLinePatchSuggestion]);
+
+  expect(jsonOutput).not.toContain('start_line');
+});
+
+test('toCommentsJSON includes start_line when linesToReplace range is multiple lines', async () => {
+  const multiLinePatchSuggestion = {
+    ...VIOLATION_1118_SUGGESTION
+  };
+  multiLinePatchSuggestion.linesToReplace = {start: 1, end: 20};
+
+  const jsonOutput = await suggestions.toCommentsJSON([multiLinePatchSuggestion]);
+
+  expect(jsonOutput).toContain('start_line');
+});
+
 /**
  * Setup a Git repository with the given resources committed.
  */

action.yml

@@ -8,9 +8,10 @@ inputs:
   ratchet-from:
     description: 'Commit-ish to ratchet from, typically origin/master or origin/main)'
     required: false
-  suggestions-token:
-    description: 'Token to post pull request review comments with. If provided, repairs are posted as suggestions on the pull request.'
+  post-review-comments:
+    description: 'If true and the commenter bot is installed, repairs are posted as review comments on pull requests'
     required: false
+    default: false
 runs:
   using: 'node12'
   main: 'dist/index.js'