@redocly/openapi-core 1.0.0-beta.100
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/README.md +25 -0
- package/__tests__/utils.ts +86 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.js +34 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.js +40 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.js +21 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +34 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.js +32 -0
- package/lib/benchmark/benches/recommended-oas3.bench.d.ts +3 -0
- package/lib/benchmark/benches/recommended-oas3.bench.js +21 -0
- package/lib/benchmark/benches/resolve-with-no-external.bench.d.ts +3 -0
- package/lib/benchmark/benches/resolve-with-no-external.bench.js +22 -0
- package/lib/benchmark/utils.d.ts +6 -0
- package/lib/benchmark/utils.js +31 -0
- package/lib/bundle.d.ts +47 -0
- package/lib/bundle.js +291 -0
- package/lib/config/all.d.ts +3 -0
- package/lib/config/all.js +65 -0
- package/lib/config/builtIn.d.ts +3 -0
- package/lib/config/builtIn.js +36 -0
- package/lib/config/config-resolvers.d.ts +16 -0
- package/lib/config/config-resolvers.js +242 -0
- package/lib/config/config.d.ts +64 -0
- package/lib/config/config.js +244 -0
- package/lib/config/index.d.ts +7 -0
- package/lib/config/index.js +19 -0
- package/lib/config/load.d.ts +6 -0
- package/lib/config/load.js +93 -0
- package/lib/config/minimal.d.ts +3 -0
- package/lib/config/minimal.js +58 -0
- package/lib/config/recommended.d.ts +3 -0
- package/lib/config/recommended.js +58 -0
- package/lib/config/rules.d.ts +7 -0
- package/lib/config/rules.js +34 -0
- package/lib/config/types.d.ts +113 -0
- package/lib/config/types.js +2 -0
- package/lib/config/utils.d.ts +13 -0
- package/lib/config/utils.js +160 -0
- package/lib/decorators/common/info-description-override.d.ts +2 -0
- package/lib/decorators/common/info-description-override.js +24 -0
- package/lib/decorators/common/operation-description-override.d.ts +2 -0
- package/lib/decorators/common/operation-description-override.js +29 -0
- package/lib/decorators/common/registry-dependencies.d.ts +2 -0
- package/lib/decorators/common/registry-dependencies.js +24 -0
- package/lib/decorators/common/remove-x-internal.d.ts +2 -0
- package/lib/decorators/common/remove-x-internal.js +58 -0
- package/lib/decorators/common/tag-description-override.d.ts +2 -0
- package/lib/decorators/common/tag-description-override.js +25 -0
- package/lib/decorators/oas2/index.d.ts +8 -0
- package/lib/decorators/oas2/index.js +15 -0
- package/lib/decorators/oas3/index.d.ts +8 -0
- package/lib/decorators/oas3/index.js +15 -0
- package/lib/format/codeframes.d.ts +22 -0
- package/lib/format/codeframes.js +177 -0
- package/lib/format/format.d.ts +20 -0
- package/lib/format/format.js +236 -0
- package/lib/index.d.ts +22 -0
- package/lib/index.js +69 -0
- package/lib/js-yaml/index.d.ts +3 -0
- package/lib/js-yaml/index.js +19 -0
- package/lib/lint.d.ts +23 -0
- package/lib/lint.js +99 -0
- package/lib/oas-types.d.ts +19 -0
- package/lib/oas-types.js +45 -0
- package/lib/redocly/index.d.ts +30 -0
- package/lib/redocly/index.js +153 -0
- package/lib/redocly/redocly-client-types.d.ts +8 -0
- package/lib/redocly/redocly-client-types.js +2 -0
- package/lib/redocly/registry-api-types.d.ts +29 -0
- package/lib/redocly/registry-api-types.js +2 -0
- package/lib/redocly/registry-api.d.ts +17 -0
- package/lib/redocly/registry-api.js +106 -0
- package/lib/ref-utils.d.ts +25 -0
- package/lib/ref-utils.js +75 -0
- package/lib/resolve.d.ts +66 -0
- package/lib/resolve.js +311 -0
- package/lib/rules/ajv.d.ts +10 -0
- package/lib/rules/ajv.js +80 -0
- package/lib/rules/common/assertions/asserts.d.ts +5 -0
- package/lib/rules/common/assertions/asserts.js +143 -0
- package/lib/rules/common/assertions/index.d.ts +2 -0
- package/lib/rules/common/assertions/index.js +52 -0
- package/lib/rules/common/assertions/utils.d.ts +20 -0
- package/lib/rules/common/assertions/utils.js +127 -0
- package/lib/rules/common/info-contact.d.ts +2 -0
- package/lib/rules/common/info-contact.js +17 -0
- package/lib/rules/common/info-description.d.ts +2 -0
- package/lib/rules/common/info-description.js +12 -0
- package/lib/rules/common/info-license-url.d.ts +2 -0
- package/lib/rules/common/info-license-url.js +17 -0
- package/lib/rules/common/license-url.d.ts +2 -0
- package/lib/rules/common/license-url.js +12 -0
- package/lib/rules/common/no-ambiguous-paths.d.ts +2 -0
- package/lib/rules/common/no-ambiguous-paths.js +45 -0
- package/lib/rules/common/no-enum-type-mismatch.d.ts +2 -0
- package/lib/rules/common/no-enum-type-mismatch.js +43 -0
- package/lib/rules/common/no-http-verbs-in-paths.d.ts +2 -0
- package/lib/rules/common/no-http-verbs-in-paths.js +33 -0
- package/lib/rules/common/no-identical-paths.d.ts +2 -0
- package/lib/rules/common/no-identical-paths.js +24 -0
- package/lib/rules/common/no-invalid-parameter-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-parameter-examples.js +25 -0
- package/lib/rules/common/no-invalid-schema-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-schema-examples.js +23 -0
- package/lib/rules/common/no-path-trailing-slash.d.ts +2 -0
- package/lib/rules/common/no-path-trailing-slash.js +16 -0
- package/lib/rules/common/operation-2xx-response.d.ts +2 -0
- package/lib/rules/common/operation-2xx-response.js +17 -0
- package/lib/rules/common/operation-4xx-response.d.ts +2 -0
- package/lib/rules/common/operation-4xx-response.js +17 -0
- package/lib/rules/common/operation-description.d.ts +2 -0
- package/lib/rules/common/operation-description.js +12 -0
- package/lib/rules/common/operation-operationId-unique.d.ts +2 -0
- package/lib/rules/common/operation-operationId-unique.js +20 -0
- package/lib/rules/common/operation-operationId-url-safe.d.ts +2 -0
- package/lib/rules/common/operation-operationId-url-safe.js +17 -0
- package/lib/rules/common/operation-operationId.d.ts +2 -0
- package/lib/rules/common/operation-operationId.js +16 -0
- package/lib/rules/common/operation-parameters-unique.d.ts +2 -0
- package/lib/rules/common/operation-parameters-unique.js +40 -0
- package/lib/rules/common/operation-security-defined.d.ts +2 -0
- package/lib/rules/common/operation-security-defined.js +38 -0
- package/lib/rules/common/operation-singular-tag.d.ts +2 -0
- package/lib/rules/common/operation-singular-tag.js +16 -0
- package/lib/rules/common/operation-summary.d.ts +2 -0
- package/lib/rules/common/operation-summary.js +12 -0
- package/lib/rules/common/operation-tag-defined.d.ts +2 -0
- package/lib/rules/common/operation-tag-defined.js +25 -0
- package/lib/rules/common/parameter-description.d.ts +2 -0
- package/lib/rules/common/parameter-description.js +22 -0
- package/lib/rules/common/path-declaration-must-exist.d.ts +2 -0
- package/lib/rules/common/path-declaration-must-exist.js +16 -0
- package/lib/rules/common/path-excludes-patterns.d.ts +2 -0
- package/lib/rules/common/path-excludes-patterns.js +22 -0
- package/lib/rules/common/path-http-verbs-order.d.ts +2 -0
- package/lib/rules/common/path-http-verbs-order.js +26 -0
- package/lib/rules/common/path-not-include-query.d.ts +2 -0
- package/lib/rules/common/path-not-include-query.js +18 -0
- package/lib/rules/common/path-params-defined.d.ts +2 -0
- package/lib/rules/common/path-params-defined.js +53 -0
- package/lib/rules/common/path-segment-plural.d.ts +2 -0
- package/lib/rules/common/path-segment-plural.js +32 -0
- package/lib/rules/common/paths-kebab-case.d.ts +2 -0
- package/lib/rules/common/paths-kebab-case.js +17 -0
- package/lib/rules/common/response-contains-header.d.ts +2 -0
- package/lib/rules/common/response-contains-header.js +29 -0
- package/lib/rules/common/scalar-property-missing-example.d.ts +2 -0
- package/lib/rules/common/scalar-property-missing-example.js +42 -0
- package/lib/rules/common/spec.d.ts +2 -0
- package/lib/rules/common/spec.js +136 -0
- package/lib/rules/common/tag-description.d.ts +2 -0
- package/lib/rules/common/tag-description.js +12 -0
- package/lib/rules/common/tags-alphabetical.d.ts +2 -0
- package/lib/rules/common/tags-alphabetical.js +20 -0
- package/lib/rules/no-unresolved-refs.d.ts +5 -0
- package/lib/rules/no-unresolved-refs.js +47 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.d.ts +5 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.js +22 -0
- package/lib/rules/oas2/index.d.ts +46 -0
- package/lib/rules/oas2/index.js +89 -0
- package/lib/rules/oas2/remove-unused-components.d.ts +2 -0
- package/lib/rules/oas2/remove-unused-components.js +73 -0
- package/lib/rules/oas2/request-mime-type.d.ts +2 -0
- package/lib/rules/oas2/request-mime-type.js +17 -0
- package/lib/rules/oas2/response-contains-property.d.ts +2 -0
- package/lib/rules/oas2/response-contains-property.js +38 -0
- package/lib/rules/oas2/response-mime-type.d.ts +2 -0
- package/lib/rules/oas2/response-mime-type.js +17 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.d.ts +5 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.js +24 -0
- package/lib/rules/oas3/index.d.ts +3 -0
- package/lib/rules/oas3/index.js +105 -0
- package/lib/rules/oas3/no-empty-servers.d.ts +2 -0
- package/lib/rules/oas3/no-empty-servers.js +23 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.d.ts +2 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.js +16 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.d.ts +2 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.js +37 -0
- package/lib/rules/oas3/no-server-example.com.d.ts +2 -0
- package/lib/rules/oas3/no-server-example.com.js +16 -0
- package/lib/rules/oas3/no-server-trailing-slash.d.ts +2 -0
- package/lib/rules/oas3/no-server-trailing-slash.js +18 -0
- package/lib/rules/oas3/no-servers-empty-enum.d.ts +2 -0
- package/lib/rules/oas3/no-servers-empty-enum.js +67 -0
- package/lib/rules/oas3/no-undefined-server-variable.d.ts +2 -0
- package/lib/rules/oas3/no-undefined-server-variable.js +32 -0
- package/lib/rules/oas3/no-unused-components.d.ts +2 -0
- package/lib/rules/oas3/no-unused-components.js +74 -0
- package/lib/rules/oas3/remove-unused-components.d.ts +2 -0
- package/lib/rules/oas3/remove-unused-components.js +83 -0
- package/lib/rules/oas3/request-mime-type.d.ts +2 -0
- package/lib/rules/oas3/request-mime-type.js +31 -0
- package/lib/rules/oas3/response-contains-property.d.ts +2 -0
- package/lib/rules/oas3/response-contains-property.js +40 -0
- package/lib/rules/oas3/response-mime-type.d.ts +2 -0
- package/lib/rules/oas3/response-mime-type.js +31 -0
- package/lib/rules/other/stats.d.ts +41 -0
- package/lib/rules/other/stats.js +44 -0
- package/lib/rules/utils.d.ts +17 -0
- package/lib/rules/utils.js +107 -0
- package/lib/types/index.d.ts +56 -0
- package/lib/types/index.js +77 -0
- package/lib/types/oas2.d.ts +2 -0
- package/lib/types/oas2.js +380 -0
- package/lib/types/oas3.d.ts +2 -0
- package/lib/types/oas3.js +479 -0
- package/lib/types/oas3_1.d.ts +2 -0
- package/lib/types/oas3_1.js +247 -0
- package/lib/types/redocly-yaml.d.ts +2 -0
- package/lib/types/redocly-yaml.js +533 -0
- package/lib/typings/common.d.ts +8 -0
- package/lib/typings/common.js +2 -0
- package/lib/typings/openapi.d.ts +299 -0
- package/lib/typings/openapi.js +2 -0
- package/lib/typings/swagger.d.ts +217 -0
- package/lib/typings/swagger.js +2 -0
- package/lib/utils.d.ts +41 -0
- package/lib/utils.js +177 -0
- package/lib/visitors.d.ts +175 -0
- package/lib/visitors.js +140 -0
- package/lib/walk.d.ts +87 -0
- package/lib/walk.js +253 -0
- package/package.json +56 -0
- package/src/__tests__/__snapshots__/bundle.test.ts.snap +255 -0
- package/src/__tests__/bundle.test.ts +156 -0
- package/src/__tests__/codeframes.test.ts +531 -0
- package/src/__tests__/fixtures/extension.js +24 -0
- package/src/__tests__/fixtures/refs/definitions.yaml +3 -0
- package/src/__tests__/fixtures/refs/examples.yaml +8 -0
- package/src/__tests__/fixtures/refs/external-request-body.yaml +13 -0
- package/src/__tests__/fixtures/refs/externalref.yaml +35 -0
- package/src/__tests__/fixtures/refs/hosted.yaml +35 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +21 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml +33 -0
- package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml +18 -0
- package/src/__tests__/fixtures/refs/param-b.yaml +1 -0
- package/src/__tests__/fixtures/refs/param-c.yaml +1 -0
- package/src/__tests__/fixtures/refs/rename.yaml +1 -0
- package/src/__tests__/fixtures/refs/requestBody.yaml +9 -0
- package/src/__tests__/fixtures/refs/schema-a.yaml +1 -0
- package/src/__tests__/fixtures/refs/simple.yaml +1 -0
- package/src/__tests__/fixtures/refs/vendor.schema.yaml +20 -0
- package/src/__tests__/fixtures/resolve/External.yaml +10 -0
- package/src/__tests__/fixtures/resolve/External2.yaml +4 -0
- package/src/__tests__/fixtures/resolve/description.md +3 -0
- package/src/__tests__/fixtures/resolve/externalInfo.yaml +4 -0
- package/src/__tests__/fixtures/resolve/externalLicense.yaml +1 -0
- package/src/__tests__/fixtures/resolve/openapi-with-back.yaml +13 -0
- package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml +5 -0
- package/src/__tests__/fixtures/resolve/openapi.yaml +28 -0
- package/src/__tests__/fixtures/resolve/schemas/type-a.yaml +10 -0
- package/src/__tests__/fixtures/resolve/schemas/type-b.yaml +6 -0
- package/src/__tests__/fixtures/resolve/transitive/a.yaml +1 -0
- package/src/__tests__/fixtures/resolve/transitive/components.yaml +5 -0
- package/src/__tests__/fixtures/resolve/transitive/schemas.yaml +3 -0
- package/src/__tests__/js-yaml.test.ts +71 -0
- package/src/__tests__/lint.test.ts +232 -0
- package/src/__tests__/login.test.ts +17 -0
- package/src/__tests__/normalizeVisitors.test.ts +151 -0
- package/src/__tests__/ref-utils.test.ts +120 -0
- package/src/__tests__/resolve-http.test.ts +77 -0
- package/src/__tests__/resolve.test.ts +405 -0
- package/src/__tests__/utils.test.ts +85 -0
- package/src/__tests__/walk.test.ts +1485 -0
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +35 -0
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +39 -0
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +20 -0
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +36 -0
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +32 -0
- package/src/benchmark/benches/rebilly.yaml +32267 -0
- package/src/benchmark/benches/recommended-oas3.bench.ts +22 -0
- package/src/benchmark/benches/resolve-with-no-external.bench.ts +23 -0
- package/src/benchmark/benchmark.js +307 -0
- package/src/benchmark/colors.js +29 -0
- package/src/benchmark/fork.js +83 -0
- package/src/benchmark/utils.ts +36 -0
- package/src/bundle.ts +386 -0
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +157 -0
- package/src/config/__tests__/config-resolvers.test.ts +429 -0
- package/src/config/__tests__/config.test.ts +244 -0
- package/src/config/__tests__/fixtures/plugin-config.yaml +3 -0
- package/src/config/__tests__/fixtures/plugin.js +56 -0
- package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +12 -0
- package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +67 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +8 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +19 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +10 -0
- package/src/config/__tests__/fixtures/resolve-config/plugin.js +66 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +4 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +5 -0
- package/src/config/__tests__/load.test.ts +83 -0
- package/src/config/__tests__/resolve-plugins.test.ts +27 -0
- package/src/config/all.ts +66 -0
- package/src/config/builtIn.ts +37 -0
- package/src/config/config-resolvers.ts +359 -0
- package/src/config/config.ts +312 -0
- package/src/config/index.ts +7 -0
- package/src/config/load.ts +84 -0
- package/src/config/minimal.ts +58 -0
- package/src/config/recommended.ts +58 -0
- package/src/config/rules.ts +46 -0
- package/src/config/types.ts +168 -0
- package/src/config/utils.ts +208 -0
- package/src/decorators/__tests__/remove-x-internal.test.ts +316 -0
- package/src/decorators/common/info-description-override.ts +24 -0
- package/src/decorators/common/operation-description-override.ts +30 -0
- package/src/decorators/common/registry-dependencies.ts +25 -0
- package/src/decorators/common/remove-x-internal.ts +59 -0
- package/src/decorators/common/tag-description-override.ts +25 -0
- package/src/decorators/oas2/index.ts +14 -0
- package/src/decorators/oas3/index.ts +14 -0
- package/src/format/codeframes.ts +210 -0
- package/src/format/format.ts +339 -0
- package/src/index.ts +68 -0
- package/src/js-yaml/index.ts +18 -0
- package/src/lint.ts +125 -0
- package/src/oas-types.ts +62 -0
- package/src/redocly/__tests__/redocly-client.test.ts +140 -0
- package/src/redocly/index.ts +182 -0
- package/src/redocly/redocly-client-types.ts +10 -0
- package/src/redocly/registry-api-types.ts +32 -0
- package/src/redocly/registry-api.ts +134 -0
- package/src/ref-utils.ts +80 -0
- package/src/resolve.ts +378 -0
- package/src/rules/__tests__/fixtures/invalid-yaml.yaml +1 -0
- package/src/rules/__tests__/fixtures/ref.yaml +1 -0
- package/src/rules/__tests__/no-unresolved-refs.test.ts +168 -0
- package/src/rules/ajv.ts +103 -0
- package/src/rules/common/__tests__/info-description.test.ts +102 -0
- package/src/rules/common/__tests__/info-license.test.ts +62 -0
- package/src/rules/common/__tests__/license-url.test.ts +63 -0
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +96 -0
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +209 -0
- package/src/rules/common/__tests__/no-identical-paths.test.ts +58 -0
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +85 -0
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +91 -0
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +107 -0
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +76 -0
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +45 -0
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +167 -0
- package/src/rules/common/__tests__/operation-security-defined.test.ts +69 -0
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +72 -0
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +95 -0
- package/src/rules/common/__tests__/path-not-include-query.test.ts +64 -0
- package/src/rules/common/__tests__/path-params-defined.test.ts +133 -0
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +108 -0
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +264 -0
- package/src/rules/common/__tests__/spec.test.ts +62 -0
- package/src/rules/common/__tests__/tag-description.test.ts +65 -0
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +64 -0
- package/src/rules/common/assertions/__tests__/asserts.test.ts +231 -0
- package/src/rules/common/assertions/__tests__/index.test.ts +65 -0
- package/src/rules/common/assertions/__tests__/utils.test.ts +89 -0
- package/src/rules/common/assertions/asserts.ts +137 -0
- package/src/rules/common/assertions/index.ts +75 -0
- package/src/rules/common/assertions/utils.ts +167 -0
- package/src/rules/common/info-contact.ts +15 -0
- package/src/rules/common/info-description.ts +10 -0
- package/src/rules/common/info-license-url.ts +15 -0
- package/src/rules/common/license-url.ts +10 -0
- package/src/rules/common/no-ambiguous-paths.ts +50 -0
- package/src/rules/common/no-enum-type-mismatch.ts +49 -0
- package/src/rules/common/no-http-verbs-in-paths.ts +36 -0
- package/src/rules/common/no-identical-paths.ts +24 -0
- package/src/rules/common/no-invalid-parameter-examples.ts +36 -0
- package/src/rules/common/no-invalid-schema-examples.ts +27 -0
- package/src/rules/common/no-path-trailing-slash.ts +15 -0
- package/src/rules/common/operation-2xx-response.ts +16 -0
- package/src/rules/common/operation-4xx-response.ts +17 -0
- package/src/rules/common/operation-description.ts +13 -0
- package/src/rules/common/operation-operationId-unique.ts +21 -0
- package/src/rules/common/operation-operationId-url-safe.ts +19 -0
- package/src/rules/common/operation-operationId.ts +17 -0
- package/src/rules/common/operation-parameters-unique.ts +48 -0
- package/src/rules/common/operation-security-defined.ts +45 -0
- package/src/rules/common/operation-singular-tag.ts +17 -0
- package/src/rules/common/operation-summary.ts +13 -0
- package/src/rules/common/operation-tag-defined.ts +26 -0
- package/src/rules/common/parameter-description.ts +22 -0
- package/src/rules/common/path-declaration-must-exist.ts +15 -0
- package/src/rules/common/path-excludes-patterns.ts +23 -0
- package/src/rules/common/path-http-verbs-order.ts +30 -0
- package/src/rules/common/path-not-include-query.ts +17 -0
- package/src/rules/common/path-params-defined.ts +58 -0
- package/src/rules/common/path-segment-plural.ts +31 -0
- package/src/rules/common/paths-kebab-case.ts +16 -0
- package/src/rules/common/response-contains-header.ts +30 -0
- package/src/rules/common/scalar-property-missing-example.ts +58 -0
- package/src/rules/common/spec.ts +143 -0
- package/src/rules/common/tag-description.ts +10 -0
- package/src/rules/common/tags-alphabetical.ts +20 -0
- package/src/rules/no-unresolved-refs.ts +51 -0
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +110 -0
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +174 -0
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +155 -0
- package/src/rules/oas2/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas2/__tests__/spec/info.test.ts +355 -0
- package/src/rules/oas2/__tests__/spec/operation.test.ts +123 -0
- package/src/rules/oas2/__tests__/spec/paths.test.ts +245 -0
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +31 -0
- package/src/rules/oas2/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas2/boolean-parameter-prefixes.ts +26 -0
- package/src/rules/oas2/index.ts +89 -0
- package/src/rules/oas2/remove-unused-components.ts +76 -0
- package/src/rules/oas2/request-mime-type.ts +17 -0
- package/src/rules/oas2/response-contains-property.ts +36 -0
- package/src/rules/oas2/response-mime-type.ts +17 -0
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +111 -0
- package/src/rules/oas3/__tests__/fixtures/common.yaml +11 -0
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +205 -0
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +65 -0
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +392 -0
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +60 -0
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +79 -0
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +131 -0
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +273 -0
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +403 -0
- package/src/rules/oas3/__tests__/spec/callbacks.test.ts +41 -0
- package/src/rules/oas3/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas3/__tests__/spec/info.test.ts +391 -0
- package/src/rules/oas3/__tests__/spec/operation.test.ts +253 -0
- package/src/rules/oas3/__tests__/spec/paths.test.ts +284 -0
- package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +77 -0
- package/src/rules/oas3/__tests__/spec/servers.test.ts +499 -0
- package/src/rules/oas3/__tests__/spec/spec.test.ts +288 -0
- package/src/rules/oas3/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas3/boolean-parameter-prefixes.ts +28 -0
- package/src/rules/oas3/index.ts +105 -0
- package/src/rules/oas3/no-empty-servers.ts +22 -0
- package/src/rules/oas3/no-example-value-and-externalValue.ts +14 -0
- package/src/rules/oas3/no-invalid-media-type-examples.ts +41 -0
- package/src/rules/oas3/no-server-example.com.ts +14 -0
- package/src/rules/oas3/no-server-trailing-slash.ts +15 -0
- package/src/rules/oas3/no-servers-empty-enum.ts +67 -0
- package/src/rules/oas3/no-undefined-server-variable.ts +30 -0
- package/src/rules/oas3/no-unused-components.ts +75 -0
- package/src/rules/oas3/remove-unused-components.ts +84 -0
- package/src/rules/oas3/request-mime-type.ts +31 -0
- package/src/rules/oas3/response-contains-property.ts +38 -0
- package/src/rules/oas3/response-mime-type.ts +31 -0
- package/src/rules/other/stats.ts +44 -0
- package/src/rules/utils.ts +123 -0
- package/src/types/index.ts +138 -0
- package/src/types/oas2.ts +397 -0
- package/src/types/oas3.ts +510 -0
- package/src/types/oas3_1.ts +253 -0
- package/src/types/redocly-yaml.ts +647 -0
- package/src/typings/common.ts +9 -0
- package/src/typings/openapi.ts +298 -0
- package/src/typings/swagger.ts +236 -0
- package/src/utils.ts +193 -0
- package/src/visitors.ts +448 -0
- package/src/walk.ts +416 -0
- package/tsconfig.json +8 -0
- package/tsconfig.tsbuildinfo +1 -0
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getAstNodeByPointer = exports.getLineColLocation = exports.getCodeframe = void 0;
|
|
4
|
+
const colorette_1 = require("colorette");
|
|
5
|
+
const yamlAst = require("yaml-ast-parser");
|
|
6
|
+
const ref_utils_1 = require("../ref-utils");
|
|
7
|
+
const MAX_LINE_LENGTH = 150;
|
|
8
|
+
const MAX_CODEFRAME_LINES = 3;
|
|
9
|
+
// TODO: temporary
|
|
10
|
+
function parsePointer(pointer) {
|
|
11
|
+
return pointer.substr(2).split('/').map(ref_utils_1.unescapePointer);
|
|
12
|
+
}
|
|
13
|
+
function getCodeframe(location, color) {
|
|
14
|
+
colorette_1.options.enabled = color;
|
|
15
|
+
const { start, end = { line: start.line, col: start.col + 1 }, source } = location;
|
|
16
|
+
const lines = source.getLines();
|
|
17
|
+
const startLineNum = start.line;
|
|
18
|
+
const endLineNum = Math.max(Math.min(end.line, lines.length), start.line);
|
|
19
|
+
let skipLines = Math.max(endLineNum - startLineNum - MAX_CODEFRAME_LINES + 1, 0);
|
|
20
|
+
if (skipLines < 2)
|
|
21
|
+
skipLines = 0; // do not skip one line
|
|
22
|
+
// Lines specified like this: ["prefix", "string"],
|
|
23
|
+
const prefixedLines = [];
|
|
24
|
+
let currentPad = 0;
|
|
25
|
+
for (let i = startLineNum; i <= endLineNum; i++) {
|
|
26
|
+
if (skipLines > 0 && i >= endLineNum - skipLines)
|
|
27
|
+
break;
|
|
28
|
+
const line = lines[i - 1] || '';
|
|
29
|
+
if (line !== '')
|
|
30
|
+
currentPad = padSize(line);
|
|
31
|
+
let startIdx = i === startLineNum ? start.col - 1 : currentPad;
|
|
32
|
+
let endIdx = i === endLineNum ? end.col - 1 : line.length;
|
|
33
|
+
prefixedLines.push([`${i}`, markLine(line, startIdx, endIdx, colorette_1.red)]);
|
|
34
|
+
if (!color)
|
|
35
|
+
prefixedLines.push(['', underlineLine(line, startIdx, endIdx)]);
|
|
36
|
+
}
|
|
37
|
+
if (skipLines > 0) {
|
|
38
|
+
prefixedLines.push([`…`, `${whitespace(currentPad)}${colorette_1.gray(`< ${skipLines} more lines >`)}`]);
|
|
39
|
+
// print last line
|
|
40
|
+
prefixedLines.push([`${endLineNum}`, markLine(lines[endLineNum - 1], -1, end.col - 1, colorette_1.red)]);
|
|
41
|
+
if (!color)
|
|
42
|
+
prefixedLines.push(['', underlineLine(lines[endLineNum - 1], -1, end.col - 1)]);
|
|
43
|
+
}
|
|
44
|
+
return printPrefixedLines([
|
|
45
|
+
[`${startLineNum - 2}`, markLine(lines[startLineNum - 1 - 2])],
|
|
46
|
+
[`${startLineNum - 1}`, markLine(lines[startLineNum - 1 - 1])],
|
|
47
|
+
...prefixedLines,
|
|
48
|
+
[`${endLineNum + 1}`, markLine(lines[endLineNum - 1 + 1])],
|
|
49
|
+
[`${endLineNum + 2}`, markLine(lines[endLineNum - 1 + 2])],
|
|
50
|
+
]);
|
|
51
|
+
function markLine(line, startIdx = -1, endIdx = +Infinity, variant = colorette_1.gray) {
|
|
52
|
+
if (!color)
|
|
53
|
+
return line;
|
|
54
|
+
if (!line)
|
|
55
|
+
return line;
|
|
56
|
+
if (startIdx === -1) {
|
|
57
|
+
startIdx = padSize(line);
|
|
58
|
+
}
|
|
59
|
+
endIdx = Math.min(endIdx, line.length);
|
|
60
|
+
return (line.substr(0, startIdx) + variant(line.substring(startIdx, endIdx)) + line.substr(endIdx));
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
exports.getCodeframe = getCodeframe;
|
|
64
|
+
function printPrefixedLines(lines) {
|
|
65
|
+
const existingLines = lines.filter(([_, line]) => line !== undefined);
|
|
66
|
+
const padLen = Math.max(...existingLines.map(([prefix]) => prefix.length));
|
|
67
|
+
const dedentLen = Math.min(...existingLines.map(([_, line]) => (line === '' ? Infinity : padSize(line))));
|
|
68
|
+
return existingLines
|
|
69
|
+
.map(([prefix, line]) => colorette_1.gray(leftPad(padLen, prefix) + ' |') +
|
|
70
|
+
(line ? ' ' + limitLineLength(line.substring(dedentLen)) : ''))
|
|
71
|
+
.join('\n');
|
|
72
|
+
}
|
|
73
|
+
function limitLineLength(line, maxLen = MAX_LINE_LENGTH) {
|
|
74
|
+
const overflowLen = line.length - maxLen;
|
|
75
|
+
if (overflowLen > 0) {
|
|
76
|
+
const charsMoreText = colorette_1.gray(`...<${overflowLen} chars>`);
|
|
77
|
+
return line.substring(0, maxLen - charsMoreText.length) + charsMoreText;
|
|
78
|
+
}
|
|
79
|
+
else {
|
|
80
|
+
return line;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
function underlineLine(line, startIdx = -1, endIdx = +Infinity) {
|
|
84
|
+
if (startIdx === -1) {
|
|
85
|
+
startIdx = padSize(line);
|
|
86
|
+
}
|
|
87
|
+
endIdx = Math.min(endIdx, line.length);
|
|
88
|
+
return whitespace(startIdx) + '^'.repeat(Math.max(endIdx - startIdx, 1));
|
|
89
|
+
}
|
|
90
|
+
function whitespace(len) {
|
|
91
|
+
return ' '.repeat(len);
|
|
92
|
+
}
|
|
93
|
+
function leftPad(len, str) {
|
|
94
|
+
return whitespace(len - str.length) + str;
|
|
95
|
+
}
|
|
96
|
+
function padSize(line) {
|
|
97
|
+
for (let i = 0; i < line.length; i++) {
|
|
98
|
+
if (line[i] !== ' ')
|
|
99
|
+
return i;
|
|
100
|
+
}
|
|
101
|
+
return line.length;
|
|
102
|
+
}
|
|
103
|
+
function getLineColLocation(location) {
|
|
104
|
+
var _a, _b;
|
|
105
|
+
if (location.pointer === undefined)
|
|
106
|
+
return location;
|
|
107
|
+
const { source, pointer, reportOnKey } = location;
|
|
108
|
+
const ast = source.getAst(yamlAst.safeLoad);
|
|
109
|
+
const astNode = getAstNodeByPointer(ast, pointer, !!reportOnKey);
|
|
110
|
+
return Object.assign(Object.assign(Object.assign({}, location), { pointer: undefined }), positionsToLoc(source.body, (_a = astNode === null || astNode === void 0 ? void 0 : astNode.startPosition) !== null && _a !== void 0 ? _a : 1, (_b = astNode === null || astNode === void 0 ? void 0 : astNode.endPosition) !== null && _b !== void 0 ? _b : 1));
|
|
111
|
+
}
|
|
112
|
+
exports.getLineColLocation = getLineColLocation;
|
|
113
|
+
function positionsToLoc(source, startPos, endPos) {
|
|
114
|
+
let currentLine = 1;
|
|
115
|
+
let currentCol = 1;
|
|
116
|
+
let start = { line: 1, col: 1 };
|
|
117
|
+
for (let i = 0; i < endPos - 1; i++) {
|
|
118
|
+
if (i === startPos - 1) {
|
|
119
|
+
start = { line: currentLine, col: currentCol + 1 };
|
|
120
|
+
}
|
|
121
|
+
if (source[i] === '\n') {
|
|
122
|
+
currentLine++;
|
|
123
|
+
currentCol = 1;
|
|
124
|
+
if (i === startPos - 1) {
|
|
125
|
+
start = { line: currentLine, col: currentCol };
|
|
126
|
+
}
|
|
127
|
+
if (source[i + 1] === '\r')
|
|
128
|
+
i++; // TODO: test it
|
|
129
|
+
continue;
|
|
130
|
+
}
|
|
131
|
+
currentCol++;
|
|
132
|
+
}
|
|
133
|
+
const end = startPos === endPos ? Object.assign({}, start) : { line: currentLine, col: currentCol + 1 };
|
|
134
|
+
return { start, end };
|
|
135
|
+
}
|
|
136
|
+
function getAstNodeByPointer(root, pointer, reportOnKey) {
|
|
137
|
+
const pointerSegments = parsePointer(pointer);
|
|
138
|
+
if (root === undefined) {
|
|
139
|
+
return undefined;
|
|
140
|
+
}
|
|
141
|
+
let currentNode = root;
|
|
142
|
+
for (const key of pointerSegments) {
|
|
143
|
+
if (currentNode.kind === yamlAst.Kind.MAP) {
|
|
144
|
+
const mapping = currentNode.mappings.find((m) => m.key.value === key);
|
|
145
|
+
if (!mapping)
|
|
146
|
+
break;
|
|
147
|
+
currentNode = mapping;
|
|
148
|
+
if (!(mapping === null || mapping === void 0 ? void 0 : mapping.value))
|
|
149
|
+
break; // If node has value - return value, if not - return node itself
|
|
150
|
+
currentNode = mapping.value;
|
|
151
|
+
}
|
|
152
|
+
else if (currentNode.kind === yamlAst.Kind.SEQ) {
|
|
153
|
+
const elem = currentNode.items[parseInt(key, 10)];
|
|
154
|
+
if (!elem)
|
|
155
|
+
break;
|
|
156
|
+
currentNode = elem;
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
if (!reportOnKey) {
|
|
160
|
+
return currentNode;
|
|
161
|
+
}
|
|
162
|
+
else {
|
|
163
|
+
const parent = currentNode.parent;
|
|
164
|
+
if (!parent)
|
|
165
|
+
return currentNode;
|
|
166
|
+
if (parent.kind === yamlAst.Kind.SEQ) {
|
|
167
|
+
return currentNode;
|
|
168
|
+
}
|
|
169
|
+
else if (parent.kind === yamlAst.Kind.MAPPING) {
|
|
170
|
+
return parent.key;
|
|
171
|
+
}
|
|
172
|
+
else {
|
|
173
|
+
return currentNode;
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
exports.getAstNodeByPointer = getAstNodeByPointer;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { NormalizedProblem } from '../walk';
|
|
2
|
+
export declare type Totals = {
|
|
3
|
+
errors: number;
|
|
4
|
+
warnings: number;
|
|
5
|
+
ignored: number;
|
|
6
|
+
};
|
|
7
|
+
export declare type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate';
|
|
8
|
+
export declare function getTotals(problems: (NormalizedProblem & {
|
|
9
|
+
ignored?: boolean;
|
|
10
|
+
})[]): Totals;
|
|
11
|
+
export declare function formatProblems(problems: (NormalizedProblem & {
|
|
12
|
+
ignored?: boolean;
|
|
13
|
+
})[], opts: {
|
|
14
|
+
maxProblems?: number;
|
|
15
|
+
cwd?: string;
|
|
16
|
+
format?: OutputFormat;
|
|
17
|
+
color?: boolean;
|
|
18
|
+
totals: Totals;
|
|
19
|
+
version: string;
|
|
20
|
+
}): void;
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.formatProblems = exports.getTotals = void 0;
|
|
4
|
+
const path = require("path");
|
|
5
|
+
const colorette_1 = require("colorette");
|
|
6
|
+
const coreVersion = require('../../package.json').version;
|
|
7
|
+
const codeframes_1 = require("./codeframes");
|
|
8
|
+
const config_1 = require("../config");
|
|
9
|
+
const ERROR_MESSAGE = {
|
|
10
|
+
INVALID_SEVERITY_LEVEL: 'Invalid severity level; accepted values: error or warn',
|
|
11
|
+
};
|
|
12
|
+
const BG_COLORS = {
|
|
13
|
+
warn: (str) => colorette_1.bgYellow(colorette_1.black(str)),
|
|
14
|
+
error: colorette_1.bgRed,
|
|
15
|
+
};
|
|
16
|
+
const COLORS = {
|
|
17
|
+
warn: colorette_1.yellow,
|
|
18
|
+
error: colorette_1.red,
|
|
19
|
+
};
|
|
20
|
+
const SEVERITY_NAMES = {
|
|
21
|
+
warn: 'Warning',
|
|
22
|
+
error: 'Error',
|
|
23
|
+
};
|
|
24
|
+
const CODECLIMATE_SEVERITY_MAPPING = {
|
|
25
|
+
error: 'critical',
|
|
26
|
+
warn: 'minor',
|
|
27
|
+
};
|
|
28
|
+
const MAX_SUGGEST = 5;
|
|
29
|
+
function severityToNumber(severity) {
|
|
30
|
+
return severity === 'error' ? 1 : 2;
|
|
31
|
+
}
|
|
32
|
+
function getTotals(problems) {
|
|
33
|
+
let errors = 0;
|
|
34
|
+
let warnings = 0;
|
|
35
|
+
let ignored = 0;
|
|
36
|
+
for (const m of problems) {
|
|
37
|
+
if (m.ignored) {
|
|
38
|
+
ignored++;
|
|
39
|
+
continue;
|
|
40
|
+
}
|
|
41
|
+
if (m.severity === 'error')
|
|
42
|
+
errors++;
|
|
43
|
+
if (m.severity === 'warn')
|
|
44
|
+
warnings++;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
errors,
|
|
48
|
+
warnings,
|
|
49
|
+
ignored,
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
exports.getTotals = getTotals;
|
|
53
|
+
function formatProblems(problems, opts) {
|
|
54
|
+
const { maxProblems = 100, cwd = process.cwd(), format = 'codeframe', color = colorette_1.options.enabled, totals = getTotals(problems), version = coreVersion, } = opts;
|
|
55
|
+
colorette_1.options.enabled = color; // force colors if specified
|
|
56
|
+
const totalProblems = problems.length;
|
|
57
|
+
problems = problems.filter((m) => !m.ignored);
|
|
58
|
+
const ignoredProblems = totalProblems - problems.length;
|
|
59
|
+
problems = problems
|
|
60
|
+
.sort((a, b) => severityToNumber(a.severity) - severityToNumber(b.severity))
|
|
61
|
+
.slice(0, maxProblems);
|
|
62
|
+
if (!totalProblems && format !== 'json')
|
|
63
|
+
return;
|
|
64
|
+
switch (format) {
|
|
65
|
+
case 'json':
|
|
66
|
+
outputJSON();
|
|
67
|
+
break;
|
|
68
|
+
case 'codeframe':
|
|
69
|
+
for (let i = 0; i < problems.length; i++) {
|
|
70
|
+
const problem = problems[i];
|
|
71
|
+
process.stderr.write(`${formatCodeframe(problem, i)}\n`);
|
|
72
|
+
}
|
|
73
|
+
break;
|
|
74
|
+
case 'stylish': {
|
|
75
|
+
const groupedByFile = groupByFiles(problems);
|
|
76
|
+
for (const [file, { ruleIdPad, locationPad: positionPad, fileProblems }] of Object.entries(groupedByFile)) {
|
|
77
|
+
process.stderr.write(`${colorette_1.blue(path.relative(cwd, file))}:\n`);
|
|
78
|
+
for (let i = 0; i < fileProblems.length; i++) {
|
|
79
|
+
const problem = fileProblems[i];
|
|
80
|
+
process.stderr.write(`${formatStylish(problem, positionPad, ruleIdPad)}\n`);
|
|
81
|
+
}
|
|
82
|
+
process.stderr.write('\n');
|
|
83
|
+
}
|
|
84
|
+
break;
|
|
85
|
+
}
|
|
86
|
+
case 'checkstyle': {
|
|
87
|
+
const groupedByFile = groupByFiles(problems);
|
|
88
|
+
process.stdout.write('<?xml version="1.0" encoding="UTF-8"?>\n');
|
|
89
|
+
process.stdout.write('<checkstyle version="4.3">\n');
|
|
90
|
+
for (const [file, { fileProblems }] of Object.entries(groupedByFile)) {
|
|
91
|
+
process.stdout.write(`<file name="${xmlEscape(path.relative(cwd, file))}">\n`);
|
|
92
|
+
fileProblems.forEach(formatCheckstyle);
|
|
93
|
+
process.stdout.write(`</file>\n`);
|
|
94
|
+
}
|
|
95
|
+
process.stdout.write(`</checkstyle>\n`);
|
|
96
|
+
break;
|
|
97
|
+
}
|
|
98
|
+
case 'codeclimate':
|
|
99
|
+
outputForCodeClimate();
|
|
100
|
+
break;
|
|
101
|
+
}
|
|
102
|
+
if (totalProblems - ignoredProblems > maxProblems) {
|
|
103
|
+
process.stderr.write(`< ... ${totalProblems - maxProblems} more problems hidden > ${colorette_1.gray('increase with `--max-problems N`')}\n`);
|
|
104
|
+
}
|
|
105
|
+
function outputForCodeClimate() {
|
|
106
|
+
const issues = problems.map((p) => {
|
|
107
|
+
const location = p.location[0]; // TODO: support multiple location
|
|
108
|
+
const lineCol = codeframes_1.getLineColLocation(location);
|
|
109
|
+
return {
|
|
110
|
+
description: p.message,
|
|
111
|
+
location: {
|
|
112
|
+
path: path.relative(cwd, location.source.absoluteRef),
|
|
113
|
+
lines: {
|
|
114
|
+
begin: lineCol.start.line,
|
|
115
|
+
},
|
|
116
|
+
},
|
|
117
|
+
severity: CODECLIMATE_SEVERITY_MAPPING[p.severity],
|
|
118
|
+
fingerprint: `${p.ruleId}${p.location.length > 0 ? '-' + p.location[0].pointer : ''}`,
|
|
119
|
+
};
|
|
120
|
+
});
|
|
121
|
+
process.stdout.write(JSON.stringify(issues, null, 2));
|
|
122
|
+
}
|
|
123
|
+
function outputJSON() {
|
|
124
|
+
const resultObject = {
|
|
125
|
+
totals,
|
|
126
|
+
version,
|
|
127
|
+
problems: problems.map((p) => {
|
|
128
|
+
var _a;
|
|
129
|
+
let problem = Object.assign(Object.assign({}, p), { location: p.location.map((location) => (Object.assign(Object.assign({}, location), { source: {
|
|
130
|
+
ref: path.relative(cwd, location.source.absoluteRef),
|
|
131
|
+
} }))), from: p.from
|
|
132
|
+
? Object.assign(Object.assign({}, p.from), { source: {
|
|
133
|
+
ref: path.relative(cwd, ((_a = p.from) === null || _a === void 0 ? void 0 : _a.source.absoluteRef) || cwd),
|
|
134
|
+
} }) : undefined });
|
|
135
|
+
if (config_1.env.FORMAT_JSON_WITH_CODEFRAMES) {
|
|
136
|
+
const location = p.location[0]; // TODO: support multiple locations
|
|
137
|
+
const loc = codeframes_1.getLineColLocation(location);
|
|
138
|
+
problem.codeframe = codeframes_1.getCodeframe(loc, color);
|
|
139
|
+
}
|
|
140
|
+
return problem;
|
|
141
|
+
}),
|
|
142
|
+
};
|
|
143
|
+
process.stdout.write(JSON.stringify(resultObject, null, 2));
|
|
144
|
+
}
|
|
145
|
+
function getBgColor(problem) {
|
|
146
|
+
const { severity } = problem;
|
|
147
|
+
if (!BG_COLORS[severity]) {
|
|
148
|
+
throw new Error(ERROR_MESSAGE.INVALID_SEVERITY_LEVEL);
|
|
149
|
+
}
|
|
150
|
+
return BG_COLORS[severity];
|
|
151
|
+
}
|
|
152
|
+
function formatCodeframe(problem, idx) {
|
|
153
|
+
const bgColor = getBgColor(problem);
|
|
154
|
+
const location = problem.location[0]; // TODO: support multiple locations
|
|
155
|
+
const relativePath = path.relative(cwd, location.source.absoluteRef);
|
|
156
|
+
const loc = codeframes_1.getLineColLocation(location);
|
|
157
|
+
const atPointer = location.pointer ? colorette_1.gray(`at ${location.pointer}`) : '';
|
|
158
|
+
const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;
|
|
159
|
+
return (`[${idx + 1}] ${bgColor(fileWithLoc)} ${atPointer}\n\n` +
|
|
160
|
+
`${problem.message}\n\n` +
|
|
161
|
+
formatDidYouMean(problem) +
|
|
162
|
+
codeframes_1.getCodeframe(loc, color) +
|
|
163
|
+
'\n\n' +
|
|
164
|
+
formatFrom(cwd, problem.from) +
|
|
165
|
+
`${SEVERITY_NAMES[problem.severity]} was generated by the ${colorette_1.blue(problem.ruleId)} rule.\n\n`);
|
|
166
|
+
}
|
|
167
|
+
function formatStylish(problem, locationPad, ruleIdPad) {
|
|
168
|
+
const color = COLORS[problem.severity];
|
|
169
|
+
if (!SEVERITY_NAMES[problem.severity]) {
|
|
170
|
+
return 'Error not found severity. Please check your config file. Allowed values: \`warn,error,off\`';
|
|
171
|
+
}
|
|
172
|
+
const severityName = color(SEVERITY_NAMES[problem.severity].toLowerCase().padEnd(7));
|
|
173
|
+
const { start } = problem.location[0];
|
|
174
|
+
return ` ${`${start.line}:${start.col}`.padEnd(locationPad)} ${severityName} ${problem.ruleId.padEnd(ruleIdPad)} ${problem.message}`;
|
|
175
|
+
}
|
|
176
|
+
function formatCheckstyle(problem) {
|
|
177
|
+
const { line, col } = problem.location[0].start;
|
|
178
|
+
const severity = problem.severity == 'warn' ? 'warning' : 'error';
|
|
179
|
+
const message = xmlEscape(problem.message);
|
|
180
|
+
const source = xmlEscape(problem.ruleId);
|
|
181
|
+
process.stdout.write(`<error line="${line}" column="${col}" severity="${severity}" message="${message}" source="${source}" />\n`);
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
exports.formatProblems = formatProblems;
|
|
185
|
+
function formatFrom(cwd, location) {
|
|
186
|
+
if (!location)
|
|
187
|
+
return '';
|
|
188
|
+
const relativePath = path.relative(cwd, location.source.absoluteRef);
|
|
189
|
+
const loc = codeframes_1.getLineColLocation(location);
|
|
190
|
+
const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;
|
|
191
|
+
return `referenced from ${colorette_1.blue(fileWithLoc)}\n\n`;
|
|
192
|
+
}
|
|
193
|
+
function formatDidYouMean(problem) {
|
|
194
|
+
if (problem.suggest.length === 0)
|
|
195
|
+
return '';
|
|
196
|
+
if (problem.suggest.length === 1) {
|
|
197
|
+
return `Did you mean: ${problem.suggest[0]} ?\n\n`;
|
|
198
|
+
}
|
|
199
|
+
else {
|
|
200
|
+
return `Did you mean:\n - ${problem.suggest.slice(0, MAX_SUGGEST).join('\n - ')}\n\n`;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
const groupByFiles = (problems) => {
|
|
204
|
+
const fileGroups = {};
|
|
205
|
+
for (const problem of problems) {
|
|
206
|
+
const absoluteRef = problem.location[0].source.absoluteRef; // TODO: multiple errors
|
|
207
|
+
fileGroups[absoluteRef] = fileGroups[absoluteRef] || {
|
|
208
|
+
fileProblems: [],
|
|
209
|
+
ruleIdPad: 0,
|
|
210
|
+
locationPad: 0,
|
|
211
|
+
};
|
|
212
|
+
const mappedProblem = Object.assign(Object.assign({}, problem), { location: problem.location.map(codeframes_1.getLineColLocation) });
|
|
213
|
+
fileGroups[absoluteRef].fileProblems.push(mappedProblem);
|
|
214
|
+
fileGroups[absoluteRef].ruleIdPad = Math.max(problem.ruleId.length, fileGroups[absoluteRef].ruleIdPad);
|
|
215
|
+
fileGroups[absoluteRef].locationPad = Math.max(Math.max(...mappedProblem.location.map((loc) => `${loc.start.line}:${loc.start.col}`.length)), fileGroups[absoluteRef].locationPad);
|
|
216
|
+
}
|
|
217
|
+
return fileGroups;
|
|
218
|
+
};
|
|
219
|
+
function xmlEscape(s) {
|
|
220
|
+
return s.replace(/[<>&"'\x00-\x1F\x7F\u0080-\uFFFF]/gu, (char) => {
|
|
221
|
+
switch (char) {
|
|
222
|
+
case '<':
|
|
223
|
+
return '<';
|
|
224
|
+
case '>':
|
|
225
|
+
return '>';
|
|
226
|
+
case '&':
|
|
227
|
+
return '&';
|
|
228
|
+
case '"':
|
|
229
|
+
return '"';
|
|
230
|
+
case "'":
|
|
231
|
+
return ''';
|
|
232
|
+
default:
|
|
233
|
+
return `&#${char.charCodeAt(0)};`;
|
|
234
|
+
}
|
|
235
|
+
});
|
|
236
|
+
}
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export { BundleOutputFormat, readFileFromUrl, slash } from './utils';
|
|
2
|
+
export { Oas3_1Types } from './types/oas3_1';
|
|
3
|
+
export { Oas3Types } from './types/oas3';
|
|
4
|
+
export { Oas2Types } from './types/oas2';
|
|
5
|
+
export { ConfigTypes } from './types/redocly-yaml';
|
|
6
|
+
export { Oas3Definition, Oas3_1Definition, Oas3Components, Oas3PathItem, Oas3Paths, Oas3ComponentName, Oas3Schema, Oas3_1Schema, Oas3Tag, Oas3_1Webhooks, Referenced, } from './typings/openapi';
|
|
7
|
+
export { Oas2Definition } from './typings/swagger';
|
|
8
|
+
export { StatsAccumulator, StatsName } from './typings/common';
|
|
9
|
+
export { normalizeTypes } from './types';
|
|
10
|
+
export { Stats } from './rules/other/stats';
|
|
11
|
+
export { Config, LintConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, } from './config';
|
|
12
|
+
export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
|
|
13
|
+
export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
|
|
14
|
+
export { parseYaml, stringifyYaml } from './js-yaml';
|
|
15
|
+
export { unescapePointer, isRef } from './ref-utils';
|
|
16
|
+
export { detectOpenAPI, OasMajorVersion, openAPIMajor, OasVersion } from './oas-types';
|
|
17
|
+
export { normalizeVisitors } from './visitors';
|
|
18
|
+
export { WalkContext, walkDocument, NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject, Loc, } from './walk';
|
|
19
|
+
export { getAstNodeByPointer, getLineColLocation } from './format/codeframes';
|
|
20
|
+
export { formatProblems, OutputFormat, getTotals, Totals } from './format/format';
|
|
21
|
+
export { lint, lint as validate, lintDocument, lintFromString, lintConfig } from './lint';
|
|
22
|
+
export { bundle, bundleDocument, mapTypeToComponent } from './bundle';
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.LintConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.slash = exports.readFileFromUrl = void 0;
|
|
4
|
+
var utils_1 = require("./utils");
|
|
5
|
+
Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
|
|
6
|
+
Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
|
|
7
|
+
var oas3_1_1 = require("./types/oas3_1");
|
|
8
|
+
Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
|
|
9
|
+
var oas3_1 = require("./types/oas3");
|
|
10
|
+
Object.defineProperty(exports, "Oas3Types", { enumerable: true, get: function () { return oas3_1.Oas3Types; } });
|
|
11
|
+
var oas2_1 = require("./types/oas2");
|
|
12
|
+
Object.defineProperty(exports, "Oas2Types", { enumerable: true, get: function () { return oas2_1.Oas2Types; } });
|
|
13
|
+
var redocly_yaml_1 = require("./types/redocly-yaml");
|
|
14
|
+
Object.defineProperty(exports, "ConfigTypes", { enumerable: true, get: function () { return redocly_yaml_1.ConfigTypes; } });
|
|
15
|
+
var types_1 = require("./types");
|
|
16
|
+
Object.defineProperty(exports, "normalizeTypes", { enumerable: true, get: function () { return types_1.normalizeTypes; } });
|
|
17
|
+
var stats_1 = require("./rules/other/stats");
|
|
18
|
+
Object.defineProperty(exports, "Stats", { enumerable: true, get: function () { return stats_1.Stats; } });
|
|
19
|
+
var config_1 = require("./config");
|
|
20
|
+
Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
|
|
21
|
+
Object.defineProperty(exports, "LintConfig", { enumerable: true, get: function () { return config_1.LintConfig; } });
|
|
22
|
+
Object.defineProperty(exports, "IGNORE_FILE", { enumerable: true, get: function () { return config_1.IGNORE_FILE; } });
|
|
23
|
+
Object.defineProperty(exports, "getMergedConfig", { enumerable: true, get: function () { return config_1.getMergedConfig; } });
|
|
24
|
+
Object.defineProperty(exports, "transformConfig", { enumerable: true, get: function () { return config_1.transformConfig; } });
|
|
25
|
+
Object.defineProperty(exports, "loadConfig", { enumerable: true, get: function () { return config_1.loadConfig; } });
|
|
26
|
+
Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return config_1.getConfig; } });
|
|
27
|
+
Object.defineProperty(exports, "findConfig", { enumerable: true, get: function () { return config_1.findConfig; } });
|
|
28
|
+
Object.defineProperty(exports, "CONFIG_FILE_NAMES", { enumerable: true, get: function () { return config_1.CONFIG_FILE_NAMES; } });
|
|
29
|
+
var redocly_1 = require("./redocly");
|
|
30
|
+
Object.defineProperty(exports, "RedoclyClient", { enumerable: true, get: function () { return redocly_1.RedoclyClient; } });
|
|
31
|
+
Object.defineProperty(exports, "isRedoclyRegistryURL", { enumerable: true, get: function () { return redocly_1.isRedoclyRegistryURL; } });
|
|
32
|
+
var resolve_1 = require("./resolve");
|
|
33
|
+
Object.defineProperty(exports, "Source", { enumerable: true, get: function () { return resolve_1.Source; } });
|
|
34
|
+
Object.defineProperty(exports, "BaseResolver", { enumerable: true, get: function () { return resolve_1.BaseResolver; } });
|
|
35
|
+
Object.defineProperty(exports, "resolveDocument", { enumerable: true, get: function () { return resolve_1.resolveDocument; } });
|
|
36
|
+
Object.defineProperty(exports, "ResolveError", { enumerable: true, get: function () { return resolve_1.ResolveError; } });
|
|
37
|
+
Object.defineProperty(exports, "YamlParseError", { enumerable: true, get: function () { return resolve_1.YamlParseError; } });
|
|
38
|
+
Object.defineProperty(exports, "makeDocumentFromString", { enumerable: true, get: function () { return resolve_1.makeDocumentFromString; } });
|
|
39
|
+
var js_yaml_1 = require("./js-yaml");
|
|
40
|
+
Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_1.parseYaml; } });
|
|
41
|
+
Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_1.stringifyYaml; } });
|
|
42
|
+
var ref_utils_1 = require("./ref-utils");
|
|
43
|
+
Object.defineProperty(exports, "unescapePointer", { enumerable: true, get: function () { return ref_utils_1.unescapePointer; } });
|
|
44
|
+
Object.defineProperty(exports, "isRef", { enumerable: true, get: function () { return ref_utils_1.isRef; } });
|
|
45
|
+
var oas_types_1 = require("./oas-types");
|
|
46
|
+
Object.defineProperty(exports, "detectOpenAPI", { enumerable: true, get: function () { return oas_types_1.detectOpenAPI; } });
|
|
47
|
+
Object.defineProperty(exports, "OasMajorVersion", { enumerable: true, get: function () { return oas_types_1.OasMajorVersion; } });
|
|
48
|
+
Object.defineProperty(exports, "openAPIMajor", { enumerable: true, get: function () { return oas_types_1.openAPIMajor; } });
|
|
49
|
+
Object.defineProperty(exports, "OasVersion", { enumerable: true, get: function () { return oas_types_1.OasVersion; } });
|
|
50
|
+
var visitors_1 = require("./visitors");
|
|
51
|
+
Object.defineProperty(exports, "normalizeVisitors", { enumerable: true, get: function () { return visitors_1.normalizeVisitors; } });
|
|
52
|
+
var walk_1 = require("./walk");
|
|
53
|
+
Object.defineProperty(exports, "walkDocument", { enumerable: true, get: function () { return walk_1.walkDocument; } });
|
|
54
|
+
var codeframes_1 = require("./format/codeframes");
|
|
55
|
+
Object.defineProperty(exports, "getAstNodeByPointer", { enumerable: true, get: function () { return codeframes_1.getAstNodeByPointer; } });
|
|
56
|
+
Object.defineProperty(exports, "getLineColLocation", { enumerable: true, get: function () { return codeframes_1.getLineColLocation; } });
|
|
57
|
+
var format_1 = require("./format/format");
|
|
58
|
+
Object.defineProperty(exports, "formatProblems", { enumerable: true, get: function () { return format_1.formatProblems; } });
|
|
59
|
+
Object.defineProperty(exports, "getTotals", { enumerable: true, get: function () { return format_1.getTotals; } });
|
|
60
|
+
var lint_1 = require("./lint");
|
|
61
|
+
Object.defineProperty(exports, "lint", { enumerable: true, get: function () { return lint_1.lint; } });
|
|
62
|
+
Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return lint_1.lint; } });
|
|
63
|
+
Object.defineProperty(exports, "lintDocument", { enumerable: true, get: function () { return lint_1.lintDocument; } });
|
|
64
|
+
Object.defineProperty(exports, "lintFromString", { enumerable: true, get: function () { return lint_1.lintFromString; } });
|
|
65
|
+
Object.defineProperty(exports, "lintConfig", { enumerable: true, get: function () { return lint_1.lintConfig; } });
|
|
66
|
+
var bundle_1 = require("./bundle");
|
|
67
|
+
Object.defineProperty(exports, "bundle", { enumerable: true, get: function () { return bundle_1.bundle; } });
|
|
68
|
+
Object.defineProperty(exports, "bundleDocument", { enumerable: true, get: function () { return bundle_1.bundleDocument; } });
|
|
69
|
+
Object.defineProperty(exports, "mapTypeToComponent", { enumerable: true, get: function () { return bundle_1.mapTypeToComponent; } });
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.stringifyYaml = exports.parseYaml = void 0;
|
|
4
|
+
// TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
|
|
5
|
+
// @ts-ignore
|
|
6
|
+
const js_yaml_1 = require("js-yaml");
|
|
7
|
+
const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = js_yaml_1.JSON_SCHEMA.extend({
|
|
8
|
+
implicit: [js_yaml_1.types.merge],
|
|
9
|
+
explicit: [
|
|
10
|
+
js_yaml_1.types.binary,
|
|
11
|
+
js_yaml_1.types.omap,
|
|
12
|
+
js_yaml_1.types.pairs,
|
|
13
|
+
js_yaml_1.types.set,
|
|
14
|
+
],
|
|
15
|
+
});
|
|
16
|
+
const parseYaml = (str, opts) => js_yaml_1.load(str, Object.assign({ schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP }, opts));
|
|
17
|
+
exports.parseYaml = parseYaml;
|
|
18
|
+
const stringifyYaml = (obj, opts) => js_yaml_1.dump(obj, opts);
|
|
19
|
+
exports.stringifyYaml = stringifyYaml;
|
package/lib/lint.d.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { BaseResolver, Document } from './resolve';
|
|
2
|
+
import { NodeType } from './types';
|
|
3
|
+
import { LintConfig, Config } from './config';
|
|
4
|
+
export declare function lint(opts: {
|
|
5
|
+
ref: string;
|
|
6
|
+
config: Config;
|
|
7
|
+
externalRefResolver?: BaseResolver;
|
|
8
|
+
}): Promise<import("./walk").NormalizedProblem[]>;
|
|
9
|
+
export declare function lintFromString(opts: {
|
|
10
|
+
source: string;
|
|
11
|
+
absoluteRef?: string;
|
|
12
|
+
config: Config;
|
|
13
|
+
externalRefResolver?: BaseResolver;
|
|
14
|
+
}): Promise<import("./walk").NormalizedProblem[]>;
|
|
15
|
+
export declare function lintDocument(opts: {
|
|
16
|
+
document: Document;
|
|
17
|
+
config: LintConfig;
|
|
18
|
+
customTypes?: Record<string, NodeType>;
|
|
19
|
+
externalRefResolver: BaseResolver;
|
|
20
|
+
}): Promise<import("./walk").NormalizedProblem[]>;
|
|
21
|
+
export declare function lintConfig(opts: {
|
|
22
|
+
document: Document;
|
|
23
|
+
}): Promise<import("./walk").NormalizedProblem[]>;
|