Add additional formatter support to the validate subcommand

Author: sekikn

src/domains/services/validation.service.ts

@@ -12,7 +12,9 @@ import { OpenAPISchemaParser } from '@asyncapi/openapi-schema-parser';
 import { DiagnosticSeverity, Parser } from '@asyncapi/parser/cjs';
 import { RamlDTSchemaParser } from '@asyncapi/raml-dt-schema-parser';
 import { ProtoBuffSchemaParser } from '@asyncapi/protobuf-schema-parser';
-import { getDiagnosticSeverity } from '@stoplight/spectral-core';
+import { OutputFormat } from '@stoplight/spectral-cli/dist/services/config';
+import { version } from '@stoplight/spectral-cli/package.json';
+import { getDiagnosticSeverity, Ruleset } from '@stoplight/spectral-core';
 import {
   html,
   json,
@@ -21,6 +23,10 @@ import {
   stylish,
   teamcity,
   text,
+  githubActions,
+  sarif,
+  codeClimate,
+  markdown
 } from '@stoplight/spectral-formatters';
 import chalk from 'chalk';
 import { promises } from 'fs';
@@ -187,6 +193,11 @@ const formatExtensions: Record<DiagnosticsFormat, string> = {
   text: '.txt',
   teamcity: '.txt',
   pretty: '.txt',
+  'github-actions': '.txt',
+  sarif: '.json',
+  'code-climate': '.json',
+  gitlab: '.json',
+  markdown: '.md',
 };
 
 const validFormats = [
@@ -197,13 +208,18 @@ const validFormats = [
   'text',
   'teamcity',
   'pretty',
+  'github-actions',
+  'sarif',
+  'code-climate',
+  'gitlab',
+  'markdown',
 ];
 
 export class ValidationService extends BaseService {
   private parser: Parser;
 
   constructor(parserOptions: ParserOptions = {}) {
-    super(); 
+    super();
     // Create parser with custom GitHub resolver
     const customParserOptions = {
       ...parserOptions,
@@ -498,22 +514,31 @@ export class ValidationService extends BaseService {
     };
 
     switch (format) {
-    case 'stylish':
+    case OutputFormat.STYLISH:
       return this.formatStylish(diagnostics, options);
-    case 'json':
+    case OutputFormat.JSON:
       return json(diagnostics, options);
-    case 'junit':
+    case OutputFormat.JUNIT:
       return junit(diagnostics, options);
-    case 'html':
+    case OutputFormat.HTML:
       return html(diagnostics, options);
-    case 'text':
+    case OutputFormat.TEXT:
       return text(diagnostics, options);
-    case 'teamcity':
+    case OutputFormat.TEAMCITY:
       return teamcity(diagnostics, options);
-    case 'pretty':
+    case OutputFormat.PRETTY:
       return pretty(diagnostics, options);
+    case OutputFormat.GITHUB_ACTIONS:
+      return githubActions(diagnostics, options);
+    case OutputFormat.SARIF:
+      return sarif(diagnostics, options, { ruleset: new Ruleset({rules: {}}), spectralVersion: version });
+    case OutputFormat.CODE_CLIMATE:
+    case OutputFormat.GITLAB:
+      return codeClimate(diagnostics, options);
+    case OutputFormat.MARKDOWN:
+      return markdown(diagnostics, options);
     default:
-      return stylish(diagnostics, options);
+      return this.formatStylish(diagnostics, options);
     }
   }
 

src/interfaces/index.ts

@@ -11,7 +11,13 @@ export type DiagnosticsFormat =
   | 'html'
   | 'text'
   | 'teamcity'
-  | 'pretty';
+  | 'pretty'
+  | 'github-actions'
+  | 'sarif'
+  | 'code-climate'
+  | 'gitlab'
+  | 'markdown'
+  ;
 
 /**
  * Severity levels for validation diagnostics.

test/unit/services/validation.service.test.ts

@@ -104,7 +104,7 @@ describe('ValidationService', () => {
         expect(result.data).to.have.property('status');
         expect(result.data).to.have.property('diagnostics');
         expect(result.data?.diagnostics).to.be.an('array');
-        
+
         // Should have diagnostics for missing required fields
         if (result.data?.diagnostics && result.data.diagnostics.length > 0) {
           expect(result.data.diagnostics.some((d: any) => d.message)).to.equal(true);
@@ -119,7 +119,7 @@ describe('ValidationService', () => {
       };
 
       const result = await validationService.validateDocument(specFile, options);
-      
+
       expect(result.success).to.equal(true);
       if (result.success) {
         expect(result.data).to.have.property('diagnostics');
@@ -129,12 +129,12 @@ describe('ValidationService', () => {
 
     it('should handle different output formats', async () => {
       const specFile = new Specification(validAsyncAPI);
-      const formats = ['json', 'junit', 'html', 'text', 'teamcity', 'pretty'] as const;
+      const formats = ['json', 'junit', 'html', 'text', 'teamcity', 'pretty', 'github-actions', 'sarif', 'code-climate', 'gitlab', 'markdown'] as const;
 
       for (const format of formats) {
         const options = { 'diagnostics-format': format };
         const result = await validationService.validateDocument(specFile, options);
-        
+
         expect(result.success).to.equal(true);
         if (result.success) {
           expect(result.data).to.have.property('diagnostics');
@@ -216,21 +216,21 @@ describe('ValidationService', () => {
 
       const result = await validationService.validateDocument(specFile, options);
 
-      // The validation succeeds means the validation command is successfully executed it is independent whether 
-      // the document is valid or not 
+      // The validation succeeds means the validation command is successfully executed it is independent whether
+      // the document is valid or not
       expect(result.success).to.equal(true);
       if (result.success) {
         expect(result.data).to.have.property('status');
         expect(result.data?.status).to.equal('invalid');
         expect(result.data).to.have.property('diagnostics');
         expect(result.data?.diagnostics).to.be.an('array');
-        
+
         // Should have an invalid-ref diagnostic for the private GitHub URL
         const invalidRefDiagnostic = result.data?.diagnostics?.find((d: any) => d.code === 'invalid-ref');
         // eslint-disable-next-line no-unused-expressions
         expect(invalidRefDiagnostic).to.exist;
         // Error message varies by platform - macOS shows FetchError, Linux/Windows show "Page not found"
-        expect(invalidRefDiagnostic?.message).to.satisfy((msg: string) => 
+        expect(invalidRefDiagnostic?.message).to.satisfy((msg: string) =>
           msg.includes('Page not found') || msg.includes('FetchError')
         );
         expect(invalidRefDiagnostic?.message).to.include('https://github.com/private-org/private-repo/blob/main/schema.yaml');
@@ -244,8 +244,8 @@ describe('ValidationService', () => {
       };
 
       const result = await validationService.validateDocument(specFile, options);
-      // The validation succeeds means the validation command is successfully executed it is independent whether 
-      // the document is valid or not 
+      // The validation succeeds means the validation command is successfully executed it is independent whether
+      // the document is valid or not
       expect(result.success).to.equal(true);
       if (result.success) {
         expect(result.data).to.have.property('status');