feat: add logic for building and displaying helper url for rule (#486)

* feat: add logic for building and displaying helper url for rule

* fix: add copyright and licensing information

---------

Signed-off-by: Fredrik Nordlander <fredrik.nordlander@digg.se>

Author: fredriknordlander

package-lock.json

@@ -167,13 +167,13 @@ export async function execCLI<T extends CliArgs>(argv: T) {
           }
         };
         const formatLintingResult = (result: any) => {
-          return `allvarlighetsgrad: ${colorizeSeverity(result.allvarlighetsgrad)} \nid: ${result.id} \nkrav: ${
+          return `\nallvarlighetsgrad: ${colorizeSeverity(result.allvarlighetsgrad)} \nid: ${result.id} \nkrav: ${
             result.krav
           } \nområde: ${result.område} \nsökväg:[${result.sökväg}] \nomfattning:${JSON.stringify(
             result.omfattning,
             null,
             2,
-          )} `;
+          )}\ndesignregel: ${result.helpUrl} `;
         };
         //Check specified option from yargs input
 

src/cli-mode.ts

@@ -1,3 +1,8 @@
+
+// SPDX-FileCopyrightText: 2025 Digg - Agency for Digital Government
+//
+// SPDX-License-Identifier: EUPL-1.2
+
 export class SpecValidationRequestDto {
     /** Base 64 encoded OpenAPI spec (YAML or JSON) */
     spec!: string;

src/model/SpecValidationRequestDto.ts

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 Digg - Agency for Digital Government
+//
+// SPDX-License-Identifier: EUPL-1.2
+
 import { ValidationResponseDto } from './ValidationResponseDto.js';
 import { Issue } from '../util/Issue.js';
 

src/model/ValidationResponse.ts

@@ -0,0 +1,21 @@
+// SPDX-FileCopyrightText: 2025 Digg - Agency for Digital Government
+//
+// SPDX-License-Identifier: EUPL-1.2
+
+const RULES_DOC_REPO =
+  'https://github.com/diggsweden/rest-api-profil-lint-processor';
+
+
+  /**
+   * Constructs a helper Url together with correct Rule  
+   * @param ruleId ( Rule identifier)
+   * @returns Normalized help url
+   */
+  export function buildRuleHelpUrl(ruleId: string): string {
+    const ref = process.env.RULES_DOC_REF || 'main';
+    const normalizedId = ruleId
+    .toLowerCase()
+    .replace('.', '');
+
+    return `${RULES_DOC_REPO}/blob/${ref}/GUIDELINES.md#id-${normalizedId}`;
+}

src/rulesets/util/rules-doc.config.ts

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 Digg - Agency for Digital Government
+//
+// SPDX-License-Identifier: EUPL-1.2
+
 /**
  * Issue type to use from client to validate parsing
  */

src/util/Issue.ts

@@ -7,6 +7,7 @@ import { ISpectralDiagnostic } from '@stoplight/spectral-core';
 import spectralCore from '@stoplight/spectral-core';
 const { Spectral, Document } = spectralCore;
 import { RapLPCustomSpectralDiagnostic } from './RapLPCustomSpectralDiagnostic.js';
+import { buildRuleHelpUrl } from '../rulesets/util/rules-doc.config.js';
 
 class RapLPCustomSpectral {
   private spectral: SpectralCore.Spectral;
@@ -49,9 +50,12 @@ class RapLPCustomSpectral {
           if (ruleClass && typeof ruleClass.getCustomProperties === 'function') {
             // Check for existance
             const customProperties = ruleClass.getCustomProperties;
+            const ruleId = ruleClass.customProperties.id;   
+
             const customResult: RapLPCustomSpectralDiagnostic = {
-              id: ruleClass.customProperties.id,
+              id: ruleId,
               område: ruleClass.customProperties.område,
+              helpUrl: ruleId ? buildRuleHelpUrl(ruleId) : undefined,
               ...customProperties, // For more copy
               ...this.mapResultToCustom(result),
             };

src/util/RapLPCustomSpectral.ts

@@ -16,6 +16,9 @@ export interface RapLPCustomSpectralDiagnostic
   allvarlighetsgrad?: string;
   sökväg?: any;
   omfattning?: any;
+
+  /**Helper Url for guidelines */
+  helpUrl?: string;
 }
 
 

src/util/RapLPCustomSpectralDiagnostic.ts

@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 Digg - Agency for Digital Government
+//
+// SPDX-License-Identifier: EUPL-1.2
+
 /**
 * CONTRACT TESTS for /api/v1/validation/validatespec
 * - NOTE:

tests/unit/api/endpointValidation.test.ts

@@ -0,0 +1,47 @@
+// SPDX-FileCopyrightText: 2025 Digg - Agency for Digital Government
+//
+// SPDX-License-Identifier: EUPL-1.2
+
+import { buildRuleHelpUrl } from '../../src/rulesets/util/rules-doc.config.js';
+
+describe('buildRuleHelpUrl', () => {
+  const ORIGINAL_ENV = process.env;
+
+  beforeEach(() => {
+    process.env = { ...ORIGINAL_ENV };
+  });
+
+  afterAll(() => {
+    process.env = ORIGINAL_ENV;
+  });
+
+  it('bygger korrekt GitHub-länk för regel-ID med punkt (SAK.16)', () => {
+    process.env.RULES_DOC_REF = 'main';
+
+    const url = buildRuleHelpUrl('SAK.16');
+
+    expect(url).toBe(
+      'https://github.com/diggsweden/rest-api-profil-lint-processor/blob/main/GUIDELINES.md#id-sak16'
+    );
+  });
+
+  it('faller tillbaka till main om RULES_DOC_REF saknas', () => {
+    delete process.env.RULES_DOC_REF;
+
+    const url = buildRuleHelpUrl('FOR.02');
+
+    expect(url).toBe(
+      'https://github.com/diggsweden/rest-api-profil-lint-processor/blob/main/GUIDELINES.md#id-for02'
+    );
+  });
+
+  it('hanterar redan normaliserade ID:n korrekt', () => {
+    process.env.RULES_DOC_REF = 'feature/test';
+
+    const url = buildRuleHelpUrl('sak16');
+
+    expect(url).toBe(
+      'https://github.com/diggsweden/rest-api-profil-lint-processor/blob/feature/test/GUIDELINES.md#id-sak16'
+    );
+  });
+});