location.append -> location.child

RomanHotsiy · RomanHotsiy · commit 26efc10ce1de · 2020-06-24T13:13:45.000+03:00
diff --git a/resources/.redocly.yaml b/resources/.redocly.yaml
@@ -8,5 +8,6 @@ lint:
   rules:
     operation-2xx-response: warning
     operation-description: off
+    path-http-verbs-order: error
   transformers:
     local/duplicate-description: off
diff --git a/resources/local-plugin.js b/resources/local-plugin.js
@@ -9,7 +9,7 @@ export const rules = {
           if (operation.operationId === 'test') {
             report({
               message: `operationId must be not "test"`,
-              location: location.append('operationId'),
+              location: location.child('operationId'),
             });
           }
         },
diff --git a/src/ref-utils.ts b/src/ref-utils.ts
@@ -12,7 +12,7 @@ export function isRef(node: any): node is OasRef {
 export class Location {
   constructor(public source: Source, public pointer: string) {}
 
-  append(components: (string | number)[] | string | number) {
+  child(components: (string | number)[] | string | number) {
     return new Location(
       this.source,
       joinPointer(
@@ -22,6 +22,10 @@ export class Location {
     );
   }
 
+  key() {
+    return { ...this, reportOnKey: true }
+  }
+
   get absolutePointer() {
     return this.source.absoluteRef + this.pointer;
   }
diff --git a/src/rules/oas3/api-servers.ts b/src/rules/oas3/api-servers.ts
@@ -13,7 +13,7 @@ export const OperationDescription: Oas3Rule = () => {
       if (!Array.isArray(root.servers) || root.servers.length === 0) {
         report({
           message: 'OpenAPI servers must a non-empty array.',
-          location: location.append(['servers']),
+          location: location.child(['servers']),
         });
       }
     },
diff --git a/src/rules/oas3/boolean-parameter-prefixes.ts b/src/rules/oas3/boolean-parameter-prefixes.ts
@@ -7,7 +7,7 @@ export const BooleanParameterPrefixes: Oas3Rule = () => {
         if (schema.type === 'boolean' && !/^(is|has)[A-Z]/.test(parents.Parameter.name)) {
           report({
             message: `Boolean parameter ${parents.Parameter.name} should have a \`is\` or \`has\` prefix`,
-            location: parentLocations.Parameter.append(['name']),
+            location: parentLocations.Parameter.child(['name']),
           });
         }
       },
diff --git a/src/rules/oas3/oas3-examples-value-or-externalValue.ts b/src/rules/oas3/oas3-examples-value-or-externalValue.ts
@@ -6,7 +6,7 @@ export const ExampleValueOrExternalValue: Oas3Rule = () => {
       if (example.value && example.externalValue) {
         report({
           message: 'Example object can have either "value" or "externalValue" fields.',
-          location: { ...location.append(['value']), reportOnKey: true },
+          location: location.child(['value']).key(),
         });
       }
     },
diff --git a/src/rules/oas3/oas3-server-not-example.com.ts b/src/rules/oas3/oas3-server-not-example.com.ts
@@ -6,7 +6,7 @@ export const ServerNotExample: Oas3Rule = () => {
       if (['example.com', 'localhost'].indexOf(server.url) !== -1) {
         report({
           message: 'Server URL should not point at example.com.',
-          location: location.append(['url']),
+          location: location.child(['url']),
         });
       }
     },
diff --git a/src/rules/oas3/oas3-server-trailing-slash.ts b/src/rules/oas3/oas3-server-trailing-slash.ts
@@ -7,7 +7,7 @@ export const ServerNoTrailingSlash: Oas3Rule = () => {
       if (server.url.endsWith('/')) {
         report({
           message: 'Server URL should not have a trailing slash.',
-          location: location.append(['url']),
+          location: location.child(['url']),
         });
       }
     },
diff --git a/src/rules/oas3/openapi-tags-alphabetical.ts b/src/rules/oas3/openapi-tags-alphabetical.ts
@@ -8,7 +8,7 @@ export const OpenapiTagsAlphabetical: Oas3Rule = () => {
         if (root.tags[i].name > root.tags[i + 1].name) {
           report({
             message: 'The "tags" array should be in alphabetical order',
-            location: location.append(['tags', i]),
+            location: location.child(['tags', i]),
           });
         }
       }
diff --git a/src/rules/oas3/operation-operationId-unique.ts b/src/rules/oas3/operation-operationId-unique.ts
@@ -9,7 +9,7 @@ export const OperationIdUnique: Oas3Rule = () => {
       if (seenOperations.has(operation.operationId)) {
         report({
           message: 'Every operation must have a unique `operationId`',
-          location: location.append([operation.operationId]),
+          location: location.child([operation.operationId]),
         });
       }
       seenOperations.add(operation.operationId);
diff --git a/src/rules/oas3/operation-operationId-valid-in-url.ts b/src/rules/oas3/operation-operationId-valid-in-url.ts
@@ -8,7 +8,7 @@ export const OperationIdValidUrl: Oas3Rule = () => {
       if (operation.operationId && !validUrlSymbols.test(operation.operationId)) {
         report({
           message: 'Operation id should not have URL invalid characters.',
-          location: location.append(['operationId']),
+          location: location.child(['operationId']),
         });
       }
     },
diff --git a/src/rules/oas3/operation-parameters-unique.ts b/src/rules/oas3/operation-parameters-unique.ts
@@ -14,7 +14,7 @@ export const OperationParametersUnique: Oas3Rule = () => {
         if (seenPathParams.has(paramId)) {
           report({
             message: `Paths must have unique \`name\` + \`in\` parameters.\nRepeats of \`in:${parameter.in}\` + \`name:${parameter.name}\``,
-            location: parentLocations.PathItem.append(['parameters', key]),
+            location: parentLocations.PathItem.child(['parameters', key]),
           });
         }
         seenPathParams.add(`${parameter.in}___${parameter.name}`);
@@ -28,7 +28,7 @@ export const OperationParametersUnique: Oas3Rule = () => {
           if (seenOperationParams.has(paramId)) {
             report({
               message: `Operations must have unique \`name\` + \`in\` parameters.\nRepeats of \`in:${parameter.in}\` + \`name:${parameter.name}\``,
-              location: parentLocations.Operation.append(['parameters', key]),
+              location: parentLocations.Operation.child(['parameters', key]),
             });
           }
           seenOperationParams.add(paramId);
diff --git a/src/rules/oas3/operation-security-defined.ts b/src/rules/oas3/operation-security-defined.ts
@@ -33,7 +33,7 @@ export const OperationSecurityDefined: Oas3Rule = () => {
     SecurityRequirement(requirements, { location }) {
       for (const requirement of Object.keys(requirements)) {
         const authScheme = referencedSchemes.get(requirement);
-        const requirementLocation = location.append([requirement]);
+        const requirementLocation = location.child([requirement]);
         if (!authScheme) {
           referencedSchemes.set(requirement, { from: [requirementLocation] });
         } else {
diff --git a/src/rules/oas3/operation-singular-tag.ts b/src/rules/oas3/operation-singular-tag.ts
@@ -6,7 +6,7 @@ export const OperationSingularTag: Oas3Rule = () => {
       if (operation.tags && operation.tags.length > 1) {
         report({
           message: 'Operation "tags" object should have only one tag.',
-          location: { ...location.append(['tags']), reportOnKey: true },
+          location: { ...location.child(['tags']), reportOnKey: true },
         });
       }
     },
diff --git a/src/rules/oas3/operation-tag-defined.ts b/src/rules/oas3/operation-tag-defined.ts
@@ -13,7 +13,7 @@ export const OperationTagDefined: Oas3Rule = () => {
           if (!definedTags.has(operation.tags[i])) {
             report({
               message: `Operation tags should be defined in global tags.`,
-              location: location.append(['tags', i]),
+              location: location.child(['tags', i]),
             });
           }
         }
diff --git a/src/rules/oas3/parameter-description.ts b/src/rules/oas3/parameter-description.ts
@@ -11,7 +11,7 @@ export const ParameterDescription: Oas3Rule = () => {
       } else if (!parameter.description) {
         report({
           message: 'Parameter object description must be non-empty string.',
-          location: location.append(['description']),
+          location: location.child(['description']),
         });
       }
     },
diff --git a/src/rules/oas3/path-http-verbs-order.ts b/src/rules/oas3/path-http-verbs-order.ts
@@ -18,7 +18,7 @@ export const PathHttpVerbsOrder: Oas3Rule = (opts: any) => {
         if (bIdx < aIdx) {
           report({
             message: 'Operation http verbs must be ordered',
-            location: { reportOnKey: true, ...location.append(httpVerbs[i + 1]) },
+            location: { reportOnKey: true, ...location.child(httpVerbs[i + 1]) },
           });
         }
       }
diff --git a/src/rules/oas3/path-params-defined.ts b/src/rules/oas3/path-params-defined.ts
@@ -23,7 +23,7 @@ export const PathParamsDefined: Oas3Rule = () => {
           if (!pathTemplateParams.has(parameter.name)) {
             report({
               message: `Path parameter \`${parameter.name}\` is not used in the path \`${currentPath}\`.`,
-              location: location.append(['name']),
+              location: location.child(['name']),
             });
           }
         }
@@ -34,7 +34,7 @@ export const PathParamsDefined: Oas3Rule = () => {
             if (!definedPathParams.has(templateParam)) {
               report({
                 message: `The operation does not define the path parameter \`{${templateParam}}\` expected by path \`${currentPath}\`.`,
-                location: { ...location.append(['parameters']), reportOnKey: true }, // report on operation
+                location: location.child(['parameters']).key(), // report on operation
               });
             }
           }
@@ -45,7 +45,7 @@ export const PathParamsDefined: Oas3Rule = () => {
             if (!pathTemplateParams.has(parameter.name)) {
               report({
                 message: `Path parameter \`${parameter.name}\` is not used in the path \`${currentPath}\`.`,
-                location: location.append(['name']),
+                location: location.child(['name']),
               });
             }
           }
diff --git a/src/rules/oas3/schema.ts b/src/rules/oas3/schema.ts
@@ -38,7 +38,7 @@ export const Oas3Schema: Oas3Rule = () => {
       }
 
       for (const propName of Object.keys(node)) {
-        const propLocation = location.append([propName]);
+        const propLocation = location.child([propName]);
         const propValue = node[propName];
         const propType =
           type.properties[propName] === undefined
@@ -89,7 +89,7 @@ export const Oas3Schema: Oas3Rule = () => {
             if (!matchesJsonSchemaType(item, itemsType)) {
               report({
                 message: `Expected type '${itemsType}' but got '${oasTypeOf(item)}'`,
-                location: propLocation.append([i]),
+                location: propLocation.child([i]),
               });
             }
           }
diff --git a/src/rules/oas3/tag-description.ts b/src/rules/oas3/tag-description.ts
@@ -11,7 +11,7 @@ export const TagDescription: Oas3Rule = () => {
       } else if (!tag.description) {
         report({
           message: 'Tag object description must be non-empty string.',
-          location: location.append(['description']),
+          location: location.child(['description']),
         });
       }
     },
diff --git a/src/rules/oas3/typed-enum.ts b/src/rules/oas3/typed-enum.ts
@@ -13,7 +13,7 @@ export const TypedEnum: Oas3Rule = () => {
             message: `All values of \`enum\` field must be of the same type as the \`type\` field: expected "${
               schema.type
             }" but received "${oasTypeOf(mismatchedValue)}"`,
-            location: location.append(['enum', schema.enum.indexOf(mismatchedValue)]),
+            location: location.child(['enum', schema.enum.indexOf(mismatchedValue)]),
           });
         }
       }
diff --git a/src/walk.ts b/src/walk.ts
@@ -213,7 +213,7 @@ export function walkDocument<T>(opts: {
           const itemsType = type.items;
           if (itemsType !== undefined) {
             for (let i = 0; i < resolvedNode.length; i++) {
-              walkNode(resolvedNode[i], itemsType, location.append([i]), resolvedNode, i);
+              walkNode(resolvedNode[i], itemsType, location.child([i]), resolvedNode, i);
             }
           }
         } else if (typeof resolvedNode === 'object' && resolvedNode !== null) {
@@ -232,7 +232,7 @@ export function walkDocument<T>(opts: {
             walkNode(
               value,
               propType.name === undefined ? { name: 'scalar', properties: {} } : propType,
-              location.append([propName]),
+              location.child([propName]),
               resolvedNode,
               propName,
             );

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ export const rules = {`
`9`	`9`	`if (operation.operationId === 'test') {`
`10`	`10`	`report({`
`11`	`11`	message: `operationId must be not "test"`,
`12`		`- location: location.append('operationId'),`
	`12`	`+ location: location.child('operationId'),`
`13`	`13`	`});`
`14`	`14`	`}`
`15`	`15`	`},`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export const OperationDescription: Oas3Rule = () => {`
`13`	`13`	`if (!Array.isArray(root.servers) \|\| root.servers.length === 0) {`
`14`	`14`	`report({`
`15`	`15`	`message: 'OpenAPI servers must a non-empty array.',`
`16`		`- location: location.append(['servers']),`
	`16`	`+ location: location.child(['servers']),`
`17`	`17`	`});`
`18`	`18`	`}`
`19`	`19`	`},`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ export const BooleanParameterPrefixes: Oas3Rule = () => {`
`7`	`7`	`if (schema.type === 'boolean' && !/^(is\|has)[A-Z]/.test(parents.Parameter.name)) {`
`8`	`8`	`report({`
`9`	`9`	message: `Boolean parameter ${parents.Parameter.name} should have a \`is\` or \`has\` prefix`,
`10`		`- location: parentLocations.Parameter.append(['name']),`
	`10`	`+ location: parentLocations.Parameter.child(['name']),`
`11`	`11`	`});`
`12`	`12`	`}`
`13`	`13`	`},`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ export const ExampleValueOrExternalValue: Oas3Rule = () => {`
`6`	`6`	`if (example.value && example.externalValue) {`
`7`	`7`	`report({`
`8`	`8`	`message: 'Example object can have either "value" or "externalValue" fields.',`
`9`		`- location: { ...location.append(['value']), reportOnKey: true },`
	`9`	`+ location: location.child(['value']).key(),`
`10`	`10`	`});`
`11`	`11`	`}`
`12`	`12`	`},`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ export const ServerNotExample: Oas3Rule = () => {`
`6`	`6`	`if (['example.com', 'localhost'].indexOf(server.url) !== -1) {`
`7`	`7`	`report({`
`8`	`8`	`message: 'Server URL should not point at example.com.',`
`9`		`- location: location.append(['url']),`
	`9`	`+ location: location.child(['url']),`
`10`	`10`	`});`
`11`	`11`	`}`
`12`	`12`	`},`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ export const ServerNoTrailingSlash: Oas3Rule = () => {`
`7`	`7`	`if (server.url.endsWith('/')) {`
`8`	`8`	`report({`
`9`	`9`	`message: 'Server URL should not have a trailing slash.',`
`10`		`- location: location.append(['url']),`
	`10`	`+ location: location.child(['url']),`
`11`	`11`	`});`
`12`	`12`	`}`
`13`	`13`	`},`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ export const OpenapiTagsAlphabetical: Oas3Rule = () => {`
`8`	`8`	`if (root.tags[i].name > root.tags[i + 1].name) {`
`9`	`9`	`report({`
`10`	`10`	`message: 'The "tags" array should be in alphabetical order',`
`11`		`- location: location.append(['tags', i]),`
	`11`	`+ location: location.child(['tags', i]),`
`12`	`12`	`});`
`13`	`13`	`}`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ export const OperationIdUnique: Oas3Rule = () => {`
`9`	`9`	`if (seenOperations.has(operation.operationId)) {`
`10`	`10`	`report({`
`11`	`11`	message: 'Every operation must have a unique `operationId`',
`12`		`- location: location.append([operation.operationId]),`
	`12`	`+ location: location.child([operation.operationId]),`
`13`	`13`	`});`
`14`	`14`	`}`
`15`	`15`	`seenOperations.add(operation.operationId);`