fix(ruleset-migrator): validate aliases correctly (#2085)

stoplightio · Mar 10, 2022 · 1f4ab20 · 1f4ab20
1 parent c86c504
commit 1f4ab20
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 20 deletions.
diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.cjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.cjs
@@ -1,7 +1,7 @@
 module.exports = {
   aliases: {
-    PathItem: '$.paths[*][*]',
-    Description: '$..description',
-    Name: '$..name',
+    PathItem: ['$.paths[*][*]'],
+    Description: ['$..description'],
+    Name: ['$..name'],
   },
 };
diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.mjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/output.mjs
@@ -1,7 +1,7 @@
 export default {
   aliases: {
-    PathItem: '$.paths[*][*]',
-    Description: '$..description',
-    Name: '$..name',
+    PathItem: ['$.paths[*][*]'],
+    Description: ['$..description'],
+    Name: ['$..name'],
   },
 };
diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/ruleset.yaml b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-1/ruleset.yaml
@@ -1,4 +1,7 @@
 aliases:
-  PathItem: $.paths[*][*]
-  Description: $..description
-  Name: $..name
+  PathItem:
+    - $.paths[*][*]
+  Description:
+    - $..description
+  Name:
+    - $..name
diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.cjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.cjs
@@ -6,11 +6,11 @@ module.exports = {
       targets: [
         {
           formats: [oas2],
-          given: '$.definitions[*]',
+          given: ['$.definitions[*]'],
         },
         {
           formats: [oas3_0, oas3_1],
-          given: '$.components.schemas[*]',
+          given: ['$.components.schemas[*]'],
         },
       ],
     },

diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.mjs b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/output.mjs
@@ -6,11 +6,11 @@ export default {
       targets: [
         {
           formats: [oas2],
-          given: '$.definitions[*]',
+          given: ['$.definitions[*]'],
         },
         {
           formats: [oas3_0, oas3_1],
-          given: '$.components.schemas[*]',
+          given: ['$.components.schemas[*]'],
         },
       ],
     },

diff --git a/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/ruleset.yaml b/packages/ruleset-migrator/src/__tests__/__fixtures__/aliases-variant-2/ruleset.yaml
@@ -4,8 +4,10 @@ aliases:
     targets:
       - formats:
           - oas2
-        given: $.definitions[*]
+        given:
+          - $.definitions[*]
       - formats:
           - oas3.0
           - oas3.1
-        given: $.components.schemas[*]
+        given:
+          - $.components.schemas[*]
diff --git a/packages/ruleset-migrator/src/validation/schema.ts b/packages/ruleset-migrator/src/validation/schema.ts
@@ -9,7 +9,10 @@ const schema = {
       additionalProperties: {
         oneOf: [
           {
-            type: 'string',
+            type: 'array',
+            items: {
+              type: 'string',
+            },
           },
           {
             type: 'object',
@@ -27,7 +30,10 @@ const schema = {
                       $ref: '#/properties/formats',
                     },
                     given: {
-                      type: 'string',
+                      type: 'array',
+                      items: {
+                        type: 'string',
+                      },
                     },
                   },
                   required: ['formats', 'given'],

diff --git a/packages/ruleset-migrator/src/validation/types.ts b/packages/ruleset-migrator/src/validation/types.ts
@@ -3,7 +3,7 @@
 export interface Ruleset {
   aliases?: {
     [k: string]:
-      | string
+      | string[]
       | {
           description?: string;
           targets: [
@@ -42,7 +42,7 @@ export interface Ruleset {
                   | 'json-schema-2020-12'
                 )[]
               ];
-              given: string;
+              given: string[];
               [k: string]: unknown;
             },
             ...{
@@ -80,7 +80,7 @@ export interface Ruleset {
                   | 'json-schema-2020-12'
                 )[]
               ];
-              given: string;
+              given: string[];
               [k: string]: unknown;
             }[]
           ];