fix(spectral): fix issue in 0.4.0 package causing a runtime error

- clone local copy of getLintTargets from spectral repository
- clone local copy of tests for getLintTargets function
- update package version to 0.4.1 and add lodash dependency

Author: milkshakeuk

.npmignore

@@ -1,4 +1,5 @@
 *
-!dist/functions/*.js
+!dist/functions/*.{js,d.ts}
+!dist/utils/*.{js,d.ts}
 !.spectral.yaml
 !*.oas.rules.yml

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhsa-collaboration/spectral-rules",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "UKHSA Spectral ruleset",
   "main": ".spectral.yaml",
   "type": "module",
@@ -31,19 +31,21 @@
     "ruleset"
   ],
   "dependencies": {
-    "@stoplight/spectral-documentation": "^1.3.1"
+    "@stoplight/spectral-core": "^1.20.0",
+    "@stoplight/spectral-documentation": "^1.3.1",
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@commitlint/cli": "^20.1.0",
     "@commitlint/config-conventional": "^20.0.0",
     "@stoplight/spectral-cli": "^6.15.0",
-    "@stoplight/spectral-core": "^1.20.0",
     "@stoplight/spectral-functions": "^1.10.1",
     "@stoplight/spectral-parsers": "^1.0.5",
     "@stoplight/spectral-ruleset-bundler": "^1.6.3",
     "@swc/core": "^1.13.21",
     "@swc/jest": "^0.2.39",
     "@types/jest": "^30.0.0",
+    "@types/lodash": "^4.17.20",
     "cpx2": "^8.0.0",
     "husky": "^9.1.7",
     "jest": "^30.2.0",

package.json

@@ -0,0 +1,154 @@
+/**
+ * originally sourced from: https://github.com/stoplightio/spectral/blob/develop/packages/core/src/runner/utils/__tests__/getLintTargets.test.ts
+ */
+import { getLintTargets } from '../../utils/getLintTargets';
+
+describe('getLintTargets', () => {
+  describe('when @key is given as field', () => {
+    it('given object, returns its keys', () => {
+      expect(getLintTargets({ a: null, b: true }, '@key')).toStrictEqual([
+        {
+          path: ['a'],
+          value: 'a',
+        },
+        {
+          path: ['b'],
+          value: 'b',
+        },
+      ]);
+    });
+
+    it('given array, returns its indicies', () => {
+      expect(getLintTargets(['foo', 'bar'], '@key')).toStrictEqual([
+        {
+          path: ['0'],
+          value: '0',
+        },
+        {
+          path: ['1'],
+          value: '1',
+        },
+      ]);
+    });
+
+    it('given primitive property, returns the whole input', () => {
+      expect(getLintTargets('abc', '0')).toStrictEqual([
+        {
+          path: [],
+          value: 'abc',
+        },
+      ]);
+    });
+  });
+
+  describe('when property path is given as field', () => {
+    it('given existing property, returns lint targets', () => {
+      expect(getLintTargets({ a: null }, 'a')).toStrictEqual([
+        {
+          path: ['a'],
+          value: null,
+        },
+      ]);
+
+      expect(getLintTargets({ foo: ['a'] }, 'foo[0]')).toStrictEqual([
+        {
+          path: ['foo', '0'],
+          value: 'a',
+        },
+      ]);
+
+      expect(getLintTargets(['foo'], '0')).toStrictEqual([
+        {
+          path: ['0'],
+          value: 'foo',
+        },
+      ]);
+
+      expect(getLintTargets({ a: void 0 }, 'a')).toStrictEqual([
+        {
+          path: ['a'],
+          value: void 0,
+        },
+      ]);
+    });
+
+    it('given non-existing property, returns lint target with undefined value', () => {
+      expect(getLintTargets({ a: null }, 'b')).toStrictEqual([
+        {
+          path: ['b'],
+          value: void 0,
+        },
+      ]);
+
+      expect(getLintTargets(['foo'], '1')).toStrictEqual([
+        {
+          path: ['1'],
+          value: void 0,
+        },
+      ]);
+    });
+
+    it('given primitive property, returns the whole input', () => {
+      expect(getLintTargets('abc', '0')).toStrictEqual([
+        {
+          path: [],
+          value: 'abc',
+        },
+      ]);
+    });
+  });
+
+  describe('when JSON Path expression is given as field', () => {
+    it('given existing property, returns lint targets', () => {
+      expect(getLintTargets({ a: null }, '$')).toStrictEqual([
+        {
+          path: [],
+          value: {
+            a: null,
+          },
+        },
+      ]);
+
+      expect(getLintTargets({ foo: ['a'] }, '$.foo.*')).toStrictEqual([
+        {
+          path: ['foo', '0'],
+          value: 'a',
+        },
+      ]);
+    });
+
+    it('given non-existing property, returns lint target with undefined value', () => {
+      expect(getLintTargets({ a: null }, '$.b')).toStrictEqual([
+        {
+          path: [],
+          value: void 0,
+        },
+      ]);
+
+      expect(getLintTargets(['foo'], '$..bar')).toStrictEqual([
+        {
+          path: [],
+          value: void 0,
+        },
+      ]);
+    });
+
+    it('given primitive property, returns the whole input', () => {
+      expect(getLintTargets('abc', '0')).toStrictEqual([
+        {
+          path: [],
+          value: 'abc',
+        },
+      ]);
+    });
+  });
+
+  it('given no field, returns the whole input', () => {
+    expect(getLintTargets({ a: true }, void 0)).toStrictEqual([
+      {
+        path: [],
+        value: { a: true },
+      },
+    ]);
+  });
+});

src/__tests__/utils/getLintTargets.test.ts

@@ -7,13 +7,14 @@ import type {
   Rule,
 } from '@stoplight/spectral-core';
 import { DiagnosticSeverity } from '@stoplight/types';
+import { printPath, PrintStyle } from '@stoplight/spectral-runtime';
 import { EOL } from "node:os";
 /**
- * shouldn't really do this however there is no other way to get these functions, and it keeps us
- * aligned with spectral internals
+ * this is a utility function obtained from spectral-core
+ * https://github.com/stoplightio/spectral/blob/develop/packages/core/src/runner/utils/getLintTargets.ts
  */
-import { getLintTargets, type ILintTarget } from '../../node_modules/@stoplight/spectral-core/dist/runner/utils/getLintTargets.js';
-import { printPath, PrintStyle } from '../../node_modules/@stoplight/spectral-runtime/dist/utils/printPath.js';
+import { getLintTargets } from '../utils/getLintTargets.js';
+
 
 /**
  * Configuration options provided by the ruleset when invoking the override.
@@ -56,7 +57,7 @@ const overrideSeverity = (
   if (targetField.trim().length === 0) {
     throw new Error('overrideSeverity requires a non-empty target selector');
   }
-  const targets = getLintTargets(targetValue, targetField) as ILintTarget[];
+  const targets = getLintTargets(targetValue, targetField)
   const matchingTarget = targets.find(({ value }) => value === options.value);
 
   if (matchingTarget && typeof matchingTarget.value === 'string') {