@redocly/openapi-cli

v1.0.0-beta.95

OpenAPI CLI toolbox with rich validation and bundling features. For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

56 / 100

security
Security review needed
popularity
Recognized
maintenance
Inactive
community
Active

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.0.0-beta.95	\|	05/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.12.16	\|	06/2020		0 C 0 H 0 M 1 L	0 H 0 M 0 L
0.11.0	\|	03/2020		0 C 0 H 0 M 1 L	0 H 0 M 0 L
0.10.0	\|	03/2020		0 C 0 H 0 M 1 L	0 H 0 M 0 L
0.9.1	\|	03/2020		0 C 0 H 0 M 1 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (32,117)

GitHub Stars: 966
Forks: 149
Contributors: 110

Direct Usage Popularity

The npm package @redocly/openapi-cli receives a total of 32,117 downloads a week. As such, we scored @redocly/openapi-cli popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @redocly/openapi-cli, we found that it has been starred 966 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 110
Funding: No

A good and healthy external contribution signal for @redocly/openapi-cli project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like @redocly/openapi-cli is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

deprecated

Commit Frequency

Open Issues: 169
Open PR: 13
Last Release: 3 years ago
Last Commit: 14 days ago

Further analysis of the maintenance status of @redocly/openapi-cli based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @redocly/openapi-cli is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12.0.0

Age: 5 years
Dependencies: 11 Direct
Versions: 164
Install Size: 279 kB
Dist-tags: 2
# of Files: 79
Maintainers: 9
TS Typings: No

@redocly/openapi-cli has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

OpenAPI CLI toolset

OpenAPI CLI toolbox with rich validation and bundling features.

Travis (.org) npm (scoped) NPM

OpenAPI 3 CLI toolset

Features

Currently, @redocly/openapi-cli supports these features:

[x] Multifile validation. No need to bundle your file before validation.
[x] Lightning-fast validation. Lint a 1 Mb file in less than one second.
[x] Built-in rules for common validations.
[x] Configurable severity levels for each rule.
[x] Human-readable error messages with codeframes and stylish format options.
[x] Intuitive suggestions for misspelled types or references.
[x] Easy to implement custom rules.
[x] Bundle a multifile definition into a single file.
[x] Decorators to modify a validated definition during bundling.
[x] Preview reference docs for local development.
[x] Support for OpenAPI 2 (fka Swagger) and OpenAPI 3.0.
[ ] Support for OpenAPI 3.1 (coming soon).

What makes this tool different

Unlike other OpenAPI linters, @redocly/openapi-cli defines the possible type tree of a valid OpenAPI definition and then traverses it. This approach is very similar to how linters for programming languages work and results in major performance benefits over other approaches. Extend functionality at different points in the lifecycle with preprocessors, rules, and decorators.

TLDR

npx @redocly/openapi-cli lint path-to-root-file.yaml

Read the docs

Credits

Thanks to graphql-js and eslint for inspiration of the definition traversal approach and to Swagger, Spectral, and OAS-Kit for inspiring the ruleset.

@redocly/openapi-cli dependencies

@redocly/openapi-core @types/node assert-node-version chokidar colorette glob glob-promise handlebars portfinder simple-websocket yargs

@redocly/openapi-cli development dependencies

@types/yargs typescript

FAQs

What is @redocly/openapi-cli?

OpenAPI CLI toolbox with rich validation and bundling features. Visit Snyk Advisor to see a full health score report for @redocly/openapi-cli, including popularity, security, maintenance & community analysis.

Is @redocly/openapi-cli popular?

The npm package @redocly/openapi-cli receives a total of 32,117 weekly downloads. As such, @redocly/openapi-cli popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @redocly/openapi-cli well maintained?

We found indications that @redocly/openapi-cli is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @redocly/openapi-cli safe to use?

While scanning the latest version of @redocly/openapi-cli, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 12 December-2024, at 02:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP