feat: overlay linting, decorators, preprocessors, types extension support (#1898)

Author: jeremyfiel

.changeset/funny-lobsters-thank.md

@@ -0,0 +1,6 @@
+---
+"@redocly/openapi-core": minor
+"@redocly/cli": minor
+---
+
+Added support for linting, preprocessors, decorators, and type extensions for Overlay v1 documents.

__tests__/check-config/wrong-config-type-extensions-in-assertions/snapshot.js

@@ -58,7 +58,7 @@ describe('handleLint', () => {
     getMergedConfigMock.mockReset();
   });
 
-  describe('loadConfig and getEnrtypoints stage', () => {
+  describe('loadConfig and getEntrypoints stage', () => {
     it('should fail if config file does not exist', async () => {
       await commandWrapper(handleLint)({ ...argvMock, config: 'config.yaml' });
       expect(exitWithError).toHaveBeenCalledWith(

__tests__/lint-config/invalid-config-assertation-config-type/snapshot.js

@@ -38,6 +38,8 @@ export function commandWrapper<T extends CommandOptions>(
         ? 'asyncapi'
         : document?.arazzo
         ? 'arazzo'
+        : document?.overlay
+        ? 'overlay'
         : undefined;
       if (specKeyword) {
         specFullVersion = document[specKeyword] as string;

packages/cli/src/__tests__/commands/lint.test.ts

@@ -311,6 +311,11 @@ export function mapTypeToComponent(typeName: string, version: SpecMajorVersion)
         default:
           return null;
       }
+    case SpecMajorVersion.Overlay1:
+      switch (typeName) {
+        default:
+          return null;
+      }
   }
 }
 

packages/cli/src/wrapper.ts

@@ -214,6 +214,11 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "overlay1Decorators": {},
+  "overlay1Preprocessors": {},
+  "overlay1Rules": {
+    "info-contact": "off",
+  },
   "preprocessors": {},
   "recommendedFallback": false,
   "rules": {
@@ -443,6 +448,11 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
     "tag-description": "warn",
     "tags-alphabetical": "off",
   },
+  "overlay1Decorators": {},
+  "overlay1Preprocessors": {},
+  "overlay1Rules": {
+    "info-contact": "off",
+  },
   "preprocessors": {},
   "recommendedFallback": undefined,
   "rules": {

packages/core/src/bundle.ts

@@ -32,6 +32,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "overlay1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
   },
   "doNotResolveExamples": false,
   "extendPaths": [],
@@ -76,6 +81,11 @@ StyleguideConfig {
       "oas3_0": {},
       "oas3_1": {},
     },
+    "overlay1": {
+      "oas2": {},
+      "oas3_0": {},
+      "oas3_1": {},
+    },
   },
   "rawConfig": {
     "_usedRules": Set {},
@@ -203,6 +213,20 @@ StyleguideConfig {
         "operation-summary": "error",
       },
     },
+    "overlay1": {
+      "oas2": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
   },
 }
 `;

packages/core/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -123,6 +123,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "doNotResolveExamples": false,
           "extendPaths": [],
@@ -136,6 +137,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "rawConfig": {
             "extendPaths": [],
@@ -164,6 +166,9 @@ describe('getMergedConfig', () => {
             "oas3_1": {
               "operation-summary": "warn",
             },
+            "overlay1": {
+              "operation-summary": "warn",
+            },
           },
         },
         "telemetry": "on",
@@ -238,6 +243,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "doNotResolveExamples": false,
           "extendPaths": [],
@@ -251,6 +257,7 @@ describe('getMergedConfig', () => {
             "oas2": {},
             "oas3_0": {},
             "oas3_1": {},
+            "overlay1": {},
           },
           "rawConfig": {
             "extendPaths": [],
@@ -287,6 +294,10 @@ describe('getMergedConfig', () => {
               "no-empty-servers": "error",
               "operation-summary": "error",
             },
+            "overlay1": {
+              "no-empty-servers": "error",
+              "operation-summary": "error",
+            },
           },
         },
         "telemetry": "on",

packages/core/src/config/__tests__/__snapshots__/config.test.ts.snap

@@ -226,6 +226,9 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'workflowId-unique': 'error',
     'workflow-dependsOn': 'error',
   },
+  overlay1Rules: {
+    'info-contact': 'error',
+  },
 };
 
 export default all;