@redocly/openapi-core 1.18.1 → 1.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/__tests__/utils.ts +14 -7
- package/lib/benchmark/benches/lint-with-many-rules.bench.d.ts +1 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.js +7 -3
- package/lib/benchmark/benches/lint-with-nested-rule.bench.d.ts +1 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.js +7 -3
- package/lib/benchmark/benches/lint-with-no-rules.bench.d.ts +1 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.js +7 -3
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.d.ts +1 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +19 -15
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.d.ts +1 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.js +18 -14
- package/lib/benchmark/benches/recommended-oas3.bench.js +2 -2
- package/lib/benchmark/benches/resolve-with-no-external.bench.js +2 -2
- package/lib/benchmark/utils.d.ts +3 -3
- package/lib/benchmark/utils.js +10 -7
- package/lib/bundle.d.ts +2 -2
- package/lib/bundle.js +127 -120
- package/lib/config/all.js +13 -1
- package/lib/config/builtIn.js +18 -17
- package/lib/config/config-resolvers.d.ts +1 -1
- package/lib/config/config-resolvers.js +241 -158
- package/lib/config/config.d.ts +4 -3
- package/lib/config/config.js +53 -34
- package/lib/config/load.d.ts +1 -1
- package/lib/config/load.js +105 -117
- package/lib/config/minimal.js +13 -0
- package/lib/config/recommended-strict.js +14 -1
- package/lib/config/recommended.js +14 -1
- package/lib/config/rules.d.ts +3 -3
- package/lib/config/rules.js +1 -2
- package/lib/config/types.d.ts +17 -4
- package/lib/config/utils.d.ts +3 -1
- package/lib/config/utils.js +78 -49
- package/lib/decorators/async3/index.d.ts +1 -0
- package/lib/decorators/async3/index.js +4 -0
- package/lib/decorators/common/filters/filter-helper.d.ts +1 -1
- package/lib/decorators/common/filters/filter-helper.js +2 -3
- package/lib/decorators/common/filters/filter-in.d.ts +1 -1
- package/lib/decorators/common/filters/filter-in.js +1 -1
- package/lib/decorators/common/filters/filter-out.d.ts +1 -1
- package/lib/decorators/common/filters/filter-out.js +1 -1
- package/lib/decorators/common/info-description-override.d.ts +1 -1
- package/lib/decorators/common/info-override.d.ts +1 -1
- package/lib/decorators/common/info-override.js +1 -12
- package/lib/decorators/common/media-type-examples-override.d.ts +1 -1
- package/lib/decorators/common/media-type-examples-override.js +8 -2
- package/lib/decorators/common/operation-description-override.d.ts +1 -1
- package/lib/decorators/common/registry-dependencies.d.ts +1 -1
- package/lib/decorators/common/remove-x-internal.d.ts +1 -1
- package/lib/decorators/common/remove-x-internal.js +4 -5
- package/lib/decorators/common/tag-description-override.d.ts +1 -1
- package/lib/decorators/oas2/index.d.ts +1 -1
- package/lib/decorators/oas2/remove-unused-components.js +1 -2
- package/lib/decorators/oas3/index.d.ts +1 -1
- package/lib/decorators/oas3/remove-unused-components.js +1 -2
- package/lib/env.d.ts +0 -1
- package/lib/env.js +1 -1
- package/lib/format/codeframes.d.ts +1 -1
- package/lib/format/codeframes.js +10 -8
- package/lib/format/format.d.ts +1 -1
- package/lib/format/format.js +24 -16
- package/lib/index.d.ts +2 -1
- package/lib/index.js +6 -4
- package/lib/js-yaml/index.d.ts +1 -1
- package/lib/js-yaml/index.js +1 -1
- package/lib/lint.d.ts +3 -1
- package/lib/lint.js +92 -99
- package/lib/logger.js +2 -2
- package/lib/oas-types.d.ts +9 -5
- package/lib/oas-types.js +22 -12
- package/lib/redocly/domains.d.ts +1 -1
- package/lib/redocly/domains.js +6 -6
- package/lib/redocly/index.d.ts +1 -1
- package/lib/redocly/index.js +60 -73
- package/lib/redocly/registry-api.js +64 -82
- package/lib/ref-utils.d.ts +2 -2
- package/lib/ref-utils.js +14 -13
- package/lib/resolve.d.ts +2 -2
- package/lib/resolve.js +186 -205
- package/lib/rules/ajv.d.ts +1 -1
- package/lib/rules/ajv.js +10 -8
- package/lib/rules/arazzo/index.js +2 -0
- package/lib/rules/async2/channels-kebab-case.d.ts +1 -1
- package/lib/rules/async2/index.js +2 -0
- package/lib/rules/async2/no-channel-trailing-slash.d.ts +1 -1
- package/lib/rules/async3/channels-kebab-case.d.ts +2 -0
- package/lib/rules/async3/channels-kebab-case.js +19 -0
- package/lib/rules/async3/index.d.ts +3 -0
- package/lib/rules/async3/index.js +24 -0
- package/lib/rules/async3/no-channel-trailing-slash.d.ts +2 -0
- package/lib/rules/async3/no-channel-trailing-slash.js +16 -0
- package/lib/rules/common/assertions/asserts.d.ts +2 -2
- package/lib/rules/common/assertions/asserts.js +5 -5
- package/lib/rules/common/assertions/index.d.ts +4 -4
- package/lib/rules/common/assertions/utils.d.ts +1 -1
- package/lib/rules/common/assertions/utils.js +43 -28
- package/lib/rules/common/info-contact.d.ts +1 -1
- package/lib/rules/common/info-license-strict.d.ts +2 -0
- package/lib/rules/common/info-license-strict.js +26 -0
- package/lib/rules/common/info-license-url.d.ts +1 -1
- package/lib/rules/common/info-license.d.ts +1 -1
- package/lib/rules/common/no-ambiguous-paths.d.ts +1 -1
- package/lib/rules/common/no-enum-type-mismatch.d.ts +1 -1
- package/lib/rules/common/no-http-verbs-in-paths.d.ts +1 -1
- package/lib/rules/common/no-identical-paths.d.ts +1 -1
- package/lib/rules/common/no-invalid-parameter-examples.js +1 -2
- package/lib/rules/common/no-invalid-schema-examples.js +1 -2
- package/lib/rules/common/no-path-trailing-slash.d.ts +1 -1
- package/lib/rules/common/no-required-schema-properties-undefined.d.ts +1 -1
- package/lib/rules/common/no-required-schema-properties-undefined.js +1 -2
- package/lib/rules/common/operation-2xx-response.d.ts +1 -1
- package/lib/rules/common/operation-4xx-response.d.ts +1 -1
- package/lib/rules/common/operation-description.d.ts +1 -1
- package/lib/rules/common/operation-operationId-unique.d.ts +1 -1
- package/lib/rules/common/operation-operationId-url-safe.d.ts +1 -1
- package/lib/rules/common/operation-operationId-url-safe.js +1 -0
- package/lib/rules/common/operation-operationId.d.ts +1 -1
- package/lib/rules/common/operation-parameters-unique.d.ts +1 -1
- package/lib/rules/common/operation-singular-tag.d.ts +1 -1
- package/lib/rules/common/operation-summary.d.ts +1 -1
- package/lib/rules/common/operation-tag-defined.d.ts +1 -1
- package/lib/rules/common/operation-tag-defined.js +1 -2
- package/lib/rules/common/parameter-description.d.ts +1 -1
- package/lib/rules/common/path-declaration-must-exist.d.ts +1 -1
- package/lib/rules/common/path-excludes-patterns.d.ts +1 -1
- package/lib/rules/common/path-http-verbs-order.d.ts +1 -1
- package/lib/rules/common/path-http-verbs-order.js +1 -1
- package/lib/rules/common/path-not-include-query.d.ts +1 -1
- package/lib/rules/common/path-params-defined.d.ts +1 -1
- package/lib/rules/common/path-segment-plural.d.ts +1 -1
- package/lib/rules/common/paths-kebab-case.d.ts +1 -1
- package/lib/rules/common/required-string-property-missing-min-length.d.ts +1 -1
- package/lib/rules/common/required-string-property-missing-min-length.js +2 -2
- package/lib/rules/common/response-contains-header.d.ts +1 -1
- package/lib/rules/common/response-contains-header.js +2 -2
- package/lib/rules/common/security-defined.d.ts +1 -1
- package/lib/rules/common/security-defined.js +3 -7
- package/lib/rules/common/spec-strict-refs.d.ts +1 -1
- package/lib/rules/common/spec.d.ts +2 -2
- package/lib/rules/common/spec.js +6 -7
- package/lib/rules/common/tag-description.d.ts +1 -1
- package/lib/rules/common/tags-alphabetical.d.ts +1 -1
- package/lib/rules/no-unresolved-refs.d.ts +3 -3
- package/lib/rules/no-unresolved-refs.js +3 -4
- package/lib/rules/oas2/boolean-parameter-prefixes.d.ts +1 -1
- package/lib/rules/oas2/index.d.ts +1 -1
- package/lib/rules/oas2/index.js +2 -0
- package/lib/rules/oas2/response-contains-property.d.ts +1 -1
- package/lib/rules/oas2/response-contains-property.js +1 -2
- package/lib/rules/oas3/array-parameter-serialization.d.ts +1 -1
- package/lib/rules/oas3/array-parameter-serialization.js +1 -2
- package/lib/rules/oas3/boolean-parameter-prefixes.d.ts +1 -1
- package/lib/rules/oas3/component-name-unique.d.ts +1 -1
- package/lib/rules/oas3/component-name-unique.js +2 -4
- package/lib/rules/oas3/index.d.ts +1 -1
- package/lib/rules/oas3/index.js +2 -0
- package/lib/rules/oas3/no-empty-servers.d.ts +1 -1
- package/lib/rules/oas3/no-example-value-and-externalValue.d.ts +1 -1
- package/lib/rules/oas3/no-invalid-media-type-examples.d.ts +1 -1
- package/lib/rules/oas3/no-invalid-media-type-examples.js +1 -2
- package/lib/rules/oas3/no-server-example.com.d.ts +1 -1
- package/lib/rules/oas3/no-server-example.com.js +1 -0
- package/lib/rules/oas3/no-server-trailing-slash.d.ts +1 -1
- package/lib/rules/oas3/no-server-variables-empty-enum.d.ts +1 -1
- package/lib/rules/oas3/no-server-variables-empty-enum.js +1 -2
- package/lib/rules/oas3/no-undefined-server-variable.d.ts +1 -1
- package/lib/rules/oas3/no-undefined-server-variable.js +2 -3
- package/lib/rules/oas3/no-unused-components.d.ts +1 -1
- package/lib/rules/oas3/no-unused-components.js +1 -2
- package/lib/rules/oas3/response-contains-property.d.ts +1 -1
- package/lib/rules/oas3/response-contains-property.js +1 -2
- package/lib/rules/oas3/spec-components-invalid-map-name.d.ts +1 -1
- package/lib/rules/other/stats.d.ts +3 -3
- package/lib/rules/other/stats.js +5 -3
- package/lib/rules/spot/parameters-no-body-inside-in.d.ts +2 -0
- package/lib/rules/spot/parameters-no-body-inside-in.js +18 -0
- package/lib/rules/utils.d.ts +4 -2
- package/lib/rules/utils.js +41 -13
- package/lib/types/arazzo.d.ts +1 -2275
- package/lib/types/arazzo.js +246 -309
- package/lib/types/asyncapi2.d.ts +17 -0
- package/lib/types/{asyncapi.js → asyncapi2.js} +59 -53
- package/lib/types/asyncapi3.d.ts +2 -0
- package/lib/types/asyncapi3.js +347 -0
- package/lib/types/index.js +19 -10
- package/lib/types/json-schema-adapter.d.ts +1 -1
- package/lib/types/json-schema-adapter.js +4 -18
- package/lib/types/oas2.js +6 -6
- package/lib/types/oas3.d.ts +4 -0
- package/lib/types/oas3.js +19 -19
- package/lib/types/oas3_1.d.ts +3 -0
- package/lib/types/oas3_1.js +20 -14
- package/lib/types/redocly-yaml.d.ts +8 -6
- package/lib/types/redocly-yaml.js +135 -36
- package/lib/typings/arazzo.d.ts +145 -27
- package/lib/typings/asyncapi3.d.ts +53 -0
- package/lib/typings/asyncapi3.js +2 -0
- package/lib/typings/common.d.ts +1 -1
- package/lib/typings/swagger.d.ts +2 -2
- package/lib/utils.d.ts +4 -3
- package/lib/utils.js +55 -72
- package/lib/visitors.d.ts +29 -1
- package/lib/visitors.js +21 -8
- package/lib/walk.d.ts +3 -3
- package/lib/walk.js +30 -23
- package/package.json +3 -3
- package/src/__tests__/bundle.test.ts +144 -2
- package/src/__tests__/lint.test.ts +29 -21
- package/src/__tests__/walk.test.ts +25 -25
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +7 -1
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +7 -1
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +8 -1
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +18 -13
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +17 -11
- package/src/benchmark/fork.js +4 -0
- package/src/benchmark/utils.ts +6 -5
- package/src/bundle.ts +19 -4
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +32 -2
- package/src/config/__tests__/__snapshots__/config.test.ts.snap +24 -0
- package/src/config/__tests__/config-resolvers.test.ts +82 -0
- package/src/config/__tests__/config.test.ts +11 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-commonjs-export-function.yaml +2 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-esm.yaml +2 -0
- package/src/config/__tests__/fixtures/resolve-config/plugin-esm.mjs +10 -0
- package/src/config/__tests__/fixtures/resolve-config/plugin-with-export-function.cjs +10 -0
- package/src/config/__tests__/resolve-plugins.test.ts +4 -1
- package/src/config/all.ts +13 -1
- package/src/config/builtIn.ts +9 -8
- package/src/config/config-resolvers.ts +92 -21
- package/src/config/config.ts +31 -13
- package/src/config/load.ts +2 -2
- package/src/config/minimal.ts +13 -0
- package/src/config/recommended-strict.ts +14 -1
- package/src/config/recommended.ts +14 -1
- package/src/config/rules.ts +12 -4
- package/src/config/types.ts +34 -5
- package/src/config/utils.ts +28 -2
- package/src/decorators/__tests__/filter-in.test.ts +29 -26
- package/src/decorators/__tests__/filter-out.test.ts +32 -23
- package/src/decorators/__tests__/media-type-examples-override.test.ts +45 -45
- package/src/decorators/__tests__/remove-x-internal.test.ts +8 -5
- package/src/decorators/async3/index.ts +1 -0
- package/src/decorators/common/filters/filter-helper.ts +2 -1
- package/src/decorators/common/filters/filter-in.ts +2 -1
- package/src/decorators/common/filters/filter-out.ts +2 -1
- package/src/decorators/common/info-description-override.ts +3 -2
- package/src/decorators/common/info-override.ts +1 -1
- package/src/decorators/common/media-type-examples-override.ts +4 -3
- package/src/decorators/common/operation-description-override.ts +5 -4
- package/src/decorators/common/registry-dependencies.ts +2 -2
- package/src/decorators/common/remove-x-internal.ts +5 -4
- package/src/decorators/common/tag-description-override.ts +3 -2
- package/src/decorators/oas2/__tests__/remove-unused-components.test.ts +3 -3
- package/src/decorators/oas2/index.ts +2 -1
- package/src/decorators/oas2/remove-unused-components.ts +1 -1
- package/src/decorators/oas3/__tests__/remove-unused-components.test.ts +4 -4
- package/src/decorators/oas3/index.ts +2 -1
- package/src/decorators/oas3/remove-unused-components.ts +1 -1
- package/src/format/codeframes.ts +2 -1
- package/src/format/format.ts +9 -4
- package/src/index.ts +2 -1
- package/src/js-yaml/index.ts +3 -1
- package/src/lint.ts +28 -4
- package/src/logger.ts +2 -2
- package/src/oas-types.ts +41 -22
- package/src/redocly/domains.ts +1 -1
- package/src/redocly/index.ts +3 -3
- package/src/redocly/registry-api.ts +5 -3
- package/src/ref-utils.ts +4 -2
- package/src/resolve.ts +6 -4
- package/src/rules/__tests__/no-unresolved-refs.test.ts +21 -7
- package/src/rules/ajv.ts +2 -1
- package/src/rules/arazzo/__tests__/parameters-no-body-inside-in.test.ts +76 -0
- package/src/rules/arazzo/index.ts +6 -3
- package/src/rules/async2/__tests__/channels-kebab-case.test.ts +9 -5
- package/src/rules/async2/__tests__/no-channel-trailing-slash.test.ts +3 -3
- package/src/rules/async2/channels-kebab-case.ts +2 -2
- package/src/rules/async2/index.ts +9 -6
- package/src/rules/async2/no-channel-trailing-slash.ts +2 -2
- package/src/rules/async3/__tests__/channels-kebab-case.test.ts +145 -0
- package/src/rules/async3/__tests__/no-channel-trailing-slash.test.ts +96 -0
- package/src/rules/async3/channels-kebab-case.ts +19 -0
- package/src/rules/async3/index.ts +26 -0
- package/src/rules/async3/no-channel-trailing-slash.ts +16 -0
- package/src/rules/common/__tests__/info-license-strict.test.ts +141 -0
- package/src/rules/common/__tests__/info-license.test.ts +2 -2
- package/src/rules/common/__tests__/license-url.test.ts +2 -2
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +1 -1
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +5 -5
- package/src/rules/common/__tests__/no-identical-paths.test.ts +1 -1
- package/src/rules/common/__tests__/no-invalid-parameter-examples.test.ts +1 -1
- package/src/rules/common/__tests__/no-invalid-schema-examples.test.ts +1 -1
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +4 -4
- package/src/rules/common/__tests__/no-required-schema-properties-undefined.test.ts +11 -11
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +8 -6
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +9 -7
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +2 -2
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +1 -1
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +4 -4
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +2 -2
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +2 -2
- package/src/rules/common/__tests__/path-not-include-query.test.ts +2 -2
- package/src/rules/common/__tests__/path-params-defined.test.ts +5 -5
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +6 -4
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +8 -8
- package/src/rules/common/__tests__/security-defined.test.ts +14 -8
- package/src/rules/common/__tests__/spec-strict-refs.test.ts +1 -1
- package/src/rules/common/__tests__/spec.test.ts +10 -10
- package/src/rules/common/__tests__/tag-description.test.ts +2 -2
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +6 -4
- package/src/rules/common/assertions/asserts.ts +5 -9
- package/src/rules/common/assertions/index.ts +12 -4
- package/src/rules/common/assertions/utils.ts +4 -2
- package/src/rules/common/info-contact.ts +2 -1
- package/src/rules/common/info-license-strict.ts +24 -0
- package/src/rules/common/info-license-url.ts +2 -1
- package/src/rules/common/info-license.ts +2 -1
- package/src/rules/common/no-ambiguous-paths.ts +4 -4
- package/src/rules/common/no-enum-type-mismatch.ts +5 -4
- package/src/rules/common/no-http-verbs-in-paths.ts +5 -4
- package/src/rules/common/no-identical-paths.ts +4 -4
- package/src/rules/common/no-invalid-parameter-examples.ts +3 -2
- package/src/rules/common/no-path-trailing-slash.ts +2 -2
- package/src/rules/common/no-required-schema-properties-undefined.ts +5 -4
- package/src/rules/common/operation-2xx-response.ts +3 -2
- package/src/rules/common/operation-4xx-response.ts +3 -2
- package/src/rules/common/operation-description.ts +5 -4
- package/src/rules/common/operation-operationId-unique.ts +4 -4
- package/src/rules/common/operation-operationId-url-safe.ts +5 -4
- package/src/rules/common/operation-operationId.ts +5 -4
- package/src/rules/common/operation-parameters-unique.ts +4 -4
- package/src/rules/common/operation-singular-tag.ts +4 -4
- package/src/rules/common/operation-summary.ts +5 -4
- package/src/rules/common/operation-tag-defined.ts +4 -4
- package/src/rules/common/parameter-description.ts +4 -4
- package/src/rules/common/path-declaration-must-exist.ts +2 -2
- package/src/rules/common/path-excludes-patterns.ts +4 -4
- package/src/rules/common/path-http-verbs-order.ts +4 -4
- package/src/rules/common/path-not-include-query.ts +2 -2
- package/src/rules/common/path-params-defined.ts +4 -4
- package/src/rules/common/path-segment-plural.ts +3 -2
- package/src/rules/common/paths-kebab-case.ts +2 -2
- package/src/rules/common/required-string-property-missing-min-length.ts +4 -4
- package/src/rules/common/response-contains-header.ts +5 -4
- package/src/rules/common/scalar-property-missing-example.ts +2 -1
- package/src/rules/common/security-defined.ts +5 -5
- package/src/rules/common/spec-strict-refs.ts +2 -1
- package/src/rules/common/spec.ts +4 -3
- package/src/rules/common/tag-description.ts +2 -1
- package/src/rules/common/tags-alphabetical.ts +4 -4
- package/src/rules/no-unresolved-refs.ts +4 -3
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +7 -5
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +14 -8
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +14 -8
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +3 -1
- package/src/rules/oas2/boolean-parameter-prefixes.ts +1 -1
- package/src/rules/oas2/index.ts +8 -6
- package/src/rules/oas2/request-mime-type.ts +2 -1
- package/src/rules/oas2/response-contains-property.ts +3 -2
- package/src/rules/oas2/response-mime-type.ts +2 -1
- package/src/rules/oas3/__tests__/array-parameter-serialization.test.ts +18 -6
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +7 -5
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +6 -6
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +2 -2
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +34 -24
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +3 -3
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +3 -3
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +1 -1
- package/src/rules/oas3/__tests__/operation-4xx-problem-details-rfc7807.test.ts +3 -3
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +34 -22
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +34 -20
- package/src/rules/oas3/__tests__/spec/spec.test.ts +12 -3
- package/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts +9 -3
- package/src/rules/oas3/__tests__/utils/lint-document-for-test.ts +1 -1
- package/src/rules/oas3/array-parameter-serialization.ts +3 -2
- package/src/rules/oas3/boolean-parameter-prefixes.ts +1 -1
- package/src/rules/oas3/component-name-unique.ts +3 -3
- package/src/rules/oas3/index.ts +42 -38
- package/src/rules/oas3/no-empty-servers.ts +1 -1
- package/src/rules/oas3/no-example-value-and-externalValue.ts +1 -1
- package/src/rules/oas3/no-invalid-media-type-examples.ts +6 -4
- package/src/rules/oas3/no-server-example.com.ts +2 -1
- package/src/rules/oas3/no-server-trailing-slash.ts +1 -1
- package/src/rules/oas3/no-server-variables-empty-enum.ts +2 -2
- package/src/rules/oas3/no-undefined-server-variable.ts +1 -1
- package/src/rules/oas3/no-unused-components.ts +2 -2
- package/src/rules/oas3/operation-4xx-problem-details-rfc7807.ts +2 -1
- package/src/rules/oas3/request-mime-type.ts +2 -1
- package/src/rules/oas3/response-contains-property.ts +3 -2
- package/src/rules/oas3/response-mime-type.ts +2 -1
- package/src/rules/oas3/spec-components-invalid-map-name.ts +3 -3
- package/src/rules/other/stats.ts +8 -6
- package/src/rules/spot/parameters-no-body-inside-in.ts +17 -0
- package/src/rules/utils.ts +41 -4
- package/src/types/arazzo.ts +257 -334
- package/src/types/{asyncapi.ts → asyncapi2.ts} +41 -35
- package/src/types/asyncapi3.ts +383 -0
- package/src/types/json-schema-adapter.ts +2 -2
- package/src/types/oas3.ts +4 -4
- package/src/types/oas3_1.ts +5 -4
- package/src/types/redocly-yaml.ts +21 -4
- package/src/typings/arazzo.ts +169 -41
- package/src/typings/asyncapi3.ts +61 -0
- package/src/typings/common.ts +1 -0
- package/src/typings/swagger.ts +2 -2
- package/src/utils.ts +5 -3
- package/src/visitors.ts +58 -1
- package/src/walk.ts +3 -3
- package/tsconfig.tsbuildinfo +1 -1
- package/lib/types/asyncapi.d.ts +0 -2
package/lib/config/config.js
CHANGED
|
@@ -33,25 +33,28 @@ class StyleguideConfig {
|
|
|
33
33
|
this.doNotResolveExamples = !!rawConfig.doNotResolveExamples;
|
|
34
34
|
this.recommendedFallback = rawConfig.recommendedFallback || false;
|
|
35
35
|
this.rules = {
|
|
36
|
-
[oas_types_1.SpecVersion.OAS2]:
|
|
37
|
-
[oas_types_1.SpecVersion.OAS3_0]:
|
|
38
|
-
[oas_types_1.SpecVersion.OAS3_1]:
|
|
39
|
-
[oas_types_1.SpecVersion.Async2]:
|
|
40
|
-
[oas_types_1.SpecVersion.
|
|
36
|
+
[oas_types_1.SpecVersion.OAS2]: { ...rawConfig.rules, ...rawConfig.oas2Rules },
|
|
37
|
+
[oas_types_1.SpecVersion.OAS3_0]: { ...rawConfig.rules, ...rawConfig.oas3_0Rules },
|
|
38
|
+
[oas_types_1.SpecVersion.OAS3_1]: { ...rawConfig.rules, ...rawConfig.oas3_1Rules },
|
|
39
|
+
[oas_types_1.SpecVersion.Async2]: { ...rawConfig.rules, ...rawConfig.async2Rules },
|
|
40
|
+
[oas_types_1.SpecVersion.Async3]: { ...rawConfig.rules, ...rawConfig.async3Rules },
|
|
41
|
+
[oas_types_1.SpecVersion.Arazzo]: { ...rawConfig.arazzoRules },
|
|
41
42
|
};
|
|
42
43
|
this.preprocessors = {
|
|
43
|
-
[oas_types_1.SpecVersion.OAS2]:
|
|
44
|
-
[oas_types_1.SpecVersion.OAS3_0]:
|
|
45
|
-
[oas_types_1.SpecVersion.OAS3_1]:
|
|
46
|
-
[oas_types_1.SpecVersion.Async2]:
|
|
47
|
-
[oas_types_1.SpecVersion.
|
|
44
|
+
[oas_types_1.SpecVersion.OAS2]: { ...rawConfig.preprocessors, ...rawConfig.oas2Preprocessors },
|
|
45
|
+
[oas_types_1.SpecVersion.OAS3_0]: { ...rawConfig.preprocessors, ...rawConfig.oas3_0Preprocessors },
|
|
46
|
+
[oas_types_1.SpecVersion.OAS3_1]: { ...rawConfig.preprocessors, ...rawConfig.oas3_1Preprocessors },
|
|
47
|
+
[oas_types_1.SpecVersion.Async2]: { ...rawConfig.preprocessors, ...rawConfig.async2Preprocessors },
|
|
48
|
+
[oas_types_1.SpecVersion.Async3]: { ...rawConfig.preprocessors, ...rawConfig.async3Preprocessors },
|
|
49
|
+
[oas_types_1.SpecVersion.Arazzo]: { ...rawConfig.arazzoPreprocessors },
|
|
48
50
|
};
|
|
49
51
|
this.decorators = {
|
|
50
|
-
[oas_types_1.SpecVersion.OAS2]:
|
|
51
|
-
[oas_types_1.SpecVersion.OAS3_0]:
|
|
52
|
-
[oas_types_1.SpecVersion.OAS3_1]:
|
|
53
|
-
[oas_types_1.SpecVersion.Async2]:
|
|
54
|
-
[oas_types_1.SpecVersion.
|
|
52
|
+
[oas_types_1.SpecVersion.OAS2]: { ...rawConfig.decorators, ...rawConfig.oas2Decorators },
|
|
53
|
+
[oas_types_1.SpecVersion.OAS3_0]: { ...rawConfig.decorators, ...rawConfig.oas3_0Decorators },
|
|
54
|
+
[oas_types_1.SpecVersion.OAS3_1]: { ...rawConfig.decorators, ...rawConfig.oas3_1Decorators },
|
|
55
|
+
[oas_types_1.SpecVersion.Async2]: { ...rawConfig.decorators, ...rawConfig.async2Decorators },
|
|
56
|
+
[oas_types_1.SpecVersion.Async3]: { ...rawConfig.decorators, ...rawConfig.async3Decorators },
|
|
57
|
+
[oas_types_1.SpecVersion.Arazzo]: { ...rawConfig.arazzoDecorators },
|
|
55
58
|
};
|
|
56
59
|
this.extendPaths = rawConfig.extendPaths || [];
|
|
57
60
|
this.pluginPaths = rawConfig.pluginPaths || [];
|
|
@@ -105,7 +108,11 @@ class StyleguideConfig {
|
|
|
105
108
|
const ruleIgnore = fileIgnore[problem.ruleId];
|
|
106
109
|
const ignored = ruleIgnore && ruleIgnore.has(loc.pointer);
|
|
107
110
|
return ignored
|
|
108
|
-
?
|
|
111
|
+
? {
|
|
112
|
+
...problem,
|
|
113
|
+
ignored,
|
|
114
|
+
}
|
|
115
|
+
: problem;
|
|
109
116
|
}
|
|
110
117
|
extendTypes(types, version) {
|
|
111
118
|
let extendedTypes = types;
|
|
@@ -128,6 +135,11 @@ class StyleguideConfig {
|
|
|
128
135
|
continue;
|
|
129
136
|
extendedTypes = plugin.typeExtension.async2(extendedTypes, version);
|
|
130
137
|
break;
|
|
138
|
+
case oas_types_1.SpecVersion.Async3:
|
|
139
|
+
if (!plugin.typeExtension.async3)
|
|
140
|
+
continue;
|
|
141
|
+
extendedTypes = plugin.typeExtension.async3(extendedTypes, version);
|
|
142
|
+
break;
|
|
131
143
|
case oas_types_1.SpecVersion.Arazzo:
|
|
132
144
|
if (!plugin.typeExtension.arazzo)
|
|
133
145
|
continue;
|
|
@@ -150,7 +162,7 @@ class StyleguideConfig {
|
|
|
150
162
|
};
|
|
151
163
|
}
|
|
152
164
|
else {
|
|
153
|
-
return
|
|
165
|
+
return { severity: 'error', ...settings };
|
|
154
166
|
}
|
|
155
167
|
}
|
|
156
168
|
getPreprocessorSettings(ruleId, oasVersion) {
|
|
@@ -163,7 +175,7 @@ class StyleguideConfig {
|
|
|
163
175
|
};
|
|
164
176
|
}
|
|
165
177
|
else {
|
|
166
|
-
return
|
|
178
|
+
return { severity: 'error', ...settings };
|
|
167
179
|
}
|
|
168
180
|
}
|
|
169
181
|
getDecoratorSettings(ruleId, oasVersion) {
|
|
@@ -176,7 +188,7 @@ class StyleguideConfig {
|
|
|
176
188
|
};
|
|
177
189
|
}
|
|
178
190
|
else {
|
|
179
|
-
return
|
|
191
|
+
return { severity: 'error', ...settings };
|
|
180
192
|
}
|
|
181
193
|
}
|
|
182
194
|
getUnusedRules() {
|
|
@@ -199,30 +211,37 @@ class StyleguideConfig {
|
|
|
199
211
|
case oas_types_1.SpecMajorVersion.OAS3:
|
|
200
212
|
// eslint-disable-next-line no-case-declarations
|
|
201
213
|
const oas3Rules = []; // default ruleset
|
|
202
|
-
this.plugins.forEach((p) =>
|
|
203
|
-
this.plugins.forEach((p) =>
|
|
204
|
-
this.plugins.forEach((p) =>
|
|
214
|
+
this.plugins.forEach((p) => p.preprocessors?.oas3 && oas3Rules.push(p.preprocessors.oas3));
|
|
215
|
+
this.plugins.forEach((p) => p.rules?.oas3 && oas3Rules.push(p.rules.oas3));
|
|
216
|
+
this.plugins.forEach((p) => p.decorators?.oas3 && oas3Rules.push(p.decorators.oas3));
|
|
205
217
|
return oas3Rules;
|
|
206
218
|
case oas_types_1.SpecMajorVersion.OAS2:
|
|
207
219
|
// eslint-disable-next-line no-case-declarations
|
|
208
220
|
const oas2Rules = []; // default ruleset
|
|
209
|
-
this.plugins.forEach((p) =>
|
|
210
|
-
this.plugins.forEach((p) =>
|
|
211
|
-
this.plugins.forEach((p) =>
|
|
221
|
+
this.plugins.forEach((p) => p.preprocessors?.oas2 && oas2Rules.push(p.preprocessors.oas2));
|
|
222
|
+
this.plugins.forEach((p) => p.rules?.oas2 && oas2Rules.push(p.rules.oas2));
|
|
223
|
+
this.plugins.forEach((p) => p.decorators?.oas2 && oas2Rules.push(p.decorators.oas2));
|
|
212
224
|
return oas2Rules;
|
|
213
225
|
case oas_types_1.SpecMajorVersion.Async2:
|
|
214
226
|
// eslint-disable-next-line no-case-declarations
|
|
215
|
-
const
|
|
216
|
-
this.plugins.forEach((p) =>
|
|
217
|
-
this.plugins.forEach((p) =>
|
|
218
|
-
this.plugins.forEach((p) =>
|
|
219
|
-
return
|
|
227
|
+
const asyncApi2Rules = []; // default ruleset
|
|
228
|
+
this.plugins.forEach((p) => p.preprocessors?.async2 && asyncApi2Rules.push(p.preprocessors.async2));
|
|
229
|
+
this.plugins.forEach((p) => p.rules?.async2 && asyncApi2Rules.push(p.rules.async2));
|
|
230
|
+
this.plugins.forEach((p) => p.decorators?.async2 && asyncApi2Rules.push(p.decorators.async2));
|
|
231
|
+
return asyncApi2Rules;
|
|
232
|
+
case oas_types_1.SpecMajorVersion.Async3:
|
|
233
|
+
// eslint-disable-next-line no-case-declarations
|
|
234
|
+
const asyncApi3Rules = []; // default ruleset
|
|
235
|
+
this.plugins.forEach((p) => p.preprocessors?.async3 && asyncApi3Rules.push(p.preprocessors.async3));
|
|
236
|
+
this.plugins.forEach((p) => p.rules?.async3 && asyncApi3Rules.push(p.rules.async3));
|
|
237
|
+
this.plugins.forEach((p) => p.decorators?.async3 && asyncApi3Rules.push(p.decorators.async3));
|
|
238
|
+
return asyncApi3Rules;
|
|
220
239
|
case oas_types_1.SpecMajorVersion.Arazzo:
|
|
221
240
|
// eslint-disable-next-line no-case-declarations
|
|
222
241
|
const arazzoRules = []; // default ruleset
|
|
223
|
-
this.plugins.forEach((p) =>
|
|
224
|
-
this.plugins.forEach((p) =>
|
|
225
|
-
this.plugins.forEach((p) =>
|
|
242
|
+
this.plugins.forEach((p) => p.preprocessors?.arazzo && arazzoRules.push(p.preprocessors.arazzo));
|
|
243
|
+
this.plugins.forEach((p) => p.rules?.arazzo && arazzoRules.push(p.rules.arazzo));
|
|
244
|
+
this.plugins.forEach((p) => p.decorators?.arazzo && arazzoRules.push(p.decorators.arazzo));
|
|
226
245
|
return arazzoRules;
|
|
227
246
|
}
|
|
228
247
|
}
|
|
@@ -262,7 +281,7 @@ class Config {
|
|
|
262
281
|
this.apis = rawConfig.apis || {};
|
|
263
282
|
this.styleguide = new StyleguideConfig(rawConfig.styleguide || {}, configFile);
|
|
264
283
|
this.theme = rawConfig.theme || {};
|
|
265
|
-
this.resolve = (0, utils_2.getResolveConfig)(rawConfig
|
|
284
|
+
this.resolve = (0, utils_2.getResolveConfig)(rawConfig?.resolve);
|
|
266
285
|
this.region = rawConfig.region;
|
|
267
286
|
this.organization = rawConfig.organization;
|
|
268
287
|
this.files = rawConfig.files || [];
|
package/lib/config/load.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { Config } from './config';
|
|
2
1
|
import { BaseResolver } from '../resolve';
|
|
2
|
+
import type { Config } from './config';
|
|
3
3
|
import type { Document, ResolvedRefMap } from '../resolve';
|
|
4
4
|
import type { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
|
|
5
5
|
import type { RawConfig, RawUniversalConfig, Region } from './types';
|
package/lib/config/load.js
CHANGED
|
@@ -1,15 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
-
});
|
|
10
|
-
};
|
|
11
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.
|
|
3
|
+
exports.CONFIG_FILE_NAMES = void 0;
|
|
4
|
+
exports.loadConfig = loadConfig;
|
|
5
|
+
exports.findConfig = findConfig;
|
|
6
|
+
exports.getConfig = getConfig;
|
|
7
|
+
exports.createConfig = createConfig;
|
|
13
8
|
const fs = require("fs");
|
|
14
9
|
const path = require("path");
|
|
15
10
|
const redocly_1 = require("../redocly");
|
|
@@ -21,92 +16,89 @@ const bundle_1 = require("../bundle");
|
|
|
21
16
|
const resolve_1 = require("../resolve");
|
|
22
17
|
const env_1 = require("../env");
|
|
23
18
|
const domains_1 = require("../redocly/domains");
|
|
24
|
-
function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files, region, externalRefResolver, }) {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
]
|
|
58
|
-
: []));
|
|
59
|
-
}
|
|
19
|
+
async function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files, region, externalRefResolver, }) {
|
|
20
|
+
if (customExtends !== undefined) {
|
|
21
|
+
rawConfig.styleguide = rawConfig.styleguide || {};
|
|
22
|
+
rawConfig.styleguide.extends = customExtends;
|
|
23
|
+
}
|
|
24
|
+
else if ((0, utils_1.isEmptyObject)(rawConfig)) {
|
|
25
|
+
rawConfig.styleguide = { extends: ['recommended'], recommendedFallback: true };
|
|
26
|
+
}
|
|
27
|
+
if (tokens?.length) {
|
|
28
|
+
if (!rawConfig.resolve)
|
|
29
|
+
rawConfig.resolve = {};
|
|
30
|
+
if (!rawConfig.resolve.http)
|
|
31
|
+
rawConfig.resolve.http = {};
|
|
32
|
+
rawConfig.resolve.http.headers = [...(rawConfig.resolve.http.headers ?? [])];
|
|
33
|
+
for (const item of tokens) {
|
|
34
|
+
const domain = domains_1.DOMAINS[item.region];
|
|
35
|
+
rawConfig.resolve.http.headers.push({
|
|
36
|
+
matches: `https://api.${domain}/registry/**`,
|
|
37
|
+
name: 'Authorization',
|
|
38
|
+
envVariable: undefined,
|
|
39
|
+
value: item.token,
|
|
40
|
+
},
|
|
41
|
+
//support redocly.com domain for future compatibility
|
|
42
|
+
...(item.region === 'us'
|
|
43
|
+
? [
|
|
44
|
+
{
|
|
45
|
+
matches: `https://api.redoc.ly/registry/**`,
|
|
46
|
+
name: 'Authorization',
|
|
47
|
+
envVariable: undefined,
|
|
48
|
+
value: item.token,
|
|
49
|
+
},
|
|
50
|
+
]
|
|
51
|
+
: []));
|
|
60
52
|
}
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
53
|
+
}
|
|
54
|
+
return (0, config_resolvers_1.resolveConfig)({
|
|
55
|
+
rawConfig: {
|
|
56
|
+
...rawConfig,
|
|
57
|
+
files: files ?? rawConfig.files,
|
|
58
|
+
region: region ?? rawConfig.region,
|
|
59
|
+
},
|
|
60
|
+
configPath,
|
|
61
|
+
externalRefResolver,
|
|
66
62
|
});
|
|
67
63
|
}
|
|
68
|
-
function loadConfig(options = {}) {
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
throw e;
|
|
98
|
-
}
|
|
99
|
-
throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
|
|
64
|
+
async function loadConfig(options = {}) {
|
|
65
|
+
const { configPath = findConfig(), customExtends, processRawConfig, files, region, externalRefResolver, } = options;
|
|
66
|
+
const { rawConfig, document, parsed, resolvedRefMap } = await getConfig({
|
|
67
|
+
configPath,
|
|
68
|
+
externalRefResolver,
|
|
69
|
+
});
|
|
70
|
+
const redoclyClient = env_1.isBrowser ? undefined : new redocly_1.RedoclyClient();
|
|
71
|
+
const tokens = redoclyClient && redoclyClient.hasTokens() ? redoclyClient.getAllTokens() : [];
|
|
72
|
+
const config = await addConfigMetadata({
|
|
73
|
+
rawConfig,
|
|
74
|
+
customExtends,
|
|
75
|
+
configPath,
|
|
76
|
+
tokens,
|
|
77
|
+
files,
|
|
78
|
+
region,
|
|
79
|
+
externalRefResolver,
|
|
80
|
+
});
|
|
81
|
+
if (document && parsed && resolvedRefMap && typeof processRawConfig === 'function') {
|
|
82
|
+
try {
|
|
83
|
+
await processRawConfig({
|
|
84
|
+
document,
|
|
85
|
+
resolvedRefMap,
|
|
86
|
+
config,
|
|
87
|
+
parsed,
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
catch (e) {
|
|
91
|
+
if (e instanceof utils_2.ConfigValidationError) {
|
|
92
|
+
throw e;
|
|
100
93
|
}
|
|
94
|
+
throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
|
|
101
95
|
}
|
|
102
|
-
|
|
103
|
-
|
|
96
|
+
}
|
|
97
|
+
return config;
|
|
104
98
|
}
|
|
105
|
-
exports.loadConfig = loadConfig;
|
|
106
99
|
exports.CONFIG_FILE_NAMES = ['redocly.yaml', 'redocly.yml', '.redocly.yaml', '.redocly.yml'];
|
|
107
100
|
function findConfig(dir) {
|
|
108
|
-
|
|
109
|
-
if (!((_a = fs === null || fs === void 0 ? void 0 : fs.hasOwnProperty) === null || _a === void 0 ? void 0 : _a.call(fs, 'existsSync')))
|
|
101
|
+
if (!fs?.hasOwnProperty?.('existsSync'))
|
|
110
102
|
return;
|
|
111
103
|
const existingConfigFiles = exports.CONFIG_FILE_NAMES.map((name) => dir ? path.resolve(dir, name) : name).filter(fs.existsSync);
|
|
112
104
|
if (existingConfigFiles.length > 1) {
|
|
@@ -118,35 +110,31 @@ function findConfig(dir) {
|
|
|
118
110
|
}
|
|
119
111
|
return existingConfigFiles[0];
|
|
120
112
|
}
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
|
|
143
|
-
}
|
|
144
|
-
});
|
|
113
|
+
async function getConfig(options = {}) {
|
|
114
|
+
const { configPath = findConfig(), externalRefResolver = new resolve_1.BaseResolver() } = options;
|
|
115
|
+
if (!configPath)
|
|
116
|
+
return { rawConfig: {} };
|
|
117
|
+
try {
|
|
118
|
+
const { document, resolvedRefMap } = await (0, config_resolvers_1.resolveConfigFileAndRefs)({
|
|
119
|
+
configPath,
|
|
120
|
+
externalRefResolver,
|
|
121
|
+
});
|
|
122
|
+
const bundledRefMap = (0, utils_2.deepCloneMapWithJSON)(resolvedRefMap);
|
|
123
|
+
const parsed = await (0, bundle_1.bundleConfig)(JSON.parse(JSON.stringify(document)), bundledRefMap);
|
|
124
|
+
return {
|
|
125
|
+
rawConfig: (0, utils_2.transformConfig)(parsed),
|
|
126
|
+
document,
|
|
127
|
+
parsed,
|
|
128
|
+
resolvedRefMap,
|
|
129
|
+
};
|
|
130
|
+
}
|
|
131
|
+
catch (e) {
|
|
132
|
+
throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
|
|
133
|
+
}
|
|
145
134
|
}
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
135
|
+
async function createConfig(config, options) {
|
|
136
|
+
return addConfigMetadata({
|
|
137
|
+
rawConfig: (0, utils_2.transformConfig)(typeof config === 'string' ? (0, js_yaml_1.parseYaml)(config) : config),
|
|
138
|
+
...options,
|
|
150
139
|
});
|
|
151
140
|
}
|
|
152
|
-
exports.createConfig = createConfig;
|
package/lib/config/minimal.js
CHANGED
|
@@ -5,6 +5,7 @@ const minimal = {
|
|
|
5
5
|
'info-contact': 'off',
|
|
6
6
|
'info-license': 'off',
|
|
7
7
|
'info-license-url': 'off',
|
|
8
|
+
'info-license-strict': 'off',
|
|
8
9
|
'tag-description': 'warn',
|
|
9
10
|
'tags-alphabetical': 'off',
|
|
10
11
|
'parameter-description': 'off',
|
|
@@ -90,6 +91,17 @@ const minimal = {
|
|
|
90
91
|
async2Rules: {
|
|
91
92
|
spec: 'error',
|
|
92
93
|
'info-contact': 'off',
|
|
94
|
+
'info-license-strict': 'off',
|
|
95
|
+
'operation-operationId': 'warn',
|
|
96
|
+
'tag-description': 'warn',
|
|
97
|
+
'tags-alphabetical': 'off',
|
|
98
|
+
'channels-kebab-case': 'off',
|
|
99
|
+
'no-channel-trailing-slash': 'off',
|
|
100
|
+
},
|
|
101
|
+
async3Rules: {
|
|
102
|
+
spec: 'error',
|
|
103
|
+
'info-contact': 'off',
|
|
104
|
+
'info-license-strict': 'off',
|
|
93
105
|
'operation-operationId': 'warn',
|
|
94
106
|
'tag-description': 'warn',
|
|
95
107
|
'tags-alphabetical': 'off',
|
|
@@ -98,6 +110,7 @@ const minimal = {
|
|
|
98
110
|
},
|
|
99
111
|
arazzoRules: {
|
|
100
112
|
spec: 'error',
|
|
113
|
+
'parameters-no-body-inside-in': 'off',
|
|
101
114
|
},
|
|
102
115
|
};
|
|
103
116
|
exports.default = minimal;
|
|
@@ -4,7 +4,8 @@ const recommendedStrict = {
|
|
|
4
4
|
rules: {
|
|
5
5
|
'info-contact': 'off',
|
|
6
6
|
'info-license': 'error',
|
|
7
|
-
'info-license-url': '
|
|
7
|
+
'info-license-url': 'off',
|
|
8
|
+
'info-license-strict': 'error',
|
|
8
9
|
'tag-description': 'error',
|
|
9
10
|
'tags-alphabetical': 'off',
|
|
10
11
|
'parameter-description': 'off',
|
|
@@ -90,6 +91,17 @@ const recommendedStrict = {
|
|
|
90
91
|
async2Rules: {
|
|
91
92
|
spec: 'error',
|
|
92
93
|
'info-contact': 'off',
|
|
94
|
+
'info-license-strict': 'error',
|
|
95
|
+
'operation-operationId': 'error',
|
|
96
|
+
'tag-description': 'error',
|
|
97
|
+
'tags-alphabetical': 'off',
|
|
98
|
+
'channels-kebab-case': 'off',
|
|
99
|
+
'no-channel-trailing-slash': 'off',
|
|
100
|
+
},
|
|
101
|
+
async3Rules: {
|
|
102
|
+
spec: 'error',
|
|
103
|
+
'info-contact': 'off',
|
|
104
|
+
'info-license-strict': 'error',
|
|
93
105
|
'operation-operationId': 'error',
|
|
94
106
|
'tag-description': 'error',
|
|
95
107
|
'tags-alphabetical': 'off',
|
|
@@ -98,6 +110,7 @@ const recommendedStrict = {
|
|
|
98
110
|
},
|
|
99
111
|
arazzoRules: {
|
|
100
112
|
spec: 'error',
|
|
113
|
+
'parameters-no-body-inside-in': 'off',
|
|
101
114
|
},
|
|
102
115
|
};
|
|
103
116
|
exports.default = recommendedStrict;
|
|
@@ -4,7 +4,8 @@ const recommended = {
|
|
|
4
4
|
rules: {
|
|
5
5
|
'info-contact': 'off',
|
|
6
6
|
'info-license': 'warn',
|
|
7
|
-
'info-license-url': '
|
|
7
|
+
'info-license-url': 'off',
|
|
8
|
+
'info-license-strict': 'warn',
|
|
8
9
|
'tag-description': 'warn',
|
|
9
10
|
'tags-alphabetical': 'off',
|
|
10
11
|
'parameter-description': 'off',
|
|
@@ -90,6 +91,17 @@ const recommended = {
|
|
|
90
91
|
async2Rules: {
|
|
91
92
|
spec: 'error',
|
|
92
93
|
'info-contact': 'off',
|
|
94
|
+
'info-license-strict': 'warn',
|
|
95
|
+
'operation-operationId': 'warn',
|
|
96
|
+
'tag-description': 'warn',
|
|
97
|
+
'tags-alphabetical': 'off',
|
|
98
|
+
'channels-kebab-case': 'off',
|
|
99
|
+
'no-channel-trailing-slash': 'off',
|
|
100
|
+
},
|
|
101
|
+
async3Rules: {
|
|
102
|
+
spec: 'error',
|
|
103
|
+
'info-contact': 'off',
|
|
104
|
+
'info-license-strict': 'warn',
|
|
93
105
|
'operation-operationId': 'warn',
|
|
94
106
|
'tag-description': 'warn',
|
|
95
107
|
'tags-alphabetical': 'off',
|
|
@@ -98,6 +110,7 @@ const recommended = {
|
|
|
98
110
|
},
|
|
99
111
|
arazzoRules: {
|
|
100
112
|
spec: 'error',
|
|
113
|
+
'parameters-no-body-inside-in': 'off',
|
|
101
114
|
},
|
|
102
115
|
};
|
|
103
116
|
exports.default = recommended;
|
package/lib/config/rules.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { StyleguideConfig } from './config';
|
|
1
|
+
import type { ArazzoRuleSet, Async2RuleSet, Async3RuleSet, Oas2RuleSet, Oas3RuleSet, SpecVersion } from '../oas-types';
|
|
2
|
+
import type { StyleguideConfig } from './config';
|
|
3
3
|
import type { ProblemSeverity } from '../walk';
|
|
4
4
|
type InitializedRule = {
|
|
5
5
|
severity: ProblemSeverity;
|
|
6
6
|
ruleId: string;
|
|
7
7
|
visitor: any;
|
|
8
8
|
};
|
|
9
|
-
export declare function initRules
|
|
9
|
+
export declare function initRules(rules: (Oas3RuleSet | Oas2RuleSet | Async2RuleSet | Async3RuleSet | ArazzoRuleSet)[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: SpecVersion): InitializedRule[];
|
|
10
10
|
export {};
|
package/lib/config/rules.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.initRules =
|
|
3
|
+
exports.initRules = initRules;
|
|
4
4
|
const utils_1 = require("../utils");
|
|
5
5
|
function initRules(rules, config, type, oasVersion) {
|
|
6
6
|
return rules
|
|
@@ -32,4 +32,3 @@ function initRules(rules, config, type, oasVersion) {
|
|
|
32
32
|
.flatMap((visitor) => visitor)
|
|
33
33
|
.filter(utils_1.isDefined);
|
|
34
34
|
}
|
|
35
|
-
exports.initRules = initRules;
|
package/lib/config/types.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
+
import type { Location } from '../ref-utils';
|
|
1
2
|
import type { ProblemSeverity, UserContext } from '../walk';
|
|
2
|
-
import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, ArazzoRuleSet, ArazzoPreprocessorsSet, ArazzoDecoratorsSet, RuleMap } from '../oas-types';
|
|
3
|
+
import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, Async3PreprocessorsSet, Async3DecoratorsSet, Async3RuleSet, ArazzoRuleSet, ArazzoPreprocessorsSet, ArazzoDecoratorsSet, RuleMap } from '../oas-types';
|
|
3
4
|
import type { NodeType } from '../types';
|
|
4
|
-
import { Location } from '../ref-utils';
|
|
5
5
|
import type { SkipFunctionContext } from '../visitors';
|
|
6
|
-
import { BuiltInAsync2RuleId, BuiltInCommonOASRuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId, BuiltInArazzoRuleId } from '../types/redocly-yaml';
|
|
6
|
+
import type { BuiltInAsync2RuleId, BuiltInAsync3RuleId, BuiltInCommonOASRuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId, BuiltInArazzoRuleId } from '../types/redocly-yaml';
|
|
7
7
|
export type RuleSeverity = ProblemSeverity | 'off';
|
|
8
8
|
export type RuleSettings = {
|
|
9
9
|
severity: RuleSeverity;
|
|
@@ -26,18 +26,21 @@ export type StyleguideRawConfig<T = undefined> = {
|
|
|
26
26
|
oas3_0Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
|
|
27
27
|
oas3_1Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
|
|
28
28
|
async2Rules?: RuleMap<BuiltInAsync2RuleId, RuleConfig, T>;
|
|
29
|
+
async3Rules?: RuleMap<BuiltInAsync3RuleId, RuleConfig, T>;
|
|
29
30
|
arazzoRules?: RuleMap<BuiltInArazzoRuleId, RuleConfig, T>;
|
|
30
31
|
preprocessors?: Record<string, PreprocessorConfig>;
|
|
31
32
|
oas2Preprocessors?: Record<string, PreprocessorConfig>;
|
|
32
33
|
oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
|
|
33
34
|
oas3_1Preprocessors?: Record<string, PreprocessorConfig>;
|
|
34
35
|
async2Preprocessors?: Record<string, PreprocessorConfig>;
|
|
36
|
+
async3Preprocessors?: Record<string, PreprocessorConfig>;
|
|
35
37
|
arazzoPreprocessors?: Record<string, PreprocessorConfig>;
|
|
36
38
|
decorators?: Record<string, DecoratorConfig>;
|
|
37
39
|
oas2Decorators?: Record<string, DecoratorConfig>;
|
|
38
40
|
oas3_0Decorators?: Record<string, DecoratorConfig>;
|
|
39
41
|
oas3_1Decorators?: Record<string, DecoratorConfig>;
|
|
40
42
|
async2Decorators?: Record<string, DecoratorConfig>;
|
|
43
|
+
async3Decorators?: Record<string, DecoratorConfig>;
|
|
41
44
|
arazzoDecorators?: Record<string, DecoratorConfig>;
|
|
42
45
|
};
|
|
43
46
|
export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
|
|
@@ -52,12 +55,14 @@ export type PreprocessorsConfig = {
|
|
|
52
55
|
oas3?: Oas3PreprocessorsSet;
|
|
53
56
|
oas2?: Oas2PreprocessorsSet;
|
|
54
57
|
async2?: Async2PreprocessorsSet;
|
|
58
|
+
async3?: Async3PreprocessorsSet;
|
|
55
59
|
arazzo?: ArazzoPreprocessorsSet;
|
|
56
60
|
};
|
|
57
61
|
export type DecoratorsConfig = {
|
|
58
62
|
oas3?: Oas3DecoratorsSet;
|
|
59
63
|
oas2?: Oas2DecoratorsSet;
|
|
60
64
|
async2?: Async2DecoratorsSet;
|
|
65
|
+
async3?: Async3DecoratorsSet;
|
|
61
66
|
arazzo?: ArazzoDecoratorsSet;
|
|
62
67
|
};
|
|
63
68
|
export type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: SpecVersion) => Record<string, NodeType>;
|
|
@@ -66,6 +71,7 @@ export type CustomRulesConfig = {
|
|
|
66
71
|
oas3?: Oas3RuleSet;
|
|
67
72
|
oas2?: Oas2RuleSet;
|
|
68
73
|
async2?: Async2RuleSet;
|
|
74
|
+
async3?: Async3RuleSet;
|
|
69
75
|
arazzo?: ArazzoRuleSet;
|
|
70
76
|
};
|
|
71
77
|
export type AssertionContext = Partial<UserContext> & SkipFunctionContext & {
|
|
@@ -86,6 +92,13 @@ export type Plugin = {
|
|
|
86
92
|
typeExtension?: TypeExtensionsConfig;
|
|
87
93
|
assertions?: AssertionsConfig;
|
|
88
94
|
};
|
|
95
|
+
type PluginCreatorOptions = {
|
|
96
|
+
contentDir: string;
|
|
97
|
+
};
|
|
98
|
+
export type PluginCreator = (options: PluginCreatorOptions) => Plugin | Promise<Plugin>;
|
|
99
|
+
export type ImportedPlugin = {
|
|
100
|
+
default?: PluginCreator;
|
|
101
|
+
} | PluginCreator | Plugin;
|
|
89
102
|
export type PluginStyleguideConfig<T = undefined> = Omit<StyleguideRawConfig<T>, 'plugins' | 'extends'>;
|
|
90
103
|
export type ResolveHeader = {
|
|
91
104
|
name: string;
|
|
@@ -162,5 +175,5 @@ export type ThemeRawConfig = {
|
|
|
162
175
|
openapi?: Record<string, any>;
|
|
163
176
|
mockServer?: Record<string, any>;
|
|
164
177
|
};
|
|
165
|
-
export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'arazzoRules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'arazzoPreprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | '
|
|
178
|
+
export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'async3Rules' | 'arazzoRules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'async3Preprocessors' | 'arazzoPreprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators' | 'async3Decorators' | 'arazzoDecorators';
|
|
166
179
|
export {};
|