feat(core): expose x-internal to annotate internal opts (#1993)

stoplightio · Dec 9, 2021 · 0287319 · 0287319
1 parent 3f31633
commit 0287319
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 7 deletions.
diff --git a/packages/core/src/ruleset/rulesetFunction.ts b/packages/core/src/ruleset/rulesetFunction.ts
@@ -11,7 +11,7 @@ import { printPath, PrintStyle, printValue } from '@stoplight/spectral-runtime';
 import { RulesetValidationError } from './validation';
 import { IFunctionResult, JSONSchema, RulesetFunction, RulesetFunctionWithValidator } from '../types';
 
-const ajv = new Ajv({ allErrors: true, allowUnionTypes: true, strict: true });
+const ajv = new Ajv({ allErrors: true, allowUnionTypes: true, strict: true, keywords: ['x-internal'] });
 ajvErrors(ajv);
 addFormats(ajv);
 
@@ -61,14 +61,32 @@ export class RulesetFunctionValidationError extends RulesetValidationError {
   }
 }
 
-type Schema = JSONSchema & { errorMessage?: string | { [key in keyof JSONSchema]: string } } & {
-  properties?: {
-    [key: string]: SchemaDefinition;
-  };
-  patternProperties?: {
+type SchemaKeyedFragmentKeyword = 'properties' | 'patternProperties' | 'definitions';
+type SchemaFragmentKeyword = 'additionalItems' | 'propertyNames' | 'if' | 'then' | 'else' | 'not';
+type SchemaCompoundKeyword = 'allOf' | 'anyOf' | 'oneOf';
+
+type Schema = (
+  | (Omit<
+      JSONSchema,
+      SchemaKeyedFragmentKeyword | SchemaFragmentKeyword | SchemaCompoundKeyword | 'items' | 'dependencies'
+    > & {
+      'x-internal'?: boolean;
+      errorMessage?: string | { [key in keyof JSONSchema]: string };
+    })
+  | { 'x-internal': boolean }
+) & {
+  [key in SchemaKeyedFragmentKeyword]?: {
     [key: string]: SchemaDefinition;
   };
+} & {
+  [key in SchemaFragmentKeyword]?: SchemaDefinition;
+} & {
+  [key in SchemaCompoundKeyword]?: SchemaDefinition[];
+} & {
+  items?: SchemaDefinition | SchemaDefinition[];
+  dependencies?: SchemaDefinition | string[];
 };
+
 type SchemaDefinition = Schema | boolean;
 
 const DEFAULT_OPTIONS_VALIDATOR = (o: unknown): boolean => o === null;

diff --git a/packages/core/src/ruleset/validation.ts b/packages/core/src/ruleset/validation.ts
@@ -11,7 +11,7 @@ import type { FileRuleDefinition, RuleDefinition, RulesetDefinition } from './ty
 
 const message = _`'spectral-message'`;
 
-const ajv = new Ajv({ allErrors: true, strict: true, strictRequired: false, keywords: ['$anchor'] });
+const ajv = new Ajv({ allErrors: true, strict: true, strictRequired: false, keywords: ['$anchor', 'x-internal'] });
 addFormats(ajv);
 addErrors(ajv);
 ajv.addKeyword({