fix: add env variable for controls the limit of suggestions (#2403)

* feat: added env variable to control the limit of suggestions in lint

Author: kanoru3101

.changeset/clever-hoops-speak.md

@@ -0,0 +1,5 @@
+---
+"@redocly/openapi-core": minor
+---
+
+Added `REDOCLY_CLI_LINT_MAX_SUGGESTIONS` environment variable to limit displayed suggestions (default: 5).

docs/@v2/commands/lint.md

@@ -333,6 +333,16 @@ If the number of detected problems exceeds the specified threshold, the remainin
 
 Note that the default value is `100`.
 
+### Limit the displayed suggestions count
+
+When lint errors include suggestions (such as "Did you mean: propertyName?"), you can control how many suggestions are displayed using the `REDOCLY_CLI_LINT_MAX_SUGGESTIONS` environment variable.
+
+```bash
+REDOCLY_CLI_LINT_MAX_SUGGESTIONS=10 redocly lint openapi.yaml
+```
+
+The default value is `5`. This is useful when working with rules that provide many suggestions (like typo corrections for property names), allowing you to see more or fewer alternatives as needed.
+
 ### Generate ignore file
 
 With this option, you can generate the `.redocly.lint-ignore.yaml` file to suppress error and warning severity problems in the output.

packages/core/src/__tests__/format.test.ts

@@ -144,4 +144,73 @@ describe('format', () => {
       "
     `);
   });
+
+  it('should format problems with suggestions in github-actions format', () => {
+    const problems = [
+      {
+        ruleId: 'invalid-property',
+        message: 'Property is invalid',
+        severity: 'error' as const,
+        location: [
+          {
+            source: { absoluteRef: 'openapi.yaml' } as Source,
+            start: { line: 5, col: 10 },
+            end: { line: 5, col: 20 },
+          } as LocationObject,
+        ],
+        suggest: ['validProperty', 'anotherValidProperty', 'oneMoreProperty'],
+      },
+    ];
+
+    formatProblems(problems, {
+      format: 'github-actions',
+      version: '1.0.0',
+      totals: getTotals(problems),
+    });
+
+    expect(output).toMatchInlineSnapshot(`
+      "::error title=invalid-property,file=openapi.yaml,line=5,col=10,endLine=5,endColumn=20::Property is invalid%0A%0ADid you mean:%0A  - validProperty%0A  - anotherValidProperty%0A  - oneMoreProperty%0A%0A
+      "
+    `);
+  });
+
+  it('should limit suggestions based on REDOCLY_CLI_LINT_MAX_SUGGESTIONS constant', () => {
+    const problems: NormalizedProblem[] = [
+      {
+        ruleId: 'test-rule',
+        message: 'Test message',
+        severity: 'error' as const,
+        location: [
+          {
+            source: { absoluteRef: 'test.yaml' } as Source,
+            start: { line: 1, col: 1 },
+            end: { line: 1, col: 10 },
+          } as LocationObject,
+        ],
+        suggest: [
+          'suggestion1',
+          'suggestion2',
+          'suggestion3',
+          'suggestion4',
+          'suggestion5',
+          'suggestion6',
+          'suggestion7',
+          'suggestion8',
+          'suggestion9',
+          'suggestion10',
+        ],
+      },
+    ];
+
+    formatProblems(problems, {
+      format: 'github-actions',
+      version: '1.0.0',
+      totals: getTotals(problems),
+    });
+
+    expect(output).toMatchInlineSnapshot(`
+      "::error title=test-rule,file=test.yaml,line=1,col=1,endLine=1,endColumn=10::Test message%0A%0ADid you mean:%0A  - suggestion1%0A  - suggestion2%0A  - suggestion3%0A  - suggestion4%0A  - suggestion5%0A%0A
+      "
+    `);
+  });
 });

packages/core/src/format/format.ts

@@ -41,7 +41,7 @@ const CODECLIMATE_SEVERITY_MAPPING = {
   warn: 'minor',
 };
 
-const MAX_SUGGEST = 5;
+const MAX_SUGGEST = +(env.REDOCLY_CLI_LINT_MAX_SUGGESTIONS ?? 5);
 
 function severityToNumber(severity: ProblemSeverity) {
   return severity === 'error' ? 1 : 2;