test(cli): add GitHub Actions formatter (#2508)

stoplightio · Jul 26, 2023 · a1e94a6 · a1e94a6
1 parent 6904927
commit a1e94a6
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/packages/cli/src/services/config.ts b/packages/cli/src/services/config.ts
@@ -11,6 +11,7 @@ export enum OutputFormat {
   TEXT = 'text',
   TEAMCITY = 'teamcity',
   PRETTY = 'pretty',
+  GITHUB_ACTIONS = 'github-actions',
 }
 
 export interface ILintConfig {

diff --git a/packages/cli/src/services/output.ts b/packages/cli/src/services/output.ts
@@ -1,7 +1,7 @@
 import * as process from 'process';
 import { IRuleResult } from '@stoplight/spectral-core';
 import { promises as fs } from 'fs';
-import { html, json, junit, stylish, teamcity, text, pretty } from '@stoplight/spectral-formatters';
+import { html, json, junit, stylish, teamcity, text, pretty, githubActions } from '@stoplight/spectral-formatters';
 import type { Formatter, FormatterOptions } from '@stoplight/spectral-formatters';
 import type { OutputFormat } from './config';
 
@@ -13,6 +13,7 @@ const formatters: Record<OutputFormat, Formatter> = {
   html,
   text,
   teamcity,
+  'github-actions': githubActions,
 };
 
 export function formatOutput(results: IRuleResult[], format: OutputFormat, formatOptions: FormatterOptions): string {

diff --git a/test-harness/scenarios/help-no-document.scenario b/test-harness/scenarios/help-no-document.scenario
@@ -20,7 +20,7 @@ Options:
       --version                  Show version number  [boolean]
       --help                     Show help  [boolean]
   -e, --encoding                 text encoding to use  [string] [choices: "utf8", "ascii", "utf-8", "utf16le", "ucs2", "ucs-2", "base64", "latin1"] [default: "utf8"]
-  -f, --format                   formatters to use for outputting results, more than one can be given joining them with a comma  [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty"] [default: "stylish"]
+  -f, --format                   formatters to use for outputting results, more than one can be given joining them with a comma  [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty", "github-actions"] [default: "stylish"]
   -o, --output                   where to output results, can be a single file name, multiple "output.<format>" or missing to print to stdout  [string]
       --stdin-filepath           path to a file to pretend that stdin comes from  [string]
       --resolver                 path to custom json-ref-resolver instance  [string]

diff --git a/test-harness/scenarios/strict-options.scenario b/test-harness/scenarios/strict-options.scenario
@@ -20,7 +20,7 @@ Options:
       --version                  Show version number  [boolean]
       --help                     Show help  [boolean]
   -e, --encoding                 text encoding to use  [string] [choices: "utf8", "ascii", "utf-8", "utf16le", "ucs2", "ucs-2", "base64", "latin1"] [default: "utf8"]
-  -f, --format                   formatters to use for outputting results, more than one can be given joining them with a comma  [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty"] [default: "stylish"]
+  -f, --format                   formatters to use for outputting results, more than one can be given joining them with a comma  [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty", "github-actions"] [default: "stylish"]
   -o, --output                   where to output results, can be a single file name, multiple "output.<format>" or missing to print to stdout  [string]
       --stdin-filepath           path to a file to pretend that stdin comes from  [string]
       --resolver                 path to custom json-ref-resolver instance  [string]