feat: add suggestions-limit input

Teams can use this to avoid PRs with many, many suggestion comments
dumped when opened which is a bad experience.

Next we'll implement an output for known when suggestions were skipped,
so teams can take some other action, such as opening a sibling PR.

Author: pbrisbin

Diff for: run/action.yml

@@ -13,6 +13,9 @@ inputs:
   suggestions:
     description: "Add suggestion comments of restyled changes"
     default: false
+  suggestion-limit:
+    description: "Limit the number of suggestion comments left"
+    required: false
   show-patch:
     description: "Log the patch produced by Restyled with git format-patch"
     default: true

Diff for: run/src/inputs.ts

@@ -20,6 +20,7 @@ export type Inputs = {
   paths: string[];
   githubToken: string;
   suggestions: boolean;
+  suggestionsLimit: number | null;
   showPatch: boolean;
   showPatchCommand: boolean;
   committerEmail: string;
@@ -44,12 +45,20 @@ export function getInputs(): Inputs {
     }
   }
 
+  const rawSuggestionLimit = core.getInput("suggestion-limit", {
+    required: false,
+  });
+
   return {
     paths,
     githubToken: core.getInput("github-token", { required: true }),
     suggestions: core.getBooleanInput("suggestions", {
       required: true,
     }),
+    suggestionsLimit:
+      rawSuggestionLimit && rawSuggestionLimit !== ""
+        ? parseInt(rawSuggestionLimit, 10)
+        : null,
     showPatch: core.getBooleanInput("show-patch", {
       required: true,
     }),

Diff for: run/src/main.ts

@@ -106,13 +106,20 @@ async function run() {
 
         let n = 0;
         const ps = suggestions.map((s) => {
-          if (s.skipReason) {
+          const limitSkipReason =
+            inputs.suggestionsLimit && n >= inputs.suggestionsLimit
+              ? "limit reached"
+              : null;
+
+          const skipReason = s.skipReason ?? limitSkipReason;
+
+          if (skipReason) {
             const line =
               s.startLine !== s.endLine
                 ? `${s.startLine}-${s.endLine}`
                 : `${s.startLine}`;
             const location = `${s.path}:${line}`;
-            core.warning(`[${location}]: Skipping suggestion: ${s.skipReason}`);
+            core.warning(`[${location}]: Skipping suggestion: ${skipReason}`);
             return Promise.resolve();
           } else {
             n += 1;